XSLTProcessor

class XSLTProcessor (View source)

Properties

bool $cloneDocument

Controls whether the input document is cloned before transformation
bool $doXInclude

Controls whether XInclude substitution is performed
int $maxTemplateDepth

The maximum template nesting depth
int $maxTemplateVars

The maximum number of template variables

Methods

bool
importStylesheet(object $stylesheet)

Import stylesheet

object|false
transformToDoc(object $document, string|null $returnClass = null)

Transform to a DOMDocument

int
transformToUri(DOMDocument|SimpleXMLElement $document, string $uri)

Transform to URI

string|false|null
transformToXml(DOMDocument|SimpleXMLElement $document)

Transform to XML

bool
setParameter(string $namespace, string $name, string $value = null)

Set value for a parameter

string|false
getParameter(string $namespace, string $name)

Get value of a parameter

bool
removeParameter(string $namespace, string $name)

Remove parameter

bool
hasExsltSupport()

Determine if PHP has EXSLT support

void
registerPHPFunctions(array|string|null $functions = null)

Enables the ability to use PHP functions as XSLT functions

void
registerPHPFunctionNS(string $namespaceURI, string $name, callable $callable)

Registers a PHP function to be callable from XSLT under the given namespace

bool
setProfiling(string $filename)

Sets profiling output file

int
setSecurityPrefs(int $preferences)

Set security preferences

int
getSecurityPrefs()

Get security preferences

Details

at line 50
bool importStylesheet(object $stylesheet)

Import stylesheet

Parameters

object $stylesheet

The imported style sheet as a DOMDocument or SimpleXMLElement object.

Return Value

bool

TRUE on success or FALSE on failure.

at line 60
object|false transformToDoc(object $document, string|null $returnClass = null)

Transform to a DOMDocument

Parameters

object $document

The DOMDocument or SimpleXMLElement or libxml-compatible object to be transformed.
string|null $returnClass

Return Value

object|false

The resulting DOMDocument or FALSE on error.

at line 77
int transformToUri(DOMDocument|SimpleXMLElement $document, string $uri)

Transform to URI

Parameters

DOMDocument|SimpleXMLElement $document

The document to transform.

string $uri

The target URI for the transformation.

Return Value

int

the number of bytes written or FALSE if an error occurred.

at line 91
string|false|null transformToXml(DOMDocument|SimpleXMLElement $document)

Transform to XML

Parameters

DOMDocument|SimpleXMLElement $document

The transformed document.

Return Value

string|false|null

The result of the transformation as a string or FALSE on error.

at line 108
bool setParameter(string $namespace, string $name, string $value = null)

Set value for a parameter

Parameters

string $namespace

The namespace URI of the XSLT parameter.

string $name

The local name of the XSLT parameter.

string $value

The new value of the XSLT parameter.

Return Value

bool

TRUE on success or FALSE on failure.

at line 126
string|false getParameter(string $namespace, string $name)

Get value of a parameter

Parameters

string $namespace

The namespace URI of the XSLT parameter.

string $name

The local name of the XSLT parameter.

Return Value

string|false

The value of the parameter (as a string), or FALSE if it's not set.

at line 143
bool removeParameter(string $namespace, string $name)

Remove parameter

Parameters

string $namespace

The namespace URI of the XSLT parameter.

string $name

The local name of the XSLT parameter.

Return Value

bool

TRUE on success or FALSE on failure.

at line 155
bool hasExsltSupport()

Since: 5.0

Determine if PHP has EXSLT support

Return Value

bool

TRUE on success or FALSE on failure.

at line 172
void registerPHPFunctions(array|string|null $functions = null)

Since: 5.0

Enables the ability to use PHP functions as XSLT functions

Parameters

array|string|null $functions

[optional]

Use this parameter to only allow certain functions to be called from XSLT.

This parameter can be either a string (a function name) or an array of functions.

Return Value

void

No value is returned.

at line 190
void registerPHPFunctionNS(string $namespaceURI, string $name, callable $callable)

Since: 8.4

Registers a PHP function to be callable from XSLT under the given namespace

Parameters

string $namespaceURI

The namespace URI the function is registered under.

string $name

The name the function is exposed as inside the stylesheet.

callable $callable

The PHP callable to invoke.

Return Value

void

No value is returned.

at line 201
bool setProfiling(string $filename)

Sets profiling output file

Parameters

string $filename

Path to the file to dump profiling information.

Return Value

bool

TRUE on success or FALSE on failure.

at line 212
int setSecurityPrefs(int $preferences)

Since: 5.4

Set security preferences

Parameters

int $preferences

Return Value

int

at line 221
int getSecurityPrefs()

Since: 5.4

Get security preferences

Return Value

int