DOAJXmlFilter Class Reference

Inheritance diagram for DOAJXmlFilter:

Public Member Functions
	__construct ($filterGroup)
	createAffiliationsList ($authors, $publication)
	createAuthorNode ($doc, $publication, $author, $affilList)
	createRootNode ($doc)
	formatDate ($date)
	getClassName ()
&	process (&$pubObjects)
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

Class that converts an Article to a DOAJ XML document.

Definition at line 19 of file DOAJXmlFilter.inc.php.

Constructor & Destructor Documentation

__construct()

DOAJXmlFilter::__construct

(

$filterGroup

)

Constructor

Parameters

$filterGroup

FilterGroup

Reimplemented from NativeExportFilter.

Definition at line 24 of file DOAJXmlFilter.inc.php.

References Filter\setDisplayName().

Member Function Documentation

createAffiliationsList()

DOAJXmlFilter::createAffiliationsList	(		$authors,
			$publication
	)

Generate a list of affiliations among all authors of an article.

Parameters

$authors	object Array of article authors
$publication	Publication

Returns

array

Definition at line 224 of file DOAJXmlFilter.inc.php.

Referenced by process().

createAuthorNode()

DOAJXmlFilter::createAuthorNode	(		$doc,
			$publication,
			$author,
			$affilList
	)

Generate the author node.

Parameters

$doc	DOMDocument
$publication	object Article
$author	object Author
$affilList	array List of author affiliations

Returns

DOMElement

Definition at line 205 of file DOAJXmlFilter.inc.php.

References NativeImportExportFilter\getDeployment().

Referenced by process().

createRootNode()

DOAJXmlFilter::createRootNode

(

$doc

)

Create and return the root node.

Parameters

$doc	DOMDocument

Returns

DOMElement

Definition at line 189 of file DOAJXmlFilter.inc.php.

References NativeImportExportFilter\getDeployment().

Referenced by process().

formatDate()

DOAJXmlFilter::formatDate

(

$date

)

Format a date by Y-m-d format.

Parameters

$date

string

Returns

string

Definition at line 239 of file DOAJXmlFilter.inc.php.

getClassName()

DOAJXmlFilter::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.

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

process()

& DOAJXmlFilter::process

(

&

$pubObjects

)

See also

Filter::process()

Parameters

$pubObjects

array Array of Submissions

Returns

DOMDocument

Reimplemented from Filter.

Definition at line 47 of file DOAJXmlFilter.inc.php.

References createAffiliationsList(), createAuthorNode(), createRootNode(), PKPApplication\get(), PKPLocale\get3LetterIsoFromLocale(), DAORegistry\getDAO(), NativeImportExportFilter\getDeployment(), AppLocale\getSupportedFormLocales(), and PKPString\html2text().

---

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

• DOAJXmlFilter.inc.php