XsltFilter

Extends \BaseParamFilterReader Implements \ChainableReader

Applies XSL stylesheet to incoming text.

Uses PHP XSLT support (libxslt).

author

Hans Lellelid hans@velum.net

author

Yannick Lecaillez yl@seasonfive.com

author

Andreas Aderhold andi@binarycloud.com

version

$Id: 18d625cd2fc1deaf10f714c5e797571bb6986d29 $

see
package

phing.filters

Methods

Create new XSLT Param object, to handle the <param/> nested element.

createParam() : \XSLTParam

Response

\XSLTParam

Sets the XSLT params for this class.

setParams(array $params) 

This is used to "clone" this class, in the chain() method.

Arguments

$params

array

Returns the XSLT params set for this class.

getParams() : array

This is used to "clone" this class, in the chain() method.

Response

array

Set the XSLT stylesheet.

setStyle(mixed $file) 

Arguments

$file

mixed

PhingFile object or path.

Whether to use HTML parser for the XML.

getHtml() : boolean

This is supported in libxml2 -- Yay!

Response

boolean

Whether to use HTML parser for XML.

setHtml(boolean $b) 

Arguments

$b

boolean

Get the path to XSLT stylesheet.

getStyle() : mixed

Response

mixed

XSLT stylesheet path.

Whether to resolve entities in document.

setResolveDocumentExternals(bool $resolveExternals) 
since 2.4

Arguments

$resolveExternals

bool

getResolveDocumentExternals

getResolveDocumentExternals() : bool
since 2.4

Response

bool

Whether to resolve entities in stylesheet.

setResolveStylesheetExternals(bool $resolveExternals) 
since 2.4

Arguments

$resolveExternals

bool

getResolveStylesheetExternals

getResolveStylesheetExternals() : bool
since 2.4

Response

bool

Read data from source.

read(int $len = null) 
inherited abstract

If length is specified, then only that number of chars is read, otherwise stream is read until EOF.

Arguments

$len

int

Try to process the XSLT transformation

process($xml, $xsl) 
throws

On XSLT errors

Arguments

$xml

$xsl

Creates a new XsltFilter using the passed in Reader for instantiation.

chain(\Reader $reader) : \Reader

Arguments

$reader

\Reader

Response

\Reader

A new filter based on this configuration, but filtering the specified reader

Parses the parameters to get stylesheet path.

_initialize() 

setParameters

setParameters($parameters) 
inherited

Arguments

$parameters

getParameters

getParameters() 
inherited

__construct

__construct(\Reader $in = null) 
inherited

Arguments

$in

\Reader

Returns the initialized status.

getInitialized() : boolean
inherited

Response

boolean

whether or not the filter is initialized

Sets the initialized status.

setInitialized(boolean $initialized) 
inherited

Arguments

$initialized

boolean

Whether or not the filter is initialized.

Sets the project to work with.

setProject(object $project) 
inherited

Arguments

$project

object

The project this filter is part of. Should not be null.

Returns the project this filter is part of.

getProject() : object
inherited

Response

object

The project this filter is part of

Reads a line of text ending with '\n' (or until the end of the stream).

readLine() : \the
inherited

The returned String retains the '\n'.

throws

if the underlying reader throws one during reading

Response

\the

line read, or null if the end of the stream has already been reached

Returns whether the end of file has been reached with input stream.

eof() : boolean
inherited

Response

boolean

Convenience method to support logging in filters.

log(string $msg, int $level = \Project::MSG_INFO) 
inherited

Arguments

$msg

string

Message to log.

$level

int

Priority level.

setReader

setReader(\Reader $in) 
inherited

Arguments

$in

\Reader

Move stream position relative to current pos.

skip(int $n) 
inherited

Arguments

$n

int

Reset the current position in stream to beginning or last mark (if supported).

reset() 
inherited

Close stream.

close() 
inherited abstract
throws

if there is an error closing stream

Returns the filename, url, etc. that is being read from.

getResource() : string
inherited abstract

This is critical for, e.g., ExpatParser's ability to know the filename that is throwing an ExpatParserException, etc.

Response

string

If supported, places a "marker" (like a bookmark) at current stream position.

mark() 
inherited

A subsequent call to reset() will move stream position back to last marker (if supported).

Whether marking is supported.

markSupported() : boolean
inherited

Response

boolean

Is stream ready for reading.

ready() : boolean
inherited

Response

boolean

Properties

Path to XSL stylesheet.

xslFile : string
var

Type(s)

string

Whether XML file has been transformed.

processed : boolean
var

Type(s)

boolean

XSLT Params.

xsltParams : array
var

Type(s)

array

Whether to use loadHTML() to parse the input XML file.

html : 

Whether to resolve entities in the XML document (see {@link http://www.php.net/manual/en/class.domdocument.php#domdocument.props.resolveexternals} for more details).

resolveDocumentExternals : bool
var
since

Type(s)

bool

Whether to resolve entities in the stylesheet.

resolveStylesheetExternals : bool
var
since

Type(s)

bool

The passed in parameter array.

_parameters : 
inherited

Have the parameters passed been interpreted?

initialized : 
inherited

The Phing project this filter is part of.

project : 
inherited

in

in : \Reader
inherited
var

Type(s)

\Reader