Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
PressOAI Class Reference
Inheritance diagram for PressOAI:
OAI

Public Member Functions

 _getIdentifierPrefix ()
 
 getNonPathInfoParams ()
 
 identifierExists ($identifier)
 
identifiers ($metadataPrefix, $from, $until, $set, $offset, $limit, &$total)
 
 identifierToPublicationFormatId ($identifier)
 
 PressOAI ($config)
 
 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)
 
 getNonPathInfoParams ()
 
 getParam ($name)
 
 getParams ()
 
 GetRecord ()
 
 identifierExists ($identifier)
 
identifiers ($metadataPrefix, $from, $until, $set, $offset, $limit, &$total)
 
 Identify ()
 
 ListIdentifiers ()
 
 ListMetadataFormats ()
 
 ListRecords ()
 
 ListSets ()
 
metadataFormats ($namesOnly=false, $identifier=null)
 
 OAI (&$config)
 
 paramExists ($name)
 
record ($identifier)
 
records ($metadataPrefix, $from, $until, $set, $offset, $limit, &$total)
 
repositoryInfo ()
 
 response ($response, $printParams=true)
 
resumptionToken ($tokenId)
 
saveResumptionToken ($offset, $params)
 
 setParams (&$params)
 
sets ($offset, &$total)
 
 validIdentifier ($identifier)
 

Public Attributes

 $dao
 
 $press
 
 $pressId
 
 $site
 
- Public Attributes 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.

Member Function Documentation

PressOAI::_getIdentifierPrefix ( )

Get the OAI identifier prefix.

Returns
string

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

PressOAI::getNonPathInfoParams ( )

Return a list of ignorable GET parameters.

Returns
array

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

PressOAI::identifierExists (   $identifier)
See Also
OAI::identifierExists

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

References identifierToPublicationFormatId().

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

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

PressOAI::identifierToPublicationFormatId (   $identifier)

Convert OAI identifier to monograph ID.

Parameters
$identifierstring
Returns
int

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

Referenced by identifierExists().

PressOAI::PressOAI (   $config)
See Also
OAI::OAI

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

PressOAI::publicationFormatIdToIdentifier (   $publicationFormatId)

Convert monograph ID to OAI identifier.

Parameters
$monographIdint
Returns
string

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

& PressOAI::record (   $identifier)
See Also
OAI::record

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

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

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

& PressOAI::repositoryInfo ( )
See Also
OAI::repositoryInfo

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

& PressOAI::resumptionToken (   $tokenId)
See Also
OAI::resumptionToken

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

References OAI\$params.

& PressOAI::saveResumptionToken (   $offset,
  $params 
)
See Also
OAI::saveResumptionToken

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

& PressOAI::sets (   $offset,
  $limit,
$total 
)
See Also
OAI::sets

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

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

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

Parameters
$setSpecstring
$pressIdint
Returns
int

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

PressOAI::validIdentifier (   $identifier)
See Also
OAI::validIdentifier

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

Member Data Documentation

$dao PressOAI::$dao

OAIDAO DAO for retrieving OAI records/tokens from database

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

$press PressOAI::$press

Press associated press object

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

$pressId PressOAI::$pressId

int null if no press

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

$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: