Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
SubmissionNativeXmlFilter Class Reference
Inheritance diagram for SubmissionNativeXmlFilter:
NativeExportFilter NativeImportExportFilter PersistableFilter Filter DataObject MonographNativeXmlFilter

Public Member Functions

 addAuthors ($doc, $submissionNode, $submission)
 
 addFiles ($doc, $submissionNode, $submission)
 
 addIdentifiers ($doc, $submissionNode, $submission)
 
 addMetadata ($doc, $submissionNode, $submission)
 
 addPubIdentifier ($doc, $submissionNode, $submission, $pubIdPlugin)
 
 addRepresentations ($doc, $submissionNode, $submission)
 
 createSubmissionNode ($doc, $submission)
 
 getClassName ()
 
 getRepresentationExportFilterGroupName ()
 
process (&$submissions)
 
 SubmissionNativeXmlFilter ($filterGroup)
 
- Public Member Functions inherited from NativeExportFilter
 createLocalizedNodes ($doc, $parentNode, $name, $values)
 
 createOptionalNode ($doc, $parentNode, $name, $value)
 
 NativeExportFilter ($filterGroup)
 
- Public Member Functions inherited from NativeImportExportFilter
 getDeployment ()
 
 NativeImportExportFilter ($filterGroup)
 
 setDeployment ($deployment)
 
- Public Member Functions inherited from PersistableFilter
 addSetting (&$setting)
 
 getClassName ()
 
getFilterGroup ()
 
 getInternalSettings ()
 
 getIsTemplate ()
 
 getLocalizedSettingNames ()
 
 getParentFilterId ()
 
getSetting ($settingName)
 
 getSettingNames ()
 
getSettings ()
 
 hasSetting ($settingName)
 
 hasSettings ()
 
 PersistableFilter ($filterGroup)
 
 setIsTemplate ($isTemplate)
 
 setParentFilterId ($parentFilterId)
 
- Public Member Functions inherited from Filter
 addError ($message)
 
 clearErrors ()
 
execute (&$input)
 
 Filter ($inputType, $outputType)
 
 getDisplayName ()
 
 getErrors ()
 
getInputType ()
 
getLastInput ()
 
getLastOutput ()
 
getOutputType ()
 
getRuntimeEnvironment ()
 
 getSeq ()
 
 hasErrors ()
 
 isCompatibleWithRuntimeEnvironment ()
 
process (&$input)
 
 setDisplayName ($displayName)
 
 setRuntimeEnvironment (&$runtimeEnvironment)
 
 setSeq ($seq)
 
 setTransformationType (&$inputType, &$outputType)
 
 supports (&$input, &$output)
 
 supportsAsInput (&$input)
 
- Public Member Functions inherited from DataObject
 addSupportedMetadataAdapter ($metadataAdapter)
 
 DataObject ()
 
 extractMetadata ($metadataSchema)
 
 getAdditionalMetadataFieldNames ()
 
getAllData ()
 
getData ($key, $locale=null)
 
 getHasLoadableAdapters ()
 
 getId ()
 
 getLocaleMetadataFieldNames ()
 
getLocalizedData ($key)
 
 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)
 
 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 ()
 
- Public Attributes inherited from PersistableFilter
 $_settings = array()
 
- Public Attributes inherited from Filter
 $_errors = array()
 
 $_runtimeEnvironment = false
 
- Public Attributes inherited from DataObject
 $_data = array()
 
 $_extractionAdaptersLoaded = false
 
 $_hasLoadableAdapters = false
 
 $_injectionAdaptersLoaded = false
 
 $_metadataExtractionAdapters = array()
 
 $_metadataInjectionAdapters = array()
 

Detailed Description

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

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

Member Function Documentation

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

Add the author metadata for a submission to its DOM element.

Parameters
$docDOMDocument
$submissionNodeDOMElement
$submissionSubmission

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

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

Referenced by createSubmissionNode().

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

Add the submission files to its DOM element.

Parameters
$docDOMDocument
$submissionNodeDOMElement
$submissionSubmission

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

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

Referenced by createSubmissionNode().

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

Create and add identifier nodes to a submission node.

Parameters
$docDOMDocument
$submissionNodeDOMElement
$submissionSubmission

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

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

Referenced by createSubmissionNode().

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

Add the submission metadata for a submission to its DOM element.

Parameters
$docDOMDocument
$submissionNodeDOMElement
$submissionSubmission

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

References NativeExportFilter\createLocalizedNodes(), and NativeExportFilter\createOptionalNode().

Referenced by createSubmissionNode().

SubmissionNativeXmlFilter::addPubIdentifier (   $doc,
  $submissionNode,
  $submission,
  $pubIdPlugin 
)

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

Parameters
$docDOMDocument
$submissionNodeDOMElement
$submissionSubmission
$pubIdPluginPubIdPlugin
Returns
DOMElement|null

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

Referenced by addIdentifiers().

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

Add the representations of a submission to its DOM element.

Parameters
$docDOMDocument
$submissionNodeDOMElement
$submissionSubmission

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

References DAORegistry\getDAO(), NativeImportExportFilter\getDeployment(), Application\getRepresentationDAO(), and getRepresentationExportFilterGroupName().

Referenced by createSubmissionNode().

SubmissionNativeXmlFilter::createSubmissionNode (   $doc,
  $submission 
)

Create and return a submission node.

Parameters
$docDOMDocument
$submissionSubmission
Returns
DOMElement

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

References addAuthors(), addFiles(), addIdentifiers(), addMetadata(), addRepresentations(), and NativeImportExportFilter\getDeployment().

Referenced by process().

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.)

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

SubmissionNativeXmlFilter::getRepresentationExportFilterGroupName ( )

Get the representation export filter group name

Returns
string

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

Referenced by addRepresentations().

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

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

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

SubmissionNativeXmlFilter::SubmissionNativeXmlFilter (   $filterGroup)

Constructor

Parameters
$filterGroupFilterGroup

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

References Filter\setDisplayName().


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