filters/XsltFilter.php

Show: inherited
Table of Contents

Applies XSL stylesheet to incoming text.

Uses PHP XSLT support (libxslt).

Author
Hans Lellelid  
Author
Yannick Lecaillez  
Author
Andreas Aderhold  
Package
phing.filters  
See
\FilterReader  
Version
$Id: 057af49d450e4c137127acc0f5331368e7a76183 $  

\XSLTParam

Package: phing\filters

Class that holds an XSLT parameter.

Properties

Propertyprivate  $expr= ''
Details
Type
n/a
Propertyprivate  $name= ''
Details
Type
n/a

Methods

methodpublicgetExpression( ) : string

Returns expression value -- performs lookup if expr is registerslot.

Returns
Type Description
string
methodpublicgetName( ) : string

Get param name.

Returns
Type Description
string
methodpublicgetValue( ) : void

Gets expression value (alias to the getExpression()) method.

Details
See
\getExpression()  
methodpublicsetExpression( string $expr ) : void

Sets expression value.

Parameters
Name Type Description
$expr string
methodpublicsetListeningExpression( \RegisterSlot $expr ) : void

Sets expression to dynamic register slot.

Parameters
Name Type Description
$expr \RegisterSlot
methodpublicsetName( string $name ) : void

Sets param name.

Parameters
Name Type Description
$name string
methodpublicsetValue( string $v ) : void

Sets expression value (alias to the setExpression()) method.

Parameters
Name Type Description
$v string
Details
See
\setExpression()  

\XsltFilter

Package: phing\filters

Applies XSL stylesheet to incoming text.

Uses PHP XSLT support (libxslt).

Parent(s)
\BaseParamFilterReader < \BaseFilterReader < \FilterReader < \Reader
See
\FilterReader  
Author
Hans Lellelid  
Author
Yannick Lecaillez  
Author
Andreas Aderhold  
Copyright
� 2003 seasonfive. All rights reserved  
Version
$Id: 057af49d450e4c137127acc0f5331368e7a76183 $  

Properties

Propertyprotected  $_parameters= 'array()'
inherited

The passed in parameter array.

Inherited from: \BaseParamFilterReader::$$_parameters
Default valuearray()Details
Type
n/a
Inherited_from
\BaseParamFilterReader::$$_parameters  
Propertyprivate  $html= 'false'

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

Default valuefalseDetails
Type
n/a
Propertyprotected\Reader  $in= ''
Details
Type
\Reader
Inherited_from
\FilterReader::$$in  
Inherited_from
\BaseFilterReader::$$in  
Inherited_from
\BaseParamFilterReader::$$in  
Propertyprotected  $initialized= 'false'
inherited

Have the parameters passed been interpreted?

Inherited from: \BaseFilterReader::$$initialized\BaseParamFilterReader::$$initialized
Default valuefalseDetails
Type
n/a
Inherited_from
\BaseFilterReader::$$initialized  
Inherited_from
\BaseParamFilterReader::$$initialized  
Propertyprivateboolean  $processed= 'false'

Whether XML file has been transformed.

Default valuefalseDetails
Type
boolean
Propertyprotected  $project= 'null'
inherited

The Phing project this filter is part of.

Inherited from: \BaseFilterReader::$$project\BaseParamFilterReader::$$project
Default valuenullDetails
Type
n/a
Inherited_from
\BaseFilterReader::$$project  
Inherited_from
\BaseParamFilterReader::$$project  
Propertyprivatebool  $resolveDocumentExternals= 'false'

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).

Default valuefalseDetails
Type
bool
Since
2.4  
Propertyprivatebool  $resolveStylesheetExternals= 'false'

Whether to resolve entities in the stylesheet.

Default valuefalseDetails
Type
bool
Since
2.4  
Propertyprivatestring  $xslFile= 'null'

Path to XSL stylesheet.

Default valuenullDetails
Type
string
Propertyprivatearray  $xsltParams= 'array()'

XSLT Params.

Default valuearray()Details
Type
array

Methods

methodpublic__construct( \Reader $in = null ) : void
inherited

Constructor used by Phing's introspection mechanism.

Inherited from: \BaseFilterReader::__construct()\BaseParamFilterReader::__construct()

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.

Parameters
Name Type Description
$in \Reader
methodprivate_initialize( ) : void

Parses the parameters to get stylesheet path.

methodpublicchain( \Reader $reader ) : \Reader

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

Parameters
Name Type Description
$reader \Reader

A Reader object providing the underlying stream. Must not be null.

Returns
Type Description
\Reader A new filter based on this configuration, but filtering the specified reader
methodpublicclose( ) : void
Throws
Exception Description
\IOException if there is an error closing stream
methodpubliccreateParam( ) : \XSLTParam

Create new XSLT Param object, to handle the nested element.

Returns
Type Description
\XSLTParam
methodpubliceof( ) : boolean
inherited

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

Inherited from: \BaseFilterReader::eof()\BaseParamFilterReader::eof()
Returns
Type Description
boolean
methodpublicgetHtml( ) : boolean

Whether to use HTML parser for the XML.

This is supported in libxml2 -- Yay!

Returns
Type Description
boolean
methodpublicgetInitialized( ) : boolean
inherited

Returns the initialized status.

Inherited from: \BaseFilterReader::getInitialized()\BaseParamFilterReader::getInitialized()
Returns
Type Description
boolean whether or not the filter is initialized
methodpublicgetParameters( ) : void
inherited

Inherited from: \BaseParamFilterReader::getParameters()
methodpublicgetParams( ) : array

Returns the XSLT params set for this class.

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

Returns
Type Description
array
methodpublicgetProject( ) : object
inherited

Returns the project this filter is part of.

Inherited from: \BaseFilterReader::getProject()\BaseParamFilterReader::getProject()
Returns
Type Description
object The project this filter is part of
methodpublicgetResolveDocumentExternals( ) : bool

Returns
Type Description
bool
Details
Since
2.4  
methodpublicgetResolveStylesheetExternals( ) : bool

Returns
Type Description
bool
Details
Since
2.4  
methodpublicgetResource( ) : string
inherited

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

Inherited from: \FilterReader::getResource()\BaseFilterReader::getResource()\BaseParamFilterReader::getResource()

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

Returns
Type Description
string
methodpublicgetStyle( ) : mixed

Get the path to XSLT stylesheet.

Returns
Type Description
mixed XSLT stylesheet path.
methodpubliclog( string $msg, int $level = Project::MSG_INFO ) : void
inherited

Convenience method to support logging in filters.

Inherited from: \BaseFilterReader::log()\BaseParamFilterReader::log()
Parameters
Name Type Description
$msg string

Message to log.

$level int

Priority level.

methodpublicmark( ) : void
inherited

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

Inherited from: \Reader::mark()\FilterReader::mark()\BaseFilterReader::mark()\BaseParamFilterReader::mark()

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

methodpublicmarkSupported( ) : boolean
Returns
Type Description
boolean
methodprotectedprocess( string $xml, string $xsl ) : void

Try to process the XSLT transformation

Parameters
Name Type Description
$xml string

XML to process.

$xsl string

XSLT sheet to use for the processing.

Throws
Exception Description
\BuildException On XSLT errors
methodpublicread( \off $len = null ) : string

Reads stream, applies XSLT and returns resulting stream.

FIXME: Clean up this function signature, as it a) params aren't being used and b) it doesn't make much sense.

Parameters
Name Type Description
$len \off

Offset at which to start storing characters.

Returns
Type Description
string transformed buffer.
Throws
Exception Description
\BuildException - if XSLT support missing, if error in xslt processing
methodpublicreadLine( ) : \the
inherited

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

Inherited from: \BaseFilterReader::readLine()\BaseParamFilterReader::readLine()

The returned String retains the '\n'.

Returns
Type Description
\the line read, or <code>null</code> if the end of the stream has already been reached
Throws
Exception Description
\IOException if the underlying reader throws one during reading
methodpublicready( ) : boolean
Returns
Type Description
boolean
methodpublicreset( ) : void
inherited

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

Inherited from: \FilterReader::reset()\BaseFilterReader::reset()\BaseParamFilterReader::reset()
methodpublicsetHtml( boolean $b ) : void

Whether to use HTML parser for XML.

Parameters
Name Type Description
$b boolean
methodpublicsetInitialized( boolean $initialized ) : void
inherited

Sets the initialized status.

Inherited from: \BaseFilterReader::setInitialized()\BaseParamFilterReader::setInitialized()
Parameters
Name Type Description
$initialized boolean

Whether or not the filter is initialized.

methodpublicsetParameters(  $parameters ) : void
inherited

Inherited from: \BaseParamFilterReader::setParameters()
Parameters
Name Type Description
$parameters
methodpublicsetParams( array $params ) : void

Sets the XSLT params for this class.

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

Parameters
Name Type Description
$params array
methodpublicsetProject( object $project ) : void
inherited

Sets the project to work with.

Inherited from: \BaseFilterReader::setProject()\BaseParamFilterReader::setProject()
Parameters
Name Type Description
$project object

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

methodpublicsetReader(  $in ) : void
Parameters
Name Type Description
$in
methodpublicsetResolveDocumentExternals( bool $resolveExternals ) : void

Whether to resolve entities in document.

Parameters
Name Type Description
$resolveExternals bool
Details
Since
2.4  
methodpublicsetResolveStylesheetExternals( bool $resolveExternals ) : void

Whether to resolve entities in stylesheet.

Parameters
Name Type Description
$resolveExternals bool
Details
Since
2.4  
methodpublicsetStyle( mixed $file ) : void

Set the XSLT stylesheet.

Parameters
Name Type Description
$file mixed

PhingFile object or path.

methodpublicskip( int $n ) : void
inherited

Move stream position relative to current pos.

Inherited from: \FilterReader::skip()\BaseFilterReader::skip()\BaseParamFilterReader::skip()
Parameters
Name Type Description
$n int
Documentation was generated by DocBlox 0.18.1.