Open Journal Systems  3.3.0
XSLTransformationFilter Class Reference
Inheritance diagram for XSLTransformationFilter:
PersistableFilter Filter DataObject

Public Member Functions

 __construct ($filterGroup, $displayName='XSL Transformation')
 
 getClassName ()
 
 getResultType ()
 
getXSL ()
 
 getXSLType ()
 
process (&$xml)
 
 setResultType ($resultType)
 
 setXSL (&$xsl)
 
 setXSLFilename ($xslFile)
 
- Public Member Functions inherited from PersistableFilter
 __construct ($filterGroup)
 
 addSetting ($setting)
 
 getFilterGroup ()
 
 getInternalSettings ()
 
 getIsTemplate ()
 
 getLocalizedSettingNames ()
 
 getParentFilterId ()
 
 getSetting ($settingName)
 
 getSettingNames ()
 
getSettings ()
 
 hasSetting ($settingName)
 
 hasSettings ()
 
 setIsTemplate ($isTemplate)
 
 setParentFilterId ($parentFilterId)
 
- Public Member Functions inherited from Filter
 addError ($message)
 
 clearErrors ()
 
execute (&$input, $returnErrors=false)
 
 getDisplayName ()
 
 getErrors ()
 
getInputType ()
 
getLastInput ()
 
getLastOutput ()
 
getOutputType ()
 
getRuntimeEnvironment ()
 
 getSequence ()
 
 hasErrors ()
 
 isCompatibleWithRuntimeEnvironment ()
 
 setDisplayName ($displayName)
 
 setRuntimeEnvironment (&$runtimeEnvironment)
 
 setSequence ($seq)
 
 setTransformationType (&$inputType, &$outputType)
 
 supports (&$input, &$output)
 
 supportsAsInput (&$input)
 
- Public Member Functions inherited from DataObject
 __construct ()
 
 addSupportedMetadataAdapter ($metadataAdapter)
 
 extractMetadata ($metadataSchema)
 
 getAdditionalMetadataFieldNames ()
 
getAllData ()
 
 getDAO ()
 
getData ($key, $locale=null)
 
 getHasLoadableAdapters ()
 
 getId ()
 
 getLocaleMetadataFieldNames ()
 
 getLocalizedData ($key, $preferredLocale=null)
 
 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)
 
 unsetData ($key, $locale=null)
 
 upcastTo ($targetObject)
 

Additional Inherited Members

- Static Public Member Functions inherited from PersistableFilter
static tempGroup ($inputType, $outputType)
 
- Static Public Member Functions inherited from Filter
static supportedRuntimeEnvironmentSettings ()
 
- Data Fields inherited from PersistableFilter
 $_filterGroup
 
 $_settings = array()
 
- Data Fields inherited from Filter
 $_errors = array()
 
 $_input
 
 $_inputType
 
 $_output
 
 $_outputType
 
 $_runtimeEnvironment = false
 
- Data Fields inherited from DataObject
 $_data = array()
 
 $_extractionAdaptersLoaded = false
 
 $_hasLoadableAdapters = false
 
 $_injectionAdaptersLoaded = false
 
 $_metadataExtractionAdapters = array()
 
 $_metadataInjectionAdapters = array()
 

Detailed Description

Class that transforms XML via XSL.

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

Constructor & Destructor Documentation

◆ __construct()

XSLTransformationFilter::__construct (   $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.

Reimplemented from Filter.

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

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

Member Function Documentation

◆ getClassName()

XSLTransformationFilter::getClassName ( )
See also
PersistableFilter::getClassName()

Reimplemented from PersistableFilter.

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

◆ getResultType()

XSLTransformationFilter::getResultType ( )

Get the result type

Returns
integer

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

References DataObject\getData().

Referenced by process().

◆ getXSL()

& 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().

◆ getXSLType()

XSLTransformationFilter::getXSLType ( )

Get the XSL Type

Returns
integer

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

References DataObject\getData().

◆ process()

& XSLTransformationFilter::process ( $xml)

Process the given XML with the configured XSL

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

Reimplemented from Filter.

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

References getResultType(), and setResultType().

◆ 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().

◆ setXSL()

XSLTransformationFilter::setXSL ( $xsl)

Set the XSL

Parameters
$xslDOMDocument|string

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

References DataObject\setData().

◆ setXSLFilename()

XSLTransformationFilter::setXSLFilename (   $xslFile)

Set the XSL as a file name

Parameters
$xslFilestring

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

References DataObject\setData().


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