Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
XSLTransformationFilter Class Reference
Inheritance diagram for XSLTransformationFilter:
PersistableFilter Filter DataObject

Public Member Functions

 getClassName ()
 
 getResultType ()
 
getXSL ()
 
 getXSLType ()
 
process (&$xml)
 
 setResultType ($resultType)
 
 setXSL (&$xsl)
 
 setXSLFilename ($xslFile)
 
 XSLTransformationFilter (&$filterGroup, $displayName= 'XSL Transformation')
 
- Public Member Functions inherited from PersistableFilter
 addSetting (&$setting)
 
 getClassName ()
 
getFilterGroup ()
 
 getInternalSettings ()
 
 getIsTemplate ()
 
 getLocalizedSettingNames ()
 
 getParentFilterId ()
 
getSetting ($settingName)
 
 getSettingNames ()
 
getSettings ()
 
 hasSetting ($settingName)
 
 hasSettings ()
 
 PersistableFilter (&$filterGroup)
 
 setIsTemplate ($isTemplate)
 
 setParentFilterId ($parentFilterId)
 
 tempGroup ($inputType, $outputType)
 
- Public Member Functions inherited from Filter
 addError ($message)
 
 clearErrors ()
 
execute (&$input)
 
 Filter ($inputType, $outputType)
 
 getDisplayName ()
 
 getErrors ()
 
getInputType ()
 
getLastInput ()
 
getLastOutput ()
 
getOutputType ()
 
getRuntimeEnvironment ()
 
 getSeq ()
 
 hasErrors ()
 
 isCompatibleWithRuntimeEnvironment ()
 
process (&$input)
 
 setDisplayName ($displayName)
 
 setRuntimeEnvironment (&$runtimeEnvironment)
 
 setSeq ($seq)
 
 setTransformationType (&$inputType, &$outputType)
 
 supportedRuntimeEnvironmentSettings ()
 
 supports (&$input, &$output)
 
 supportsAsInput (&$input)
 
- Public Member Functions inherited from DataObject
 addSupportedMetadataAdapter (&$metadataAdapter)
 
 DataObject ($callHooks=true)
 
extractMetadata (&$metadataSchema)
 
 getAdditionalMetadataFieldNames ()
 
getAllData ()
 
getData ($key, $locale=null)
 
 getHasLoadableAdapters ()
 
 getId ()
 
 getLocaleMetadataFieldNames ()
 
getLocalizedData ($key)
 
 getMetadataFieldNames ($translated=true)
 
 getSetMetadataFieldNames ($translated=true)
 
getSupportedExtractionAdapters ()
 
getSupportedInjectionAdapters ()
 
getSupportedMetadataSchemas ()
 
 hasData ($key, $locale=null)
 
 injectMetadata (&$metadataDescription)
 
 removeSupportedMetadataAdapter ($metadataSchemaName)
 
 setAllData (&$data)
 
 setData ($key, $value, $locale=null)
 
 setHasLoadableAdapters ($hasLoadableAdapters)
 
 setId ($id)
 
upcastTo (&$targetObject)
 

Additional Inherited Members

- Public Attributes inherited from DataObject
 $_data = array()
 

Detailed Description

Class that transforms XML via XSL.

Definition at line 19 of file XSLTransformationFilter.inc.php.

Member Function Documentation

XSLTransformationFilter::getClassName ( )
XSLTransformationFilter::getResultType ( )

Get the result type

Returns
integer

Definition at line 93 of file XSLTransformationFilter.inc.php.

References DataObject\getData().

Referenced by process().

& XSLTransformationFilter::getXSL ( )

Get the XSL

Returns
DOMDocument|string a document, xsl string or file name

Definition at line 53 of file XSLTransformationFilter.inc.php.

References DataObject\getData().

XSLTransformationFilter::getXSLType ( )

Get the XSL Type

Returns
integer

Definition at line 61 of file XSLTransformationFilter.inc.php.

References DataObject\getData().

& XSLTransformationFilter::process ( $xml)

Process the given XML with the configured XSL

See Also
Filter::process()
Parameters
$xmlDOMDocument|string
Returns
DOMDocument|string

Definition at line 126 of file XSLTransformationFilter.inc.php.

References getResultType(), and setResultType().

XSLTransformationFilter::setResultType (   $resultType)

Set the result type

Parameters
$resultTypeinteger

Definition at line 101 of file XSLTransformationFilter.inc.php.

References DataObject\setData().

Referenced by process().

XSLTransformationFilter::setXSL ( $xsl)

Set the XSL

Parameters
$xslDOMDocument|string

Definition at line 69 of file XSLTransformationFilter.inc.php.

References DataObject\setData().

XSLTransformationFilter::setXSLFilename (   $xslFile)

Set the XSL as a file name

Parameters
unknown_type$xslFile

Definition at line 84 of file XSLTransformationFilter.inc.php.

References DataObject\setData().

XSLTransformationFilter::XSLTransformationFilter ( $filterGroup,
  $displayName = 'XSL Transformation' 
)

Constructor

Parameters
$filterGroupFilterGroup
$displayNamestring

NB: The input side of the transformation must always be an XML format. See the XMLTypeDescription class for more details how to enable XML validation.

Definition at line 30 of file XSLTransformationFilter.inc.php.

References PersistableFilter\addSetting(), and Filter\setDisplayName().


The documentation for this class was generated from the following file: