Open Journal Systems  3.3.0
SupplementaryFileNativeXmlFilter Class Reference
Inheritance diagram for SupplementaryFileNativeXmlFilter:
SubmissionFileNativeXmlFilter NativeExportFilter NativeImportExportFilter PersistableFilter Filter DataObject

Public Member Functions

 __construct ($filterGroup)
 
 createSubmissionFileNode ($doc, $submissionFile)
 
 getClassName ()
 
 getSubmissionFileElementName ()
 
- Public Member Functions inherited from SubmissionFileNativeXmlFilter
 addIdentifiers ($doc, $revisionNode, $submissionFile)
 
 addPubIdentifier ($doc, $revisionNode, $submissionFile, $pubIdPlugin)
 
process (&$submissionFile)
 
- 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)
 

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

Detailed Description

Filter to convert a supplementary file to a Native XML document.

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

Constructor & Destructor Documentation

◆ __construct()

SupplementaryFileNativeXmlFilter::__construct (   $filterGroup)

Constructor

Parameters
$filterGroupFilterGroup

Reimplemented from SubmissionFileNativeXmlFilter.

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

Member Function Documentation

◆ createSubmissionFileNode()

SupplementaryFileNativeXmlFilter::createSubmissionFileNode (   $doc,
  $submissionFile 
)

Create and return a submissionFile node.

Parameters
$docDOMDocument
$submissionFileSubmissionFile
Returns
DOMElement

Reimplemented from SubmissionFileNativeXmlFilter.

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

References NativeExportFilter\createLocalizedNodes(), and NativeImportExportFilter\getDeployment().

◆ getClassName()

SupplementaryFileNativeXmlFilter::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 SubmissionFileNativeXmlFilter.

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

◆ getSubmissionFileElementName()

SupplementaryFileNativeXmlFilter::getSubmissionFileElementName ( )

Get the submission file element name

Reimplemented from SubmissionFileNativeXmlFilter.

Definition at line 69 of file SupplementaryFileNativeXmlFilter.inc.php.


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