PressOAI Class Reference

Inheritance diagram for PressOAI:

Public Member Functions
	__construct ($config)
	_getIdentifierPrefix ()
	getNonPathInfoParams ()
	identifierExists ($identifier)
	identifiers ($metadataPrefix, $from, $until, $set, $offset, $limit, &$total)
	identifierToPublicationFormatId ($identifier)
	publicationFormatIdToIdentifier ($publicationFormatId)
	record ($identifier)
	records ($metadataPrefix, $from, $until, $set, $offset, $limit, &$total)
	repositoryInfo ()
	resumptionToken ($tokenId)
	saveResumptionToken ($offset, $params)
	sets ($offset, $limit, &$total)
	setSpecToSeriesId ($setSpec, $pressId=null)
	validIdentifier ($identifier)
Public Member Functions inherited from OAI
	checkParams ($required=array(), $optional=array())
	error ($code, $message)
	execute ()
	extractDateParams ($params, &$from, &$until)
	formatMetadata ($format, $record)
	getParam ($name)
	getParams ()
	GetRecord ()
	Identify ()
	ListIdentifiers ()
	ListMetadataFormats ()
	ListRecords ()
	ListSets ()
	metadataFormats ($namesOnly=false, $identifier=null)
	paramExists ($name)
	response ($response, $printParams=true)
	setParams ($params)

Data Fields
	$dao
	$press
	$pressId
	$site
Data Fields inherited from OAI
	$config
	$params
	$protocolVersion = '2.0'

Detailed Description

OMP-specific OAI interface. Designed to support both a site-wide and press-specific OAI interface (based on where the request is directed).

See also

OAIDAO

Definition at line 26 of file PressOAI.inc.php.

Constructor & Destructor Documentation

__construct()

PressOAI::__construct

(

$config

)

See also

OAI::OAI

Reimplemented from OAI.

Definition at line 55 of file PressOAI.inc.php.

References OAI\$config, PKPApplication\get(), and DAORegistry\getDAO().

Member Function Documentation

_getIdentifierPrefix()

PressOAI::_getIdentifierPrefix

(

)

Get the OAI identifier prefix.

Returns

string

Definition at line 259 of file PressOAI.inc.php.

Referenced by identifierToPublicationFormatId(), and publicationFormatIdToIdentifier().

getNonPathInfoParams()

PressOAI::getNonPathInfoParams

(

)

Return a list of ignorable GET parameters.

Returns

array

Reimplemented from OAI.

Definition at line 71 of file PressOAI.inc.php.

identifierExists()

PressOAI::identifierExists

(

$identifier

)

See also

OAI::identifierExists

Reimplemented from OAI.

Definition at line 162 of file PressOAI.inc.php.

References identifierToPublicationFormatId().

identifiers()

PressOAI::identifiers	(		$metadataPrefix,
			$from,
			$until,
			$set,
			$offset,
			$limit,
		&	$total
	)

See also

OAI::identifiers

Reimplemented from OAI.

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

References $pressId, HookRegistry\call(), and setSpecToSeriesId().

identifierToPublicationFormatId()

PressOAI::identifierToPublicationFormatId

(

$identifier

)

Convert OAI identifier to monograph ID.

Parameters

$identifier

string

Returns

int

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

References _getIdentifierPrefix().

Referenced by identifierExists(), record(), and validIdentifier().

publicationFormatIdToIdentifier()

PressOAI::publicationFormatIdToIdentifier

(

$publicationFormatId

)

Convert monograph ID to OAI identifier.

Parameters

$publicationFormatId

int

Returns

string

Definition at line 80 of file PressOAI.inc.php.

References _getIdentifierPrefix().

Referenced by repositoryInfo().

record()

PressOAI::record

(

$identifier

)

See also

OAI::record

Reimplemented from OAI.

Definition at line 174 of file PressOAI.inc.php.

References identifierToPublicationFormatId().

records()

PressOAI::records	(		$metadataPrefix,
			$from,
			$until,
			$set,
			$offset,
			$limit,
		&	$total
	)

See also

OAI::records

Reimplemented from OAI.

Definition at line 188 of file PressOAI.inc.php.

References $pressId, HookRegistry\call(), and setSpecToSeriesId().

repositoryInfo()

PressOAI::repositoryInfo

(

)

See also

OAI::repositoryInfo

Reimplemented from OAI.

Definition at line 128 of file PressOAI.inc.php.

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

resumptionToken()

PressOAI::resumptionToken

(

$tokenId

)

See also

OAI::resumptionToken

Reimplemented from OAI.

Definition at line 233 of file PressOAI.inc.php.

saveResumptionToken()

PressOAI::saveResumptionToken	(		$offset,
			$params
	)

See also

OAI::saveResumptionToken

Reimplemented from OAI.

Definition at line 245 of file PressOAI.inc.php.

References OAI\$params.

sets()

PressOAI::sets	(		$offset,
			$limit,
		&	$total
	)

See also

OAI::sets

Reimplemented from OAI.

Definition at line 222 of file PressOAI.inc.php.

References HookRegistry\call().

setSpecToSeriesId()

PressOAI::setSpecToSeriesId	(		$setSpec,
			$pressId = null
	)

Get press ID and series ID corresponding to a set specifier.

Parameters

$setSpec	string
$pressId	int

Returns

array

Definition at line 104 of file PressOAI.inc.php.

Referenced by identifiers(), and records().

validIdentifier()

PressOAI::validIdentifier

(

$identifier

)

See also

OAI::validIdentifier

Reimplemented from OAI.

Definition at line 155 of file PressOAI.inc.php.

References identifierToPublicationFormatId().

Field Documentation

$dao

$dao PressOAI::$dao

OAIDAO DAO for retrieving OAI records/tokens from database

Definition at line 49 of file PressOAI.inc.php.

$press

$press PressOAI::$press

Press associated press object

Definition at line 37 of file PressOAI.inc.php.

$pressId

$pressId PressOAI::$pressId

int null if no press

Definition at line 43 of file PressOAI.inc.php.

Referenced by identifiers(), and records().

$site

$site PressOAI::$site

Site associated site object

Definition at line 31 of file PressOAI.inc.php.

---

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

• PressOAI.inc.php