Open Journal Systems  3.3.0
RepresentationNativeXmlFilter Class Reference
Inheritance diagram for RepresentationNativeXmlFilter:
NativeExportFilter NativeImportExportFilter PersistableFilter Filter DataObject ArticleGalleyNativeXmlFilter

Public Member Functions

 __construct ($filterGroup)
 
 addIdentifiers ($doc, $representationNode, $representation)
 
 addPubIdentifier ($doc, $representationNode, $representation, $pubIdPlugin)
 
 createRepresentationNode ($doc, $representation)
 
 getClassName ()
 
 getFiles ($representation)
 
process (&$representation)
 
- Public Member Functions inherited from NativeExportFilter
 createLocalizedNodes ($doc, $parentNode, $name, $values)
 
 createOptionalNode ($doc, $parentNode, $name, $value)
 
 getNoValidation ()
 
 setNoValidation ($noValidation)
 
 setOpts ($opts)
 
 supports (&$input, &$output)
 
- 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)
 
 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 NativeExportFilter
 $_noValidation = null
 
 $opts = array()
 
- 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 representation to a Native XML document.

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

Constructor & Destructor Documentation

◆ __construct()

RepresentationNativeXmlFilter::__construct (   $filterGroup)

Constructor

Parameters
$filterGroupFilterGroup

Reimplemented from NativeExportFilter.

Reimplemented in ArticleGalleyNativeXmlFilter.

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

References Filter\setDisplayName().

Member Function Documentation

◆ addIdentifiers()

RepresentationNativeXmlFilter::addIdentifiers (   $doc,
  $representationNode,
  $representation 
)

Create and add identifier nodes to a representation node.

Parameters
$docDOMDocument
$representationNodeDOMElement
$representationRepresentation

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

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

Referenced by createRepresentationNode().

◆ addPubIdentifier()

RepresentationNativeXmlFilter::addPubIdentifier (   $doc,
  $representationNode,
  $representation,
  $pubIdPlugin 
)

Add a single pub ID element for a given plugin to the representation.

Parameters
$docDOMDocument
$representationNodeDOMElement
$representationRepresentation
$pubIdPluginPubIdPlugin
Returns
DOMElement|null

Definition at line 142 of file RepresentationNativeXmlFilter.inc.php.

References NativeImportExportFilter\getDeployment().

Referenced by addIdentifiers().

◆ createRepresentationNode()

RepresentationNativeXmlFilter::createRepresentationNode (   $doc,
  $representation 
)

Create and return a representation node.

Parameters
$docDOMDocument
$representationRepresentation
Returns
DOMElement

Reimplemented in ArticleGalleyNativeXmlFilter.

Definition at line 71 of file RepresentationNativeXmlFilter.inc.php.

References addIdentifiers(), NativeExportFilter\createLocalizedNodes(), NativeImportExportFilter\getDeployment(), and getFiles().

Referenced by process().

◆ getClassName()

RepresentationNativeXmlFilter::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 ArticleGalleyNativeXmlFilter.

Definition at line 35 of file RepresentationNativeXmlFilter.inc.php.

◆ getFiles()

RepresentationNativeXmlFilter::getFiles (   $representation)

Get the submission files associated with this representation

Parameters
$representationRepresentation
Returns
array

Reimplemented in ArticleGalleyNativeXmlFilter.

Definition at line 162 of file RepresentationNativeXmlFilter.inc.php.

Referenced by createRepresentationNode().

◆ process()

& RepresentationNativeXmlFilter::process ( $representation)
See also
Filter::process()
Parameters
$representationRepresentation
Returns
DOMDocument

Reimplemented from Filter.

Definition at line 48 of file RepresentationNativeXmlFilter.inc.php.

References createRepresentationNode(), and NativeImportExportFilter\getDeployment().


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