OAIMetadataFormat_JATS Class Reference

Inheritance diagram for OAIMetadataFormat_JATS:

Public Member Functions
	toXml ($record, $format=null)
	toXml ($record, $format=null)
Public Member Functions inherited from OAIMetadataFormat
	__construct ($prefix, $schema, $namespace)
	getLocalizedData ($data, $locale)

Protected Member Functions
	_addChildInOrder ($parentNode, $childNode)
	_addChildInOrder ($parentNode, $childNode)
	_findJats ($article, $galleys)
	_findJats ($record)
	_isCandidateFile ($submissionFile)
	_isCandidateFile ($submissionFile)
	_mungeMetadata ($doc, $journal, $article, $section, $issue)
	_mungeMetadata ($doc, $journal, $article, $section, $issue)

Additional Inherited Members
Data Fields inherited from OAIMetadataFormat
	$namespace
	$prefix
	$schema

Detailed Description

OAI metadata format class – JATS.

See also

OAI

Definition at line 21 of file back.inc.php.

Member Function Documentation

_addChildInOrder() [1/2]

OAIMetadataFormat_JATS::_addChildInOrder (   $parentNode,   $childNode  )

protected

Add the child node to the parent node in the appropriate node order.

Parameters

$parentNode	DOMNode The parent element.
$childNode	DOMNode The child node.

Returns

DOMNode The child node.

Definition at line 97 of file back.inc.php.

Referenced by _mungeMetadata().

_addChildInOrder() [2/2]

OAIMetadataFormat_JATS::_addChildInOrder (   $parentNode,   $childNode  )

protected

Add the child node to the parent node in the appropriate node order.

Parameters

$parentNode	DOMNode The parent element.
$childNode	DOMNode The child node.

Returns

DOMNode The child node.

Definition at line 106 of file OAIMetadataFormat_JATS.inc.php.

_findJats() [1/2]

OAIMetadataFormat_JATS::_findJats (   $article,   $galleys  )

protected

Definition at line 22 of file back.inc.php.

References _isCandidateFile(), HookRegistry\call(), and DAORegistry\getDAO().

Referenced by toXml().

_findJats() [2/2]

OAIMetadataFormat_JATS::_findJats (   $record )

protected

Identify a candidate JATS file to expose via OAI.

Parameters

$record

DataObject

Returns

DOMDocument|null

Definition at line 27 of file OAIMetadataFormat_JATS.inc.php.

References _isCandidateFile(), HookRegistry\call(), and DAORegistry\getDAO().

_isCandidateFile() [1/2]

OAIMetadataFormat_JATS::_isCandidateFile (   $submissionFile )

protected

Determine whether a submission file is a good candidate for JATS XML.

Parameters

$submissionFile

SubmissionFile

Returns

boolean

Definition at line 312 of file back.inc.php.

References DAORegistry\getDAO().

Referenced by _findJats().

_isCandidateFile() [2/2]

OAIMetadataFormat_JATS::_isCandidateFile (   $submissionFile )

protected

Determine whether a submission file is a good candidate for JATS XML.

Parameters

$submissionFile

SubmissionFile

Returns

boolean

Definition at line 436 of file OAIMetadataFormat_JATS.inc.php.

References DAORegistry\getDAO().

_mungeMetadata() [1/2]

OAIMetadataFormat_JATS::_mungeMetadata (   $doc,   $journal,   $article,   $section,   $issue  )

protected

Override elements of the JATS XML with aspects of the OJS article's metadata.

Parameters

$doc	DOMDocument
$journal	Journal
$article	Article
$section	Section
$issue	Issue

Definition at line 127 of file back.inc.php.

References _addChildInOrder(), and DAORegistry\getDAO().

Referenced by toXml().

_mungeMetadata() [2/2]

OAIMetadataFormat_JATS::_mungeMetadata (   $doc,   $journal,   $article,   $section,   $issue  )

protected

Override elements of the JATS XML with aspects of the OJS article's metadata.

Parameters

$doc	DOMDocument
$journal	Journal
$article	Article
$section	Section
$issue	Issue

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

References _addChildInOrder(), PKPServices\get(), PKPApplication\get(), DAORegistry\getDAO(), and AppLocale\requireComponents().

toXml() [1/2]

OAIMetadataFormat_JATS::toXml	(		$record,
			$format = null
	)

Retrieve XML-formatted metadata for the specified record.

Parameters

$record	OAIRecord
$format	string OAI metadata prefix

Returns

string

Reimplemented from OAIMetadataFormat.

Definition at line 65 of file back.inc.php.

References _findJats(), _mungeMetadata(), PKPApplication\get(), DAORegistry\getDAO(), IssueAction\subscribedDomain(), and IssueAction\subscriptionRequired().

toXml() [2/2]

OAIMetadataFormat_JATS::toXml	(		$record,
			$format = null
	)

Retrieve XML-formatted metadata for the specified record.

Parameters

$record	OAIRecord
$format	string OAI metadata prefix

Returns

string

Reimplemented from OAIMetadataFormat.

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

References _findJats(), _mungeMetadata(), PKPApplication\get(), and DAORegistry\getDAO().

---

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

• back.inc.php
• OAIMetadataFormat_JATS.inc.php