filters/XincludeFilter.php

Applies Xinclude parsing to incoming text.

Implements

\ChainableReader

Parent(s)

\BaseParamFilterReader < \BaseFilterReader < \FilterReader < \Reader

See

\FilterReader  

Author

Bill Karwin  

Version

$Id: XincludeFilter.php 526 2009-08-11 12:11:17Z mrook $  

Properties

 $basedir= 'null'

Default valuenullDetails

Type

n/a

bool  $processed= 'false'

Default valuefalseDetails

Type

bool

bool  $resolveExternals= 'false'

Whether to resolve entities.

Default valuefalseDetails

Type

bool

Since

2.4  

Methods

__construct( ) : void

chain( \Reader $reader ) : \Reader

Creates a new XincludeFilter 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

eof( ) : void

getBasedir( ) : void

getInitialized( ) : void

getParameters( ) : void

getProject( ) : void

getResolveExternals( ) : bool

Returns

Type	Description
bool

Details

Since

2.4  

getResource( ) : void

log( ) : void

mark( ) : void

markSupported( ) : void

process( string $xml ) : void

Try to process the Xinclude transformation

Parameters

Name	Type	Description
$xml	string	XML to process.

Throws

Exception	Description
\BuildException	On errors

read(  $len = null ) : string

Reads stream, applies XSLT and returns resulting stream.

Parameters

Name	Type	Description
$len

Returns

Type	Description
string	transformed buffer.

Throws

Exception	Description
\BuildException	- if XSLT support missing, if error in xslt processing

readLine( ) : void

ready( ) : void

reset( ) : void

setBasedir(  $dir ) : void

Parameters

Name	Type	Description
$dir

setInitialized( ) : void

setParameters( ) : void

setProject( ) : void

setReader( ) : void

setResolveExternals(  $resolveExternals ) : void

Whether to resolve entities.

Parameters

Name	Type	Description
$resolveExternals

Details

Since

2.4  

skip( ) : void