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

Public Member Functions

 getClassName ()
 
 getImportFilter ($elementName)
 
 handleChildElement ($n, $publication)
 
 handleElement ($node)
 
 parseArticleGalley ($n, $publication)
 
 parseIssueIdentification ($publication, $node)
 
 populateObject ($publication, $node)
 
 populatePublishedPublication ($publication, $node)
 
- Public Member Functions inherited from NativeXmlPKPPublicationFilter
 __construct ($filterGroup)
 
 _getControlledVocabulariesMappings ()
 
 _getLocalizedPublicationFields ()
 
 getPluralElementName ()
 
 getRepresentationExportFilterGroupName ()
 
 getSingularElementName ()
 
 parseAuthor ($n, $publication)
 
 parseAuthors ($node, $publication)
 
 parseCitations ($n, $publication)
 
 parseIdentifier ($element, $publication)
 
- 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

Class that converts a Native XML document to a set of articles.

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

Member Function Documentation

◆ getClassName()

NativeXmlPublicationFilter::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 NativeXmlPKPPublicationFilter.

Definition at line 25 of file NativeXmlPublicationFilter.inc.php.

◆ getImportFilter()

NativeXmlPublicationFilter::getImportFilter (   $elementName)

Get the import filter for a given element.

Parameters
$elementNamestring Name of XML element
Returns
Filter

Reimplemented from NativeXmlPKPPublicationFilter.

Definition at line 114 of file NativeXmlPublicationFilter.inc.php.

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

Referenced by parseArticleGalley().

◆ handleChildElement()

NativeXmlPublicationFilter::handleChildElement (   $n,
  $publication 
)

Handle an element whose parent is the submission element.

Parameters
$nDOMElement
$publicationPublication

Reimplemented from NativeXmlPKPPublicationFilter.

Definition at line 88 of file NativeXmlPublicationFilter.inc.php.

References parseArticleGalley().

◆ handleElement()

NativeXmlPublicationFilter::handleElement (   $node)

Handle an Article import. The Article must have a valid section in order to be imported

Parameters
$nodeDOMElement

Reimplemented from NativeXmlPKPPublicationFilter.

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

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

◆ parseArticleGalley()

NativeXmlPublicationFilter::parseArticleGalley (   $n,
  $publication 
)

Parse an article galley and add it to the publication.

Parameters
$nDOMElement
$publicationPublication

Definition at line 138 of file NativeXmlPublicationFilter.inc.php.

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

Referenced by handleChildElement().

◆ parseIssueIdentification()

NativeXmlPublicationFilter::parseIssueIdentification (   $publication,
  $node 
)

Get the issue from the given identification.

Parameters
$nodeDOMElement
Returns
Issue

Definition at line 184 of file NativeXmlPublicationFilter.inc.php.

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

Referenced by populatePublishedPublication().

◆ populateObject()

NativeXmlPublicationFilter::populateObject (   $publication,
  $node 
)

Populate the submission object from the node, checking first for a valid section and published_date/issue relationship

Parameters
$publicationPublication
$nodeDOMElement
Returns
Publication

Reimplemented from NativeXmlPKPPublicationFilter.

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

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

◆ populatePublishedPublication()

NativeXmlPublicationFilter::populatePublishedPublication (   $publication,
  $node 
)

Class-specific methods for published publication.

Parameters
$publicationPublication
DOMElement$node
Returns
Publication

Definition at line 154 of file NativeXmlPublicationFilter.inc.php.

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

Referenced by populateObject().


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