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

Public Member Functions

 __construct ($filterGroup)
 
 addControlledVocabulary ($doc, $submissionNode, $controlledVocabulariesNodeName, $controlledVocabularyNodeName, $controlledVocabulary)
 
 addFiles ($doc, $submissionNode, $submission)
 
 addIdentifiers ($doc, $submissionNode, $submission)
 
 addPublications ($doc, $submissionNode, $submission)
 
 createSubmissionNode ($doc, $submission)
 
 getClassName ()
 
 getIncludeSubmissionsNode ()
 
process (&$submissions)
 
 setIncludeSubmissionsNode ($includeSubmissionsNode)
 
- 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)
 

Data Fields

 $_includeSubmissionsNode
 
- 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()
 

Additional Inherited Members

- Static Public Member Functions inherited from PersistableFilter
static tempGroup ($inputType, $outputType)
 
- Static Public Member Functions inherited from Filter
static supportedRuntimeEnvironmentSettings ()
 

Detailed Description

Base class that converts a set of submissions to a Native XML document.

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

Constructor & Destructor Documentation

◆ __construct()

SubmissionNativeXmlFilter::__construct (   $filterGroup)

Constructor

Parameters
$filterGroupFilterGroup

Reimplemented from NativeExportFilter.

Reimplemented in ArticleNativeXmlFilter.

Definition at line 26 of file SubmissionNativeXmlFilter.inc.php.

References Filter\setDisplayName().

Member Function Documentation

◆ addControlledVocabulary()

SubmissionNativeXmlFilter::addControlledVocabulary (   $doc,
  $submissionNode,
  $controlledVocabulariesNodeName,
  $controlledVocabularyNodeName,
  $controlledVocabulary 
)

Add submission controlled vocabulary to its DOM element.

Parameters
$docDOMDocument
$submissionNodeDOMElement
$controlledVocabulariesNodeNamestring Parent node name
$controlledVocabularyNodeNamestring Item node name
$controlledVocabularyarray Associative array (locale => array of items)

Definition at line 136 of file SubmissionNativeXmlFilter.inc.php.

References NativeImportExportFilter\getDeployment().

◆ addFiles()

SubmissionNativeXmlFilter::addFiles (   $doc,
  $submissionNode,
  $submission 
)

Add the submission files to its DOM element.

Parameters
$docDOMDocument
$submissionNodeDOMElement
$submissionSubmission

Definition at line 157 of file SubmissionNativeXmlFilter.inc.php.

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

Referenced by createSubmissionNode().

◆ addIdentifiers()

SubmissionNativeXmlFilter::addIdentifiers (   $doc,
  $submissionNode,
  $submission 
)

Create and add identifier nodes to a submission node.

Parameters
$docDOMDocument
$submissionNodeDOMElement
$submissionSubmission

Definition at line 113 of file SubmissionNativeXmlFilter.inc.php.

References NativeImportExportFilter\getDeployment().

Referenced by createSubmissionNode().

◆ addPublications()

SubmissionNativeXmlFilter::addPublications (   $doc,
  $submissionNode,
  $submission 
)

Add the submission files to its DOM element.

Parameters
$docDOMDocument
$submissionNodeDOMElement
$submissionSubmission

Definition at line 208 of file SubmissionNativeXmlFilter.inc.php.

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

Referenced by createSubmissionNode().

◆ createSubmissionNode()

SubmissionNativeXmlFilter::createSubmissionNode (   $doc,
  $submission 
)

Create and return a submission node.

Parameters
$docDOMDocument
$submissionSubmission
Returns
DOMElement

Reimplemented in ArticleNativeXmlFilter.

Definition at line 84 of file SubmissionNativeXmlFilter.inc.php.

References addFiles(), addIdentifiers(), addPublications(), DAORegistry\getDAO(), NativeImportExportFilter\getDeployment(), and WorkflowStageDAO\getPathFromId().

Referenced by process().

◆ getClassName()

SubmissionNativeXmlFilter::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 ArticleNativeXmlFilter.

Definition at line 38 of file SubmissionNativeXmlFilter.inc.php.

◆ getIncludeSubmissionsNode()

SubmissionNativeXmlFilter::getIncludeSubmissionsNode ( )

Returnes whether to always include the <submissions> node, even if there may only be one submission.

Returns
boolean $includeSubmissionsNode

Definition at line 244 of file SubmissionNativeXmlFilter.inc.php.

References $_includeSubmissionsNode.

Referenced by process().

◆ process()

& SubmissionNativeXmlFilter::process ( $submissions)
See also
Filter::process()
Parameters
$submissionsarray Array of submissions
Returns
DOMDocument

Reimplemented from Filter.

Definition at line 51 of file SubmissionNativeXmlFilter.inc.php.

References createSubmissionNode(), NativeImportExportFilter\getDeployment(), and getIncludeSubmissionsNode().

◆ setIncludeSubmissionsNode()

SubmissionNativeXmlFilter::setIncludeSubmissionsNode (   $includeSubmissionsNode)

Sets a flag to always include the <submissions> node, even if there may only be one submission.

Parameters
boolean$includeSubmissionsNode

Definition at line 235 of file SubmissionNativeXmlFilter.inc.php.

Field Documentation

◆ $_includeSubmissionsNode

SubmissionNativeXmlFilter::$_includeSubmissionsNode

Definition at line 20 of file SubmissionNativeXmlFilter.inc.php.

Referenced by getIncludeSubmissionsNode().


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