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

Public Member Functions

 __construct ($filterGroup)
 
 getClassName ()
 
 getImportFilter ($elementName)
 
 getPluralElementName ()
 
 getSingularElementName ()
 
 handleChildElement ($n, $submission)
 
 handleElement ($node)
 
 parseIdentifier ($element, $submission)
 
 parsePublication ($n, $submission)
 
 parseSubmissionFile ($n, $submission)
 
 populateObject ($submission, $node)
 
- 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 submissions.

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

Constructor & Destructor Documentation

◆ __construct()

NativeXmlSubmissionFilter::__construct (   $filterGroup)

Constructor

Parameters
$filterGroupFilterGroup

Reimplemented from NativeImportFilter.

Reimplemented in NativeXmlArticleFilter.

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

References Filter\setDisplayName().

Member Function Documentation

◆ getClassName()

NativeXmlSubmissionFilter::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 NativeXmlArticleFilter.

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

◆ getImportFilter()

NativeXmlSubmissionFilter::getImportFilter (   $elementName)

Get the import filter for a given element.

Parameters
$elementNamestring Name of XML element
Returns
Filter

Reimplemented in NativeXmlArticleFilter.

Definition at line 201 of file NativeXmlSubmissionFilter.inc.php.

Referenced by parsePublication(), and parseSubmissionFile().

◆ getPluralElementName()

NativeXmlSubmissionFilter::getPluralElementName ( )

Return the plural element name

Returns
string

Reimplemented from NativeImportFilter.

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

References NativeImportExportFilter\getDeployment().

◆ getSingularElementName()

NativeXmlSubmissionFilter::getSingularElementName ( )

Get the singular element name

Returns
string

Reimplemented from NativeImportFilter.

Definition at line 56 of file NativeXmlSubmissionFilter.inc.php.

References NativeImportExportFilter\getDeployment().

◆ handleChildElement()

NativeXmlSubmissionFilter::handleChildElement (   $n,
  $submission 
)

Handle an element whose parent is the submission element.

Parameters
$nDOMElement
$submissionSubmission

Reimplemented in NativeXmlArticleFilter.

Definition at line 121 of file NativeXmlSubmissionFilter.inc.php.

References NativeImportExportFilter\getDeployment(), parseIdentifier(), parsePublication(), and parseSubmissionFile().

Referenced by handleElement().

◆ handleElement()

NativeXmlSubmissionFilter::handleElement (   $node)

◆ parseIdentifier()

NativeXmlSubmissionFilter::parseIdentifier (   $element,
  $submission 
)

Parse an identifier node and set up the submission object accordingly

Parameters
$elementDOMElement
$submissionSubmission

Definition at line 151 of file NativeXmlSubmissionFilter.inc.php.

References NativeImportExportFilter\getDeployment().

Referenced by handleChildElement().

◆ parsePublication()

NativeXmlSubmissionFilter::parsePublication (   $n,
  $submission 
)

Parse a submission publication and add it to the submission.

Parameters
$nDOMElement
$submissionSubmission

Definition at line 182 of file NativeXmlSubmissionFilter.inc.php.

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

Referenced by handleChildElement().

◆ parseSubmissionFile()

NativeXmlSubmissionFilter::parseSubmissionFile (   $n,
  $submission 
)

Parse a submission file and add it to the submission.

Parameters
$nDOMElement
$submissionSubmission

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

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

Referenced by NativeXmlArticleFilter\handleChildElement(), and handleChildElement().

◆ populateObject()

NativeXmlSubmissionFilter::populateObject (   $submission,
  $node 
)

Populate the submission object from the node

Parameters
$submissionSubmission
$nodeDOMElement
Returns
Submission

Reimplemented in NativeXmlArticleFilter.

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

References Core\getCurrentDate(), and DAORegistry\getDAO().

Referenced by handleElement().


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