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

Public Member Functions

 __construct ($filterGroup)
 
 addFile ($doc, $issueGalleyNode, $issueGalley)
 
 addIdentifiers ($doc, $issueGalleyNode, $issueGalley)
 
 createIssueGalleyNode ($doc, $issueGalley)
 
 getClassName ()
 
process (&$issueGalleys)
 
- 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 set of issue galleys to a Native XML document.

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

Constructor & Destructor Documentation

◆ __construct()

IssueGalleyNativeXmlFilter::__construct (   $filterGroup)

Constructor

Parameters
$filterGroupFilterGroup

Reimplemented from NativeExportFilter.

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

References Filter\setDisplayName().

Member Function Documentation

◆ addFile()

IssueGalleyNativeXmlFilter::addFile (   $doc,
  $issueGalleyNode,
  $issueGalley 
)

Add the issue file to its DOM element.

Parameters
$docDOMDocument
$issueGalleyNodeDOMElement
$issueGalleyIssueGalley

Definition at line 96 of file IssueGalleyNativeXmlFilter.inc.php.

References DAORegistry\getDAO(), and NativeImportExportFilter\getDeployment().

Referenced by createIssueGalleyNode().

◆ addIdentifiers()

IssueGalleyNativeXmlFilter::addIdentifiers (   $doc,
  $issueGalleyNode,
  $issueGalley 
)

Create and add identifier nodes to an issue galley node.

Parameters
$docDOMDocument
$issueGalleyNodeDOMElement
$issueGalleyIssueGalley

Definition at line 129 of file IssueGalleyNativeXmlFilter.inc.php.

References NativeImportExportFilter\getDeployment().

Referenced by createIssueGalleyNode().

◆ createIssueGalleyNode()

IssueGalleyNativeXmlFilter::createIssueGalleyNode (   $doc,
  $issueGalley 
)

Create and return an issueGalley node.

Parameters
$docDOMDocument
$issueGalleyIssueGalley
Returns
DOMElement

Definition at line 76 of file IssueGalleyNativeXmlFilter.inc.php.

References addFile(), addIdentifiers(), and NativeImportExportFilter\getDeployment().

Referenced by process().

◆ getClassName()

IssueGalleyNativeXmlFilter::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.

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

◆ process()

& IssueGalleyNativeXmlFilter::process ( $issueGalleys)
See also
Filter::process()
Parameters
$issueGalleysarray Array of issue galleys
Returns
DOMDocument

Reimplemented from Filter.

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

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


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