Inheritance diagram for SubmissionFileNativeXmlFilter:

Public Member Functions
	__construct ($filterGroup)

	addIdentifiers ($doc, $revisionNode, $submissionFile)

	addPubIdentifier ($doc, $revisionNode, $submissionFile, $pubIdPlugin)

	createSubmissionFileNode ($doc, $submissionFile)

	getClassName ()

	getSubmissionFileElementName ()

&	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

Base class that converts a submissionFile to a Native XML document.

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

Constructor & Destructor Documentation

◆ __construct()

SubmissionFileNativeXmlFilter::__construct ( $filterGroup )

Constructor

Parameters

$filterGroup FilterGroup

Reimplemented from NativeExportFilter.

Reimplemented in ArtworkFileNativeXmlFilter, and SupplementaryFileNativeXmlFilter.

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

References Filter\setDisplayName().

Member Function Documentation

◆ addIdentifiers()

SubmissionFileNativeXmlFilter::addIdentifiers	(	$doc,
		$revisionNode,
		$submissionFile
	)

Create and add identifier nodes to a submission node.

Parameters

$doc	DOMDocument
$revisionNode	DOMElement
$submissionFile	SubmissionFile

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

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

Referenced by createSubmissionFileNode().

◆ addPubIdentifier()

SubmissionFileNativeXmlFilter::addPubIdentifier	(	$doc,
		$revisionNode,
		$submissionFile,
		$pubIdPlugin
	)

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

Parameters

$doc	DOMDocument
$revisionNode	DOMElement
$submissionFile	SubmissionFile
$pubIdPlugin	PubIdPlugin

Returns: DOMElement|null

Definition at line 184 of file SubmissionFileNativeXmlFilter.inc.php.

References NativeImportExportFilter\getDeployment().

Referenced by addIdentifiers().

◆ createSubmissionFileNode()

SubmissionFileNativeXmlFilter::createSubmissionFileNode	(	$doc,
		$submissionFile
	)

Create and return a submissionFile node.

Parameters

$doc	DOMDocument
$submissionFile	SubmissionFile

Returns: DOMElement

Reimplemented in ArtworkFileNativeXmlFilter, and SupplementaryFileNativeXmlFilter.

Definition at line 70 of file SubmissionFileNativeXmlFilter.inc.php.

References addIdentifiers(), NativeExportFilter\createLocalizedNodes(), PKPApplication\getApplication(), DAORegistry\getDAO(), and NativeImportExportFilter\getDeployment().

Referenced by process().

◆ getClassName()

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

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