ArticleCrossrefXmlFilter Class Reference

Inheritance diagram for ArticleCrossrefXmlFilter:

Public Member Functions
	__construct ($filterGroup)
	appendAsCrawledCollectionNodes ($doc, $doiDataNode, $submission, $galleys)
	appendTextMiningCollectionNodes ($doc, $doiDataNode, $submission, $galleys)
	createComponentListNode ($doc, $submission, $componentGalleys)
	createJournalArticleNode ($doc, $submission)
	createJournalIssueNode ($doc, $submission)
	createJournalNode ($doc, $pubObject)
	getClassName ()
Public Member Functions inherited from IssueCrossrefXmlFilter
	createDOIDataNode ($doc, $doi, $url)
	createHeadNode ($doc)
	createJournalMetadataNode ($doc)
	createPublicationDateNode ($doc, $objectPublicationDate)
	createRootNode ($doc)
&	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 Crossref XML document.

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

Constructor & Destructor Documentation

__construct()

ArticleCrossrefXmlFilter::__construct

(

$filterGroup

)

Constructor

Parameters

$filterGroup

FilterGroup

Reimplemented from IssueCrossrefXmlFilter.

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

References Filter\setDisplayName().

Member Function Documentation

appendAsCrawledCollectionNodes()

ArticleCrossrefXmlFilter::appendAsCrawledCollectionNodes	(		$doc,
			$doiDataNode,
			$submission,
			$galleys
	)

Append the collection node 'collection property="crawler-based"' to the doi data node.

Parameters

$doc	DOMDocument
$doiDataNode	DOMElement
$submission	Submission
$galleys	array of galleys

Definition at line 280 of file ArticleCrossrefXmlFilter.inc.php.

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

Referenced by createJournalArticleNode().

appendTextMiningCollectionNodes()

ArticleCrossrefXmlFilter::appendTextMiningCollectionNodes	(		$doc,
			$doiDataNode,
			$submission,
			$galleys
	)

Append the collection node 'collection property="text-mining"' to the doi data node.

Parameters

$doc	DOMDocument
$doiDataNode	DOMElement
$submission	Submission
$galleys	array of galleys

Definition at line 310 of file ArticleCrossrefXmlFilter.inc.php.

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

Referenced by createJournalArticleNode().

createComponentListNode()

ArticleCrossrefXmlFilter::createComponentListNode	(		$doc,
			$submission,
			$componentGalleys
	)

Create and return component list node 'component_list'.

Parameters

$doc	DOMDocument
$submission	Submission
$componentGalleys	array

Returns

DOMElement

Definition at line 337 of file ArticleCrossrefXmlFilter.inc.php.

References IssueCrossrefXmlFilter\createDOIDataNode(), PKPApplication\get(), and NativeImportExportFilter\getDeployment().

Referenced by createJournalArticleNode().

createJournalArticleNode()

ArticleCrossrefXmlFilter::createJournalArticleNode	(		$doc,
			$submission
	)

Create and return the journal article node 'journal_article'.

Parameters

$doc	DOMDocument
$submission	Submission

Returns

DOMElement

Definition at line 82 of file ArticleCrossrefXmlFilter.inc.php.

References appendAsCrawledCollectionNodes(), appendTextMiningCollectionNodes(), createComponentListNode(), IssueCrossrefXmlFilter\createDOIDataNode(), IssueCrossrefXmlFilter\createPublicationDateNode(), PKPApplication\get(), DAORegistry\getDAO(), NativeImportExportFilter\getDeployment(), and PKPLocale\getIso1FromLocale().

Referenced by createJournalNode().

createJournalIssueNode()

ArticleCrossrefXmlFilter::createJournalIssueNode	(		$doc,
			$submission
	)

Create and return the journal issue node 'journal_issue'.

Parameters

$doc	DOMDocument
$submission	Submission

Returns

DOMElement

Reimplemented from IssueCrossrefXmlFilter.

Definition at line 59 of file ArticleCrossrefXmlFilter.inc.php.

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

createJournalNode()

ArticleCrossrefXmlFilter::createJournalNode	(		$doc,
			$pubObject
	)

Create and return the journal node 'journal'.

Parameters

$doc	DOMDocument
$pubObject	object Issue or Submission

Returns

DOMElement

Reimplemented from IssueCrossrefXmlFilter.

Definition at line 45 of file ArticleCrossrefXmlFilter.inc.php.

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

getClassName()

ArticleCrossrefXmlFilter::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 IssueCrossrefXmlFilter.

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

---

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

• ArticleCrossrefXmlFilter.inc.php