# filters/XsltFilter.php

## \XSLTParam
jump to top

Package: phing\filters

Class that holds an XSLT parameter.

### Properties

`$expr= ''`
Details

Type

`$name= ''`
Details

Type

### Methods

`getExpression( ) : string`

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

Returns

Type | Description
--- | ---
string |

`getName( ) : string`

Get param name.

Returns

Type | Description
--- | ---
string |

`getValue( ) : void`

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

Details

See
  \getExpression()

`setExpression( string $expr ) : void`

Sets expression value.

Parameters

Name | Type | Description
--- | --- | ---
$expr | string |

`setListeningExpression( \RegisterSlot $expr ) : void`

Sets expression to dynamic register slot.

Parameters

Name | Type | Description
--- | --- | ---
$expr | \RegisterSlot |

`setName( string $name ) : void`

Sets param name.

Parameters

Name | Type | Description
--- | --- | ---
$name | string |

`setValue( string $v ) : void`

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

Parameters

Name | Type | Description
--- | --- | ---
$v | string |

Details

See
  \setExpression()

## \XsltFilter
jump to top

Package: phing\filters

Applies XSL stylesheet to incoming text.

Uses PHP XSLT support (libxslt).

Implements
  \ChainableReader
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: XsltFilter.php 557 2009-08-29 13:54:38Z mrook $

### Properties

`$_parameters= 'array()'`
inherited

The passed in parameter array.

Inherited from: \BaseParamFilterReader::$_parameters
Default value `array()`Details

Type
Inherited_from
  \BaseParamFilterReader::$_parameters

`$html= 'false'`

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

Default value `false` Details

Type

`\Reader $in= ''`
inherited

Inherited from: \FilterReader::$in
Details

Type
  \Reader
Inherited_from
  \FilterReader::$in

`$initialized= 'false'`
inherited

Have the parameters passed been interpreted?

Inherited from: \BaseFilterReader::$initialized
Default value `false` Details

Type
Inherited_from
  \BaseFilterReader::$initialized

`boolean $processed= 'false'`

Whether XML file has been transformed.

Default value `false` Details

Type
  boolean

`$project= 'null'`
inherited

The Phing project this filter is part of.

Inherited from: \BaseFilterReader::$project
Default value `null` Details

Type
Inherited_from
  \BaseFilterReader::$project

`bool $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 value `false` Details

Type
  bool
Since
  2.4

`bool $resolveStylesheetExternals= 'false'`

Whether to resolve entities in the stylesheet.

Default value `false` Details

Type
  bool
Since
  2.4

`string $xslFile= 'null'`

Path to XSL stylesheet.

Default value `null` Details

Type
  string

`array $xsltParams= 'array()'`

XSLT Params.

Default value `array()`Details

Type
  array

### Methods

`__construct( \Reader $in = null ) : void`
inherited

Constructor used by Phing's introspection mechanism.

Inherited from: \BaseFilterReader::__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 |

`_initialize( ) : void`

Parses the parameters to get stylesheet path.

`chain( \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

`close( ) : void`
inherited

Close stream.

Inherited from: \FilterReader::close()
Throws

Exception | Description
--- | ---
\IOException | if there is an error closing stream

`createParam( ) : \XSLTParam`

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

Returns

Type | Description
--- | ---
\XSLTParam |

`eof( ) : boolean`
inherited

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

Inherited from: \BaseFilterReader::eof()
Returns

Type | Description
--- | ---
boolean |

`getHtml( ) : boolean`

Whether to use HTML parser for the XML.

This is supported in libxml2 -- Yay!

Returns

Type | Description
--- | ---
boolean |

`getInitialized( ) : boolean`
inherited

Returns the initialized status.

Inherited from: \BaseFilterReader::getInitialized()
Returns

Type | Description
--- | ---
boolean | whether or not the filter is initialized

`getParameters( ) : void`
inherited

Inherited from: \BaseParamFilterReader::getParameters()
`getParams( ) : array`

Returns the XSLT params set for this class.

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

Returns

Type | Description
--- | ---
array |

`getProject( ) : object`
inherited

Returns the project this filter is part of.

Inherited from: \BaseFilterReader::getProject()
Returns

Type | Description
--- | ---
object | The project this filter is part of

`getResolveDocumentExternals( ) : bool`

Returns

Type | Description
--- | ---
bool |

Details

Since
  2.4

`getResolveStylesheetExternals( ) : bool`

Returns

Type | Description
--- | ---
bool |

Details

Since
  2.4

`getResource( ) : string`
inherited

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

Inherited from: \FilterReader::getResource()

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

Returns

Type | Description
--- | ---
string |

`getStyle( ) : mixed`

Get the path to XSLT stylesheet.

Returns

Type | Description
--- | ---
mixed | XSLT stylesheet path.

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

Convenience method to support logging in filters.

Inherited from: \BaseFilterReader::log()
Parameters

Name | Type | Description
--- | --- | ---
$msg | string | Message to log.
$level | int | Priority level.

`mark( ) : void`
inherited

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

Inherited from: \Reader::mark()

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

`markSupported( ) : boolean`
inherited

Whether marking is supported.

Inherited from: \Reader::markSupported()
Returns

Type | Description
--- | ---
boolean |

`process( 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

`read( \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

`readLine( ) : \the`
inherited

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

Inherited from: \BaseFilterReader::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

`ready( ) : boolean`
inherited

Is stream ready for reading.

Inherited from: \Reader::ready()
Returns

Type | Description
--- | ---
boolean |

`reset( ) : void`
inherited

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

Inherited from: \FilterReader::reset()
`setHtml( boolean $b ) : void`

Whether to use HTML parser for XML.

Parameters

Name | Type | Description
--- | --- | ---
$b | boolean |

`setInitialized( boolean $initialized ) : void`
inherited

Sets the initialized status.

Inherited from: \BaseFilterReader::setInitialized()
Parameters

Name | Type | Description
--- | --- | ---
$initialized | boolean | Whether or not the filter is initialized.

`setParameters( $parameters ) : void`
inherited

Inherited from: \BaseParamFilterReader::setParameters()
Parameters

Name | Type | Description
--- | --- | ---
$parameters |  |

`setParams( 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 |

`setProject( object $project ) : void`
inherited

Sets the project to work with.

Inherited from: \BaseFilterReader::setProject()
Parameters

Name | Type | Description
--- | --- | ---
$project | object | The project this filter is part of. Should not be `null`.

`setReader( $in ) : void`
inherited

Inherited from: \FilterReader::setReader()
Parameters

Name | Type | Description
--- | --- | ---
$in |  |

`setResolveDocumentExternals( bool $resolveExternals ) : void`

Whether to resolve entities in document.

Parameters

Name | Type | Description
--- | --- | ---
$resolveExternals | bool |

Details

Since
  2.4

`setResolveStylesheetExternals( bool $resolveExternals ) : void`

Whether to resolve entities in stylesheet.

Parameters

Name | Type | Description
--- | --- | ---
$resolveExternals | bool |

Details

Since
  2.4

`setStyle( mixed $file ) : void`

Set the XSLT stylesheet.

Parameters

Name | Type | Description
--- | --- | ---
$file | mixed | PhingFile object or path.

`skip( int $n ) : void`
inherited

Move stream position relative to current pos.

Inherited from: \FilterReader::skip()
Parameters

Name | Type | Description
--- | --- | ---
$n | int |

Documentation was generated by DocBlox 0.15.1.