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

Public Member Functions

 __construct ($filterGroup)
 
 addArticles ($doc, $issueNode, $issue)
 
 addDates ($doc, $issueNode, $issue)
 
 addIdentifiers ($doc, $issueNode, $issue)
 
 addIssueGalleys ($doc, $issueNode, $issue)
 
 addPubIdentifier ($doc, $issueNode, $issue, $pubIdPlugin)
 
 addSections ($doc, $issueNode, $issue)
 
 createIssueNode ($doc, $issue)
 
 getClassName ()
 
process (&$issues)
 
- 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 issues to a Native XML document.

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

Constructor & Destructor Documentation

◆ __construct()

IssueNativeXmlFilter::__construct (   $filterGroup)

Constructor

Parameters
$filterGroupFilterGroup

Reimplemented from NativeExportFilter.

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

References Filter\setDisplayName().

Member Function Documentation

◆ addArticles()

IssueNativeXmlFilter::addArticles (   $doc,
  $issueNode,
  $issue 
)

Create and add articles to an issue node.

Parameters
$docDOMDocument
$issueNodeDOMElement
$issueIssue

Definition at line 189 of file IssueNativeXmlFilter.inc.php.

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

Referenced by createIssueNode().

◆ addDates()

IssueNativeXmlFilter::addDates (   $doc,
  $issueNode,
  $issue 
)

Create and add various date nodes to an issue node.

Parameters
$docDOMDocument
$issueNodeDOMElement
$issueIssue

Definition at line 167 of file IssueNativeXmlFilter.inc.php.

References NativeImportExportFilter\getDeployment().

Referenced by createIssueNode().

◆ addIdentifiers()

IssueNativeXmlFilter::addIdentifiers (   $doc,
  $issueNode,
  $issue 
)

Create and add identifier nodes to an issue node.

Parameters
$docDOMDocument
$issueNodeDOMElement
$issueIssue

Definition at line 119 of file IssueNativeXmlFilter.inc.php.

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

Referenced by createIssueNode().

◆ addIssueGalleys()

IssueNativeXmlFilter::addIssueGalleys (   $doc,
  $issueNode,
  $issue 
)

Create and add issue galleys to an issue node.

Parameters
$docDOMDocument
$issueNodeDOMElement
$issueIssue

Definition at line 216 of file IssueNativeXmlFilter.inc.php.

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

Referenced by createIssueNode().

◆ addPubIdentifier()

IssueNativeXmlFilter::addPubIdentifier (   $doc,
  $issueNode,
  $issue,
  $pubIdPlugin 
)

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

Parameters
$docDOMDocument
$issueNodeDOMElement
$issueIssue
$pubIdPluginPubIdPlugin
Returns
DOMElement|null

Definition at line 149 of file IssueNativeXmlFilter.inc.php.

References NativeImportExportFilter\getDeployment().

Referenced by addIdentifiers().

◆ addSections()

IssueNativeXmlFilter::addSections (   $doc,
  $issueNode,
  $issue 
)

Add the sections to the Issue DOM element.

Parameters
$docDOMDocument
$issueNodeDOMElement
$issueIssue

Definition at line 238 of file IssueNativeXmlFilter.inc.php.

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

Referenced by createIssueNode().

◆ createIssueNode()

IssueNativeXmlFilter::createIssueNode (   $doc,
  $issue 
)

Create and return an issue node.

Parameters
$docDOMDocument
$issueIssue
Returns
DOMElement

Definition at line 81 of file IssueNativeXmlFilter.inc.php.

References addArticles(), addDates(), addIdentifiers(), addIssueGalleys(), addSections(), NativeExportFilter\createLocalizedNodes(), and NativeImportExportFilter\getDeployment().

Referenced by process().

◆ getClassName()

IssueNativeXmlFilter::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 IssueNativeXmlFilter.inc.php.

◆ process()

& IssueNativeXmlFilter::process ( $issues)
See also
Filter::process()
Parameters
$issuesarray Array of issues
Returns
DOMDocument

Reimplemented from Filter.

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

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


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