NativeImportFilter Class Reference

Inheritance diagram for NativeImportFilter:

Public Member Functions
	__construct ($filterGroup)
	getPluralElementName ()
	getSingularElementName ()
	handleElement ($node)
	parseLocalizedContent ($element)
&	process (&$document)
Public Member Functions inherited from NativeImportExportFilter
	getDeployment ()
	setDeployment ($deployment)
Public Member Functions inherited from PersistableFilter
	addSetting ($setting)
	getClassName ()
	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 DataObject.

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

Constructor & Destructor Documentation

__construct()

NativeImportFilter::__construct

(

$filterGroup

)

Constructor

Parameters

$filterGroup

FilterGroup

Reimplemented from NativeImportExportFilter.

Reimplemented in NativeXmlPKPAuthorFilter, NativeXmlPKPPublicationFilter, NativeXmlRepresentationFilter, NativeXmlSubmissionFileFilter, NativeXmlSubmissionFilter, NativeXmlUserGroupFilter, UserXmlPKPUserFilter, NativeXmlArticleFileFilter, NativeXmlArticleFilter, NativeXmlArticleGalleyFilter, NativeXmlArtworkFileFilter, NativeXmlAuthorFilter, NativeXmlIssueFilter, NativeXmlIssueGalleyFilter, and NativeXmlSupplementaryFileFilter.

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

Member Function Documentation

getPluralElementName()

NativeImportFilter::getPluralElementName

(

)

Return the plural element name

Returns

string

Reimplemented in NativeXmlPKPPublicationFilter, NativeXmlSubmissionFilter, NativeXmlIssueFilter, NativeXmlArtworkFileFilter, NativeXmlIssueGalleyFilter, NativeXmlSupplementaryFileFilter, NativeXmlPKPAuthorFilter, NativeXmlSubmissionFileFilter, NativeXmlUserGroupFilter, UserXmlPKPUserFilter, and NativeXmlArticleGalleyFilter.

Definition at line 73 of file NativeImportFilter.inc.php.

getSingularElementName()

NativeImportFilter::getSingularElementName

(

)

Get the singular element name

Returns

string

Reimplemented in NativeXmlSubmissionFilter, NativeXmlPKPPublicationFilter, NativeXmlIssueFilter, NativeXmlArtworkFileFilter, NativeXmlIssueGalleyFilter, NativeXmlSupplementaryFileFilter, NativeXmlPKPAuthorFilter, NativeXmlSubmissionFileFilter, NativeXmlUserGroupFilter, and NativeXmlArticleGalleyFilter.

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

handleElement()

NativeImportFilter::handleElement

(

$node

)

Handle a singular element import

Parameters

$node

DOMElement

Reimplemented in UserXmlPKPUserFilter, NativeXmlSubmissionFilter, NativeXmlIssueGalleyFilter, NativeXmlIssueFilter, NativeXmlPKPAuthorFilter, NativeXmlPKPPublicationFilter, NativeXmlSubmissionFileFilter, NativeXmlUserGroupFilter, NativeXmlArticleGalleyFilter, NativeXmlRepresentationFilter, and NativeXmlPublicationFilter.

Definition at line 89 of file NativeImportFilter.inc.php.

Referenced by process().

parseLocalizedContent()

NativeImportFilter::parseLocalizedContent

(

$element

)

Parse a localized element

Parameters

$element

DOMElement

Returns

array Array("locale_KEY", "Localized Text")

Definition at line 98 of file NativeImportFilter.inc.php.

Referenced by NativeXmlSupplementaryFileFilter\handleChildElement(), NativeXmlIssueFilter\handleChildElement(), NativeXmlPKPPublicationFilter\handleChildElement(), NativeXmlUserGroupFilter\handleElement(), NativeXmlPublicationFilter\parseIssueIdentification(), NativeXmlIssueFilter\parseIssueIdentification(), and NativeXmlIssueFilter\parseSection().

process()

& NativeImportFilter::process

(

&

$document

)

See also

Filter::process()

Parameters

$document

DOMDocument|string

Returns

array Array of imported documents

Reimplemented from Filter.

Reimplemented in NativeXmlArticleFilter.

Definition at line 36 of file NativeImportFilter.inc.php.

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

---

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

• NativeImportFilter.inc.php