Open Journal Systems  3.3.0
NativeXmlRepresentationFilter Class Reference
Inheritance diagram for NativeXmlRepresentationFilter:
NativeImportFilter NativeImportExportFilter PersistableFilter Filter DataObject NativeXmlArticleGalleyFilter

Public Member Functions

 __construct ($filterGroup)
 
 getClassName ()
 
 handleElement ($node)
 
 parseIdentifier ($element, $representation)
 
- Public Member Functions inherited from NativeImportFilter
 getPluralElementName ()
 
 getSingularElementName ()
 
 parseLocalizedContent ($element)
 
process (&$document)
 
- Public Member Functions inherited from NativeImportExportFilter
 getDeployment ()
 
 setDeployment ($deployment)
 
- Public Member Functions inherited from PersistableFilter
 addSetting ($setting)
 
 getFilterGroup ()
 
 getInternalSettings ()
 
 getIsTemplate ()
 
 getLocalizedSettingNames ()
 
 getParentFilterId ()
 
 getSetting ($settingName)
 
 getSettingNames ()
 
getSettings ()
 
 hasSetting ($settingName)
 
 hasSettings ()
 
 setIsTemplate ($isTemplate)
 
 setParentFilterId ($parentFilterId)
 
- Public Member Functions inherited from Filter
 __construct ($inputType, $outputType)
 
 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 NativeImportExportFilter
 $_deployment
 
- 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

Base class that converts a Native XML document to a set of authors.

Definition at line 18 of file NativeXmlRepresentationFilter.inc.php.

Constructor & Destructor Documentation

◆ __construct()

NativeXmlRepresentationFilter::__construct (   $filterGroup)

Constructor

Parameters
$filterGroupFilterGroup

Reimplemented from NativeImportFilter.

Reimplemented in NativeXmlArticleGalleyFilter.

Definition at line 23 of file NativeXmlRepresentationFilter.inc.php.

References Filter\setDisplayName().

Member Function Documentation

◆ getClassName()

NativeXmlRepresentationFilter::getClassName ( )

Return the fully qualified class name of the filter class. This information must be persisted when saving a filter so that the filter can later be reconstructed from the information in the database.

(This must be hard coded by sub-classes for PHP4 compatibility. PHP4 always returns class names lowercase which we cannot tolerate as we need this path to find the class on case sensitive file systems.)

Reimplemented from PersistableFilter.

Reimplemented in NativeXmlArticleGalleyFilter.

Definition at line 34 of file NativeXmlRepresentationFilter.inc.php.

◆ handleElement()

NativeXmlRepresentationFilter::handleElement (   $node)

Handle a Representation element

Parameters
$nodeDOMElement
Returns
Representation

Reimplemented from NativeImportFilter.

Reimplemented in NativeXmlArticleGalleyFilter.

Definition at line 44 of file NativeXmlRepresentationFilter.inc.php.

References NativeImportExportFilter\getDeployment(), Application\getRepresentationDAO(), and parseIdentifier().

◆ parseIdentifier()

NativeXmlRepresentationFilter::parseIdentifier (   $element,
  $representation 
)

Parse an identifier node and set up the representation object accordingly

Parameters
$elementDOMElement
$representationRepresentation

Definition at line 79 of file NativeXmlRepresentationFilter.inc.php.

References NativeImportExportFilter\getDeployment(), and PluginRegistry\loadCategory().

Referenced by handleElement().


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