Open Journal Systems  3.3.0
NativeXmlSubmissionFileFilter Class Reference
Inheritance diagram for NativeXmlSubmissionFileFilter:
NativeImportFilter NativeImportExportFilter PersistableFilter Filter DataObject NativeXmlArticleFileFilter NativeXmlArtworkFileFilter NativeXmlSupplementaryFileFilter

Public Member Functions

 __construct ($filterGroup)
 
 getClassName ()
 
 getPluralElementName ()
 
 getSingularElementName ()
 
 handleChildElement ($node, $stageId, $fileId, &$submissionFiles)
 
 handleElement ($node)
 
 handleRevisionChildElement ($node, $submission, $submissionFile)
 
 handleRevisionElement ($node, $stageId, $fileId)
 
 instantiateSubmissionFile ($tagName)
 
 parseIdentifier ($element, $submissionFile)
 
- 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 submission file.

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

Constructor & Destructor Documentation

◆ __construct()

NativeXmlSubmissionFileFilter::__construct (   $filterGroup)

Constructor

Parameters
$filterGroupFilterGroup

Reimplemented from NativeImportFilter.

Reimplemented in NativeXmlArticleFileFilter, NativeXmlArtworkFileFilter, and NativeXmlSupplementaryFileFilter.

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

References Filter\setDisplayName().

Member Function Documentation

◆ getClassName()

NativeXmlSubmissionFileFilter::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 NativeXmlArticleFileFilter, NativeXmlArtworkFileFilter, and NativeXmlSupplementaryFileFilter.

Definition at line 53 of file NativeXmlSubmissionFileFilter.inc.php.

◆ getPluralElementName()

NativeXmlSubmissionFileFilter::getPluralElementName ( )

Return the plural element name

Returns
string

Reimplemented from NativeImportFilter.

Reimplemented in NativeXmlArtworkFileFilter, and NativeXmlSupplementaryFileFilter.

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

◆ getSingularElementName()

NativeXmlSubmissionFileFilter::getSingularElementName ( )

Get the singular element name

Returns
string

Reimplemented from NativeImportFilter.

Reimplemented in NativeXmlArtworkFileFilter, and NativeXmlSupplementaryFileFilter.

Definition at line 43 of file NativeXmlSubmissionFileFilter.inc.php.

◆ handleChildElement()

NativeXmlSubmissionFileFilter::handleChildElement (   $node,
  $stageId,
  $fileId,
$submissionFiles 
)

Handle a child node of the submission file element; add new files, if any, to $submissionFiles

Parameters
$nodeDOMElement
$stageIdint SUBMISSION_FILE_...
$fileIdint File id
$submissionFilesarray

Reimplemented in NativeXmlArtworkFileFilter, and NativeXmlSupplementaryFileFilter.

Definition at line 90 of file NativeXmlSubmissionFileFilter.inc.php.

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

Referenced by handleElement().

◆ handleElement()

NativeXmlSubmissionFileFilter::handleElement (   $node)

Handle a submission file element

Parameters
$nodeDOMElement
Returns
array Array of SubmissionFile objects

Reimplemented from NativeImportFilter.

Definition at line 63 of file NativeXmlSubmissionFileFilter.inc.php.

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

◆ handleRevisionChildElement()

NativeXmlSubmissionFileFilter::handleRevisionChildElement (   $node,
  $submission,
  $submissionFile 
)

Handle a child of the revision element

Parameters
$nodeDOMElement
$submissionSubmission
$submissionFileSubmissionFile
Returns
string Filename for temporary file, if one was created

Definition at line 251 of file NativeXmlSubmissionFileFilter.inc.php.

References PKPApplication\get(), NativeImportExportFilter\getDeployment(), and parseIdentifier().

Referenced by handleRevisionElement().

◆ handleRevisionElement()

NativeXmlSubmissionFileFilter::handleRevisionElement (   $node,
  $stageId,
  $fileId 
)

Handle a revision element

Parameters
$nodeDOMElement
$stageIdint SUBMISSION_FILE_...
$fileIdint File id

Definition at line 109 of file NativeXmlSubmissionFileFilter.inc.php.

References Core\getCurrentDate(), DAORegistry\getDAO(), NativeImportExportFilter\getDeployment(), and handleRevisionChildElement().

Referenced by handleChildElement().

◆ instantiateSubmissionFile()

NativeXmlSubmissionFileFilter::instantiateSubmissionFile (   $tagName)

Instantiate a submission file.

Parameters
$tagNamestring
Returns
SubmissionFile

Definition at line 374 of file NativeXmlSubmissionFileFilter.inc.php.

◆ parseIdentifier()

NativeXmlSubmissionFileFilter::parseIdentifier (   $element,
  $submissionFile 
)

Parse an identifier node and set up the representation object accordingly

Parameters
$elementDOMElement
$submissionFileSubmissionFile

Definition at line 347 of file NativeXmlSubmissionFileFilter.inc.php.

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

Referenced by handleRevisionChildElement().


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