NativeXmlPublicationFilter Class Reference

Inheritance diagram for NativeXmlPublicationFilter:

Public Member Functions
	getClassName ()
	getImportFilter ($elementName)
	getRepresentationExportFilterGroupName ()
	handleChildElement ($n, $publication)
	parseChapter ($n, $publication)
	parseChapters ($node, $publication)
	parsePublicationCover ($filter, $node, $object)
	parsePublicationCovers ($filter, $node, $object)
	parsePublicationFormat ($n, $publication)
	populateObject ($publication, $node)
Public Member Functions inherited from NativeXmlPKPPublicationFilter
	__construct ($filterGroup)
	_getControlledVocabulariesMappings ()
	_getLocalizedPublicationFields ()
	getPluralElementName ()
	getSingularElementName ()
	handleElement ($node)
	parseAuthor ($n, $publication)
	parseAuthors ($node, $publication)
	parseCitations ($n, $publication)
	parseIdentifier ($element, $publication)
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

Class that converts a Native XML document to a set of monographs.

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

Member Function Documentation

getClassName()

NativeXmlPublicationFilter::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 NativeXmlPKPPublicationFilter.

Definition at line 25 of file NativeXmlPublicationFilter.inc.php.

getImportFilter()

NativeXmlPublicationFilter::getImportFilter

(

$elementName

)

Get the import filter for a given element.

Parameters

$elementName

string Name of XML element

Returns

Filter

Reimplemented from NativeXmlPKPPublicationFilter.

Definition at line 81 of file NativeXmlPublicationFilter.inc.php.

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

Referenced by parseChapter(), and parsePublicationFormat().

getRepresentationExportFilterGroupName()

NativeXmlPublicationFilter::getRepresentationExportFilterGroupName

(

)

Get the representation export filter group name

Returns

string

Reimplemented from NativeXmlPKPPublicationFilter.

Definition at line 243 of file NativeXmlPublicationFilter.inc.php.

handleChildElement()

NativeXmlPublicationFilter::handleChildElement	(		$n,
			$publication
	)

Handle an element whose parent is the submission element.

Parameters

$n	DOMElement
$publication	Publication

Reimplemented from NativeXmlPKPPublicationFilter.

Definition at line 60 of file NativeXmlPublicationFilter.inc.php.

References parseChapters(), parsePublicationCovers(), and parsePublicationFormat().

parseChapter()

NativeXmlPublicationFilter::parseChapter	(		$n,
			$publication
	)

Parse a publication format and add it to the submission.

Parameters

$n	DOMElement
$publication	Publication

Definition at line 156 of file NativeXmlPublicationFilter.inc.php.

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

Referenced by parseChapters().

parseChapters()

NativeXmlPublicationFilter::parseChapters	(		$node,
			$publication
	)

Parse a publication format and add it to the submission.

Parameters

$n	DOMElement
$publication	Publication

Definition at line 130 of file NativeXmlPublicationFilter.inc.php.

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

Referenced by handleChildElement().

parsePublicationCover()

NativeXmlPublicationFilter::parsePublicationCover	(		$filter,
			$node,
			$object
	)

Parse out the cover and store it in the object.

Parameters

$filter	NativeExportFilter
$node	DOMElement
$object	Publication

Definition at line 202 of file NativeXmlPublicationFilter.inc.php.

Referenced by parsePublicationCovers().

parsePublicationCovers()

NativeXmlPublicationFilter::parsePublicationCovers	(		$filter,
			$node,
			$object
	)

Parse out the object covers.

Parameters

$filter	NativeExportFilter
$node	DOMElement
$object	Publication

Definition at line 175 of file NativeXmlPublicationFilter.inc.php.

References parsePublicationCover().

Referenced by handleChildElement().

parsePublicationFormat()

NativeXmlPublicationFilter::parsePublicationFormat	(		$n,
			$publication
	)

Parse a publication format and add it to the submission.

Parameters

$n	DOMElement
$publication	Publication

Definition at line 108 of file NativeXmlPublicationFilter.inc.php.

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

Referenced by handleChildElement().

populateObject()

NativeXmlPublicationFilter::populateObject	(		$publication,
			$node
	)

Populate the submission object from the node

Parameters

$publication	Publication
$node	DOMElement

Returns

Publication

Reimplemented from NativeXmlPKPPublicationFilter.

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

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

---

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

• NativeXmlPublicationFilter.inc.php