Inheritance diagram for PKPPublicationNativeXmlFilter:

Public Member Functions
	__construct ($filterGroup)

	_getControlledVocabulariesMappings ()

	addAuthors ($doc, $entityNode, $entity)

	addControlledVocabulary ($doc, $entityNode, $controlledVocabulariesNodeName, $controlledVocabularyNodeName, $controlledVocabulary)

	addIdentifiers ($doc, $entityNode, $entity)

	addMetadata ($doc, $entityNode, $entity)

	addPubIdentifier ($doc, $entityNode, $entity, $pubIdPlugin)

	addRepresentations ($doc, $entityNode, $entity)

	createEntityNode ($doc, $entity)

	getClassName ()

	getFiles ($representation)

&	process (&$entity)

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 PKPPublication to a Native XML document.

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

Constructor & Destructor Documentation

◆ __construct()

PKPPublicationNativeXmlFilter::__construct ( $filterGroup )

Constructor

Parameters

$filterGroup FilterGroup

Reimplemented from NativeExportFilter.

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

References Filter\setDisplayName().

Member Function Documentation

◆ _getControlledVocabulariesMappings()

PKPPublicationNativeXmlFilter::_getControlledVocabulariesMappings ( )

Get controlled vocabularies parent node name to DAO, get function and item node name mapping.

Returns: array

Definition at line 262 of file PKPPublicationNativeXmlFilter.inc.php.

Referenced by addMetadata().

◆ addAuthors()

PKPPublicationNativeXmlFilter::addAuthors	(	$doc,
		$entityNode,
		$entity
	)

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

Parameters

$doc	DOMDocument
$entityNode	DOMElement
$entity	PKPPublication

Definition at line 221 of file PKPPublicationNativeXmlFilter.inc.php.

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

Referenced by createEntityNode().

◆ addControlledVocabulary()

PKPPublicationNativeXmlFilter::addControlledVocabulary	(	$doc,
		$entityNode,
		$controlledVocabulariesNodeName,
		$controlledVocabularyNodeName,
		$controlledVocabulary
	)

Add publication's controlled vocabulary to its DOM element.

Parameters

$doc	DOMDocument
$entityNode	DOMElement
$controlledVocabulariesNodeName	string Parent node name
$controlledVocabularyNodeName	string Item node name
$controlledVocabulary	array Associative array (locale => array of items)

Definition at line 199 of file PKPPublicationNativeXmlFilter.inc.php.

References NativeImportExportFilter\getDeployment().

Referenced by addMetadata().

◆ addIdentifiers()

PKPPublicationNativeXmlFilter::addIdentifiers	(	$doc,
		$entityNode,
		$entity
	)

Create and add identifier nodes to a submission node.

Parameters

$doc	DOMDocument
$entityNode	DOMElement
$entity	PKPPublication

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

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

Referenced by createEntityNode().

◆ addMetadata()

PKPPublicationNativeXmlFilter::addMetadata	(	$doc,
		$entityNode,
		$entity
	)

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

Parameters

$doc	DOMDocument
$entityNode	DOMElement
$entity	PKPPublication

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

References _getControlledVocabulariesMappings(), addControlledVocabulary(), NativeExportFilter\createLocalizedNodes(), DAORegistry\getDAO(), NativeImportExportFilter\getDeployment(), and AppLocale\getSupportedFormLocales().

Referenced by createEntityNode().

◆ addPubIdentifier()

PKPPublicationNativeXmlFilter::addPubIdentifier	(	$doc,
		$entityNode,
		$entity,
		$pubIdPlugin
	)

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

Parameters

$doc	DOMDocument
$entityNode	DOMElement
$entity	PKPPublication
$pubIdPlugin	PubIdPlugin

Returns: DOMElement|null

Definition at line 139 of file PKPPublicationNativeXmlFilter.inc.php.

References NativeImportExportFilter\getDeployment().

Referenced by addIdentifiers().

◆ addRepresentations()

PKPPublicationNativeXmlFilter::addRepresentations	(	$doc,
		$entityNode,
		$entity
	)

Add the representations of a publication to its DOM element.

Parameters

$doc	DOMDocument
$entityNode	DOMElement
$entity	Publication

Definition at line 242 of file PKPPublicationNativeXmlFilter.inc.php.

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

Referenced by createEntityNode().

◆ createEntityNode()

PKPPublicationNativeXmlFilter::createEntityNode	(	$doc,
		$entity
	)

Create and return an entity node.

Parameters

$doc	DOMDocument
$entity	PKPPublication

Returns: DOMElement

Reimplemented in PublicationNativeXmlFilter.

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

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

Referenced by process().

◆ getClassName()

PKPPublicationNativeXmlFilter::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 PublicationNativeXmlFilter.

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