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

Public Member Functions

 __construct ($filterGroup)
 
 _getDateIssueSetterMappings ()
 
 _getLocalizedIssueSetterMappings ()
 
 _issueExists ($node)
 
 _sectionExist ($importSection)
 
 getClassName ()
 
 getPluralElementName ()
 
 getSingularElementName ()
 
 handleChildElement ($n, $issue, $processOnlyChildren)
 
 handleElement ($node)
 
 parseArticle ($n, $issue)
 
 parseArticles ($node, $issue)
 
 parseIdentifier ($element, $issue)
 
 parseIssueGalley ($n, $issue)
 
 parseIssueGalleys ($node, $issue)
 
 parseIssueIdentification ($node, $issue, $allowWarnings=true)
 
 parseSection ($node)
 
 parseSections ($node, $issue)
 
- Public Member Functions inherited from NativeImportFilter
 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 issues.

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

Constructor & Destructor Documentation

◆ __construct()

NativeXmlIssueFilter::__construct (   $filterGroup)

Constructor

Parameters
$filterGroupFilterGroup

Reimplemented from NativeImportFilter.

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

References Filter\setDisplayName().

Member Function Documentation

◆ _getDateIssueSetterMappings()

NativeXmlIssueFilter::_getDateIssueSetterMappings ( )

Get node name to setter function mapping for issue date fields.

Returns
array

Definition at line 402 of file NativeXmlIssueFilter.inc.php.

Referenced by handleChildElement().

◆ _getLocalizedIssueSetterMappings()

NativeXmlIssueFilter::_getLocalizedIssueSetterMappings ( )

Get node name to setter function mapping for localized data.

Returns
array

Definition at line 392 of file NativeXmlIssueFilter.inc.php.

Referenced by handleChildElement().

◆ _issueExists()

NativeXmlIssueFilter::_issueExists (   $node)

Check if the issue already exists.

Parameters
$nodeDOMNode issue node return Issue|null matching issue, or null if no match

Definition at line 416 of file NativeXmlIssueFilter.inc.php.

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

Referenced by handleElement().

◆ _sectionExist()

NativeXmlIssueFilter::_sectionExist (   $importSection)

Check if the section already exists.

Parameters
$importSectionSection New created section
Returns
boolean

Definition at line 437 of file NativeXmlIssueFilter.inc.php.

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

Referenced by parseSection().

◆ getClassName()

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

◆ getPluralElementName()

NativeXmlIssueFilter::getPluralElementName ( )

Return the plural element name

Returns
string

Reimplemented from NativeImportFilter.

Definition at line 47 of file NativeXmlIssueFilter.inc.php.

◆ getSingularElementName()

NativeXmlIssueFilter::getSingularElementName ( )

Get the singular element name

Returns
string

Reimplemented from NativeImportFilter.

Definition at line 55 of file NativeXmlIssueFilter.inc.php.

◆ handleChildElement()

NativeXmlIssueFilter::handleChildElement (   $n,
  $issue,
  $processOnlyChildren 
)

Handle an element whose parent is the issue element.

Parameters
$nDOMElement
$issueIssue
$processOnlyChildrenboolean Do not modify the issue itself, only generate child objects

Definition at line 105 of file NativeXmlIssueFilter.inc.php.

References _getDateIssueSetterMappings(), _getLocalizedIssueSetterMappings(), NativeImportExportFilter\getDeployment(), parseArticles(), parseIdentifier(), parseIssueGalleys(), parseIssueIdentification(), NativeImportFilter\parseLocalizedContent(), and parseSections().

Referenced by handleElement().

◆ handleElement()

NativeXmlIssueFilter::handleElement (   $node)

Handle a singular element import.

Parameters
$nodeDOMElement
Returns
Issue

Reimplemented from NativeImportFilter.

Definition at line 64 of file NativeXmlIssueFilter.inc.php.

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

◆ parseArticle()

NativeXmlIssueFilter::parseArticle (   $n,
  $issue 
)

Parse an article and add it to the issue.

Parameters
$nDOMElement
$issueIssue

Definition at line 252 of file NativeXmlIssueFilter.inc.php.

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

Referenced by parseArticles().

◆ parseArticles()

NativeXmlIssueFilter::parseArticles (   $node,
  $issue 
)

Parse an articles element

Parameters
$nodeDOMElement
$issueIssue

Definition at line 232 of file NativeXmlIssueFilter.inc.php.

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

Referenced by handleChildElement().

◆ parseIdentifier()

NativeXmlIssueFilter::parseIdentifier (   $element,
  $issue 
)

Parse an identifier node and set up the issue object accordingly

Parameters
$elementDOMElement
$issueIssue

Definition at line 169 of file NativeXmlIssueFilter.inc.php.

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

Referenced by handleChildElement().

◆ parseIssueGalley()

NativeXmlIssueFilter::parseIssueGalley (   $n,
  $issue 
)

Parse an issue galley and add it to the issue.

Parameters
$nDOMElement
$issueIssue

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

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

Referenced by parseIssueGalleys().

◆ parseIssueGalleys()

NativeXmlIssueFilter::parseIssueGalleys (   $node,
  $issue 
)

Parse an articles element

Parameters
$nodeDOMElement
$issueIssue

Definition at line 196 of file NativeXmlIssueFilter.inc.php.

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

Referenced by handleChildElement().

◆ parseIssueIdentification()

NativeXmlIssueFilter::parseIssueIdentification (   $node,
  $issue,
  $allowWarnings = true 
)

Parse out the issue identification and store it in an issue.

Parameters
$nodeDOMElement
$issueIssue
$allowWarningsboolean Warnings should be suppressed if this function is not being used to populate a new issue

Definition at line 352 of file NativeXmlIssueFilter.inc.php.

References NativeImportExportFilter\getDeployment(), and NativeImportFilter\parseLocalizedContent().

Referenced by _issueExists(), and handleChildElement().

◆ parseSection()

NativeXmlIssueFilter::parseSection (   $node)

Parse a section stored in an issue.

Parameters
$nodeDOMElement

Definition at line 287 of file NativeXmlIssueFilter.inc.php.

References _sectionExist(), DAORegistry\getDAO(), NativeImportExportFilter\getDeployment(), and NativeImportFilter\parseLocalizedContent().

Referenced by parseSections().

◆ parseSections()

NativeXmlIssueFilter::parseSections (   $node,
  $issue 
)

Parse a submission file and add it to the submission.

Parameters
$nodeDOMElement
$issueIssue

Definition at line 268 of file NativeXmlIssueFilter.inc.php.

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

Referenced by handleChildElement().


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