Applies XSL stylesheet to incoming text.
Uses PHP XSLT support (libxslt).
| author | Hans Lellelid |
|---|---|
| author | Yannick Lecaillez |
| author | Andreas Aderhold |
| version | $Id: 18d625cd2fc1deaf10f714c5e797571bb6986d29 $ |
| see | \global\FilterReader |
| package | phing.filters |
| copyright | 2003 seasonfive. All rights reserved |
__construct(\Reader $in)
The original filter reader is only used for chaining purposes, never for filtering purposes (and indeed it would be useless for filtering purposes, as it has no real data to filter). ChainedReaderHelper uses this placeholder instance to create a chain of real filters.
| inherited_from | \BaseFilterReader::__construct() |
|---|---|
| inherited_from | \BaseParamFilterReader::__construct() |
\Reader
chain(\Reader $reader) : \Reader
close()
| inherited_from | \FilterReader::close() |
|---|---|
| inherited_from | \BaseFilterReader::close() |
| inherited_from | \BaseParamFilterReader::close() |
\IOException |
if there is an error closing stream |
|---|
createParam() : \XSLTParam
eof() : boolean
| inherited_from | \BaseFilterReader::eof() |
|---|---|
| inherited_from | \BaseParamFilterReader::eof() |
booleangetHtml() : boolean
This is supported in libxml2 -- Yay!
booleangetInitialized() : boolean
| inherited_from | \BaseFilterReader::getInitialized() |
|---|---|
| inherited_from | \BaseParamFilterReader::getInitialized() |
booleanwhether or not the filter is initializedgetParameters()
| inherited_from | \BaseParamFilterReader::getParameters() |
|---|
getParams() : array
This is used to "clone" this class, in the chain() method.
arraygetProject() : object
| inherited_from | \BaseFilterReader::getProject() |
|---|---|
| inherited_from | \BaseParamFilterReader::getProject() |
objectThe project this filter is part ofgetResolveDocumentExternals() : bool
| since | 2.4 |
|---|
boolgetResolveStylesheetExternals() : bool
| since | 2.4 |
|---|
boolgetResource() : string
that is being read from. This is critical for, e.g., ExpatParser's ability to know the filename that is throwing an ExpatParserException, etc.
| inherited_from | \FilterReader::getResource() |
|---|---|
| inherited_from | \BaseFilterReader::getResource() |
| inherited_from | \BaseParamFilterReader::getResource() |
stringgetStyle() : mixed
mixedXSLT stylesheet path.log(string $msg, int $level)
| inherited_from | \BaseFilterReader::log() |
|---|---|
| inherited_from | \BaseParamFilterReader::log() |
stringMessage to log.
intPriority level.
mark()
A subsequent call to reset() will move stream position back to last marker (if supported).
| inherited_from | \Reader::mark() |
|---|---|
| inherited_from | \FilterReader::mark() |
| inherited_from | \BaseFilterReader::mark() |
| inherited_from | \BaseParamFilterReader::mark() |
markSupported() : boolean
| inherited_from | \Reader::markSupported() |
|---|---|
| inherited_from | \FilterReader::markSupported() |
| inherited_from | \BaseFilterReader::markSupported() |
| inherited_from | \BaseParamFilterReader::markSupported() |
booleanread(\off $len) : string
FIXME: Clean up this function signature, as it a) params aren't being used and b) it doesn't make much sense.
\offOffset at which to start storing characters.
\BuildException |
- if XSLT support missing, if error in xslt processing |
|---|
stringtransformed buffer.readLine() : \the
The returned String retains the '\n'.
| inherited_from | \BaseFilterReader::readLine() |
|---|---|
| inherited_from | \BaseParamFilterReader::readLine() |
\IOException |
if the underlying reader throws one during reading |
|---|
\theline read, or null if the end of the
stream has already been reachedready() : boolean
| inherited_from | \Reader::ready() |
|---|---|
| inherited_from | \FilterReader::ready() |
| inherited_from | \BaseFilterReader::ready() |
| inherited_from | \BaseParamFilterReader::ready() |
booleanreset()
| inherited_from | \FilterReader::reset() |
|---|---|
| inherited_from | \BaseFilterReader::reset() |
| inherited_from | \BaseParamFilterReader::reset() |
setHtml(boolean $b)
boolean
setInitialized(boolean $initialized)
| inherited_from | \BaseFilterReader::setInitialized() |
|---|---|
| inherited_from | \BaseParamFilterReader::setInitialized() |
booleanWhether or not the filter is initialized.
setParameters($parameters)
| inherited_from | \BaseParamFilterReader::setParameters() |
|---|
setParams(array $params)
This is used to "clone" this class, in the chain() method.
array
setProject(\Project $project)
| inherited_from | \BaseFilterReader::setProject() |
|---|---|
| inherited_from | \BaseParamFilterReader::setProject() |
objectThe project this filter is part of.
Should not be null.
setReader(\Reader $in)
| inherited_from | \FilterReader::setReader() |
|---|---|
| inherited_from | \BaseFilterReader::setReader() |
| inherited_from | \BaseParamFilterReader::setReader() |
setResolveDocumentExternals(bool $resolveExternals)
| since | 2.4 |
|---|
bool
setResolveStylesheetExternals(bool $resolveExternals)
| since | 2.4 |
|---|
bool
setStyle(\PhingFile $file)
mixedPhingFile object or path.
skip(int $n)
| inherited_from | \FilterReader::skip() |
|---|---|
| inherited_from | \BaseFilterReader::skip() |
| inherited_from | \BaseParamFilterReader::skip() |
int
process(string $xml, string $xsl)
stringXML to process.
stringXSLT sheet to use for the processing.
\BuildException |
On XSLT errors |
|---|
_initialize()
$_parameters
| inherited_from | \BaseParamFilterReader::$$_parameters |
|---|
$in : \Reader
| inherited_from | \FilterReader::$$in |
|---|---|
| inherited_from | \BaseFilterReader::$$in |
| inherited_from | \BaseParamFilterReader::$$in |
$initialized
| inherited_from | \BaseFilterReader::$$initialized |
|---|---|
| inherited_from | \BaseParamFilterReader::$$initialized |
$project
| inherited_from | \BaseFilterReader::$$project |
|---|---|
| inherited_from | \BaseParamFilterReader::$$project |
$html
$processed : boolean
$resolveDocumentExternals : bool
| since | 2.4 |
|---|
$resolveStylesheetExternals : bool
| since | 2.4 |
|---|
$xslFile : string
$xsltParams : array