Docs For Class XML_XSLT

XML_XSLT_Common (Constructor) [line 345]

XML_XSLT_Common XML_XSLT_Common(
)

Class constructor

[ Top ]

_XML_XSLT_Common (Destructor) [line 354]

void _XML_XSLT_Common(
)

Destructor

[ Top ]

batchXML [line 844]

mixed batchXML(
array
$options)

Transform one single XML data with multiple XSL files.

This method has to be overridden in the backend.

Return: return
See: backend
Access: public

Overridden in child classes as:

XML_XSLT_Backend_XSL_ext::batchXML(): Transform single XML data with multiple XSL files

XML_XSLT_Backend_XSLTPROC::batchXML(): Transform one single XML data with multiple XSL files

XML_XSLT_Backend_Sablotron::batchXML(): Transform single XML data with multiple XSL files

XML_XSLT_Backend_DOM_XSL::batchXML(): Transform single XML data with multiple XSL files

XML_XSLT_Backend_XT::batchXML(): Transform one single XML data with multiple XSL files

XML_XSLT_Backend_XSLT_ext::batchXML(): Transform single XML data with multiple XSL files

XML_XSLT_Backend_MSXSL_Com::batchXML(): Transform single XML data with multiple XSL files

Parameters:

array $options — Array with all data and options needed

[ Top ]

batchXSL [line 862]

boolean batchXSL(
array
$options, [boolean
$singleoutput = false])

Transform multiple XML data with a single XSL files

Return: true if success, false otherwise
See: backend
Access: public

Overridden in child classes as:

XML_XSLT_Backend_XSL_ext::batchXSL(): Transform multiple XML data with a single XSL files

XML_XSLT_Backend_XSLTPROC::batchXSL(): Transform multiple XML data with a single XSL files

XML_XSLT_Backend_Sablotron::batchXSL(): Transform multiple XML data with a single XSL files

XML_XSLT_Backend_DOM_XSL::batchXSL(): Transform multiple XML data with a single XSL files

XML_XSLT_Backend_XT::batchXSL(): Transform multiple XML data with a single XSL files

XML_XSLT_Backend_XSLT_ext::batchXSL(): Transform multiple XML data with a single XSL files

XML_XSLT_Backend_MSXSL_Com::batchXSL(): Transform multiple XML data with a single XSL files

Parameters:

array	`$options`	—	Array with all data and options needed
boolean	`$singleoutput`	—	not used

[ Top ]

raiseError [line 392]

object a &raiseError(
[mixed
$code = XML_XSLT_ERROR], [int
$mode = null], [mixed
$options = null], [string
$userinfo = null], [mixed
$nativecode = null])

This method is used to communicate an error and invoke error callbacks etc. Basically a wrapper for PEAR::raiseError without the message string.

Return: PEAR error object
See: PEAR_Error
Access: public

Parameters:

mixed	`$code`	—	integer error code, or a PEAR error object (all other parameters are ignored if this parameter is an object
int	`$mode`	—	error mode, see PEAR_Error docs
mixed	`$options`	—	If error mode is PEAR_ERROR_TRIGGER, this is the error level (E_USER_NOTICE etc). If error mode is PEAR_ERROR_CALLBACK, this is the callback function, either as a function name, or as an array of an object and method name. For other error modes this parameter is ignored.
string	`$userinfo`	—	Extra debug information. Defaults to the last query and native error code.
mixed	`$nativecode`	—	Native error code, integer or string depending the backend.

[ Top ]

ResultDumpFile [line 790]

boolean ResultDumpFile(
)

Output to a file.

This method has to be overridden in the backend.

Return: true if success, false otherwise
See: backend
Access: public

Overridden in child classes as:

XML_XSLT_Backend_XSL_ext::ResultDumpFile(): Dumps the result to a file

XML_XSLT_Backend_XSLTPROC::ResultDumpFile(): Dump the result of the transformation to a file

XML_XSLT_Backend_Sablotron::ResultDumpFile(): Dump the result of the transformation to a file

XML_XSLT_Backend_DOM_XSL::ResultDumpFile(): Dumps the result to a file

XML_XSLT_Backend_XT::ResultDumpFile(): Dump the result of the transformation to a file

XML_XSLT_Backend_XSLT_ext::ResultDumpFile(): Set the parameters for the active XSL sheet

XML_XSLT_Backend_MSXSL_Com::ResultDumpFile(): Dumps the transformation result to a file

[ Top ]

ResultDumpMem [line 808]

boolean ResultDumpMem(
)

Return the output.

This method has to be overridden in the backend.

Return: true if success, false otherwise
See: backend
Access: public

Overridden in child classes as:

XML_XSLT_Backend_XSL_ext::ResultDumpMem(): Dumps the result to memory

XML_XSLT_Backend_XSLTPROC::ResultDumpMem(): Return the result of the transformation

XML_XSLT_Backend_Sablotron::ResultDumpMem(): Return the result of the transformation

XML_XSLT_Backend_DOM_XSL::ResultDumpMem(): Dumps the result to memory

XML_XSLT_Backend_XT::ResultDumpMem(): Return the result of the transformation

XML_XSLT_Backend_XSLT_ext::ResultDumpMem(): Set the parameters for the active XSL sheet

XML_XSLT_Backend_MSXSL_Com::ResultDumpMem(): Return the transformation result

[ Top ]

ResultDumpOut [line 825]

mixed ResultDumpOut(
)

Output to the default output.

This method has to be overridden in the backend.

Return: nothing if all went well, false otherwise
See: backend
Access: public

Overridden in child classes as:

XML_XSLT_Backend_XSL_ext::ResultDumpOut(): Dump the result to standard output.

XML_XSLT_Backend_XSLTPROC::ResultDumpOut(): Dumps the result of the transformation to stdout

XML_XSLT_Backend_Sablotron::ResultDumpOut(): Dumps the result of the transformation to stdout

XML_XSLT_Backend_DOM_XSL::ResultDumpOut(): Dump the result to standard output.

XML_XSLT_Backend_XT::ResultDumpOut(): Dumps the result of the transformation to stdout

XML_XSLT_Backend_XSLT_ext::ResultDumpOut(): Set the parameters for the active XSL sheet

XML_XSLT_Backend_MSXSL_Com::ResultDumpOut(): Dumps the transformation result to stdout

[ Top ]

setOption [line 629]

boolean setOption(
string
$option, mixed
$value)

Defines one option for the active backend

Access: public

Parameters:

string	`$option`	—	name of the param
mixed	`$value`	—	value of the param

[ Top ]

setOptions [line 607]

boolean setOptions(
array
$options)

Defines the options for the active backend

See: backend
Access: public

Parameters:

array $options — the options to set

[ Top ]

setOuputMode [line 767]

boolean setOuputMode(
[int
$mode = XSLT_OUTPUT_MEM], [string
$arg = ''])

Sets the desired output mode.

See: backend
Access: public

Parameters:

int	`$mode`	—	the desired output mode
string	`$arg`	—	file name or callback function name

[ Top ]

setOutputEconding [line 590]

null setOutputEconding(
[string
$encode = ''])

Set the output encoding (does not work with all backend)

Access: public

Parameters:

string $encode — type of encoding

[ Top ]

setParam [line 572]

null setParam(
string
$param, mixed
$value)

Set one parameter for XSLT

Access: public

Parameters:

string	`$param`	—	parameter name
mixed	`$value`	—	parameter vamue

[ Top ]

setParams [line 551]

mixed setParams(
array
$params)

Set a group of parameters for XSLT

Return: return
See: backend
Access: public

Overridden in child classes as:

XML_XSLT_Backend_XSL_ext::setParams(): Set a group of parameters for XSLT

Parameters:

array $params — parameters which will be used by the backend

[ Top ]

setXML [line 427]

mixed setXML(
[string
$data = ''], [string
$mode = XML_XSLT_MODE_STRING], [string
$options = null])

Set the XML data to transform.

Return: return
See: backend
Access: public

Parameters:

string	`$data`	—	source origin (file path, URI) or XSLT definitions within inside a string variable.
string	`$mode`	—	the conversion mode, see constants
string	`$options`	—	options

[ Top ]

setXSL [line 488]

mixed setXSL(
[string
$data = ''], [string
$mode = XML_XSLT_MODE_FILE], [string
$options = null])

Load the XSL sheet from a defined source

Return: return
Access: public

Parameters:

string	`$data`	—	source origin (file path, URI) or XSLT definitions within inside a string variable.
string	`$mode`	—	the conversion mode, see constants
string	`$options`	—	options

[ Top ]

_getFileContent [line 648]

mixed _getFileContent(
string
$path)

Gets data from a file

Return: return
See: backend
Access: public

Parameters:

string $path — Path to read

[ Top ]

Class: XML_XSLT_Common

Class Overview

Author(s):

Variables

Methods

Child classes:

Inherited Variables

Inherited Methods

Class Details

Class Variables

$error_code = 0

$native_error_code = 0

$native_error_message = ''

$outputEncoding = ''

$outputFile = ''

$result = ''

Method Detail

XML_XSLT_Common (Constructor) [line 345]

_XML_XSLT_Common (Destructor) [line 354]

batchXML [line 844]

Parameters:

batchXSL [line 862]

Parameters:

raiseError [line 392]

Parameters:

ResultDumpFile [line 790]

ResultDumpMem [line 808]

ResultDumpOut [line 825]

setOption [line 629]

Parameters:

setOptions [line 607]

Parameters:

setOuputMode [line 767]

Parameters:

setOutputEconding [line 590]

Parameters:

setParam [line 572]

Parameters:

setParams [line 551]

Parameters:

setXML [line 427]

Parameters:

setXSL [line 488]

Parameters:

_getFileContent [line 648]

Parameters: