Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
JournalOAI Class Reference
Inheritance diagram for JournalOAI:
OAI

Public Member Functions

 articleIdToIdentifier ($articleId)
 
 getNonPathInfoParams ()
 
 identifierExists ($identifier)
 
identifiers ($metadataPrefix, $from, $until, $set, $offset, $limit, &$total)
 
 identifierToArticleId ($identifier)
 
 JournalOAI ($config)
 
record ($identifier)
 
records ($metadataPrefix, $from, $until, $set, $offset, $limit, &$total)
 
repositoryInfo ()
 
resumptionToken ($tokenId)
 
saveResumptionToken ($offset, $params)
 
sets ($offset, $limit, &$total)
 
 setSpecToSectionId ($setSpec, $journalId=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)
 

Detailed Description

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

See Also
OAIDAO

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

Member Function Documentation

JournalOAI::articleIdToIdentifier (   $articleId)

Convert article ID to OAI identifier.

Parameters
$articleIdint
Returns
string

Definition at line 66 of file JournalOAI.inc.php.

Referenced by repositoryInfo().

JournalOAI::getNonPathInfoParams ( )

Return a list of ignorable GET parameters.

Returns
array

Definition at line 57 of file JournalOAI.inc.php.

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

Definition at line 146 of file JournalOAI.inc.php.

References identifierToArticleId().

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

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

References HookRegistry\call(), and setSpecToSectionId().

JournalOAI::identifierToArticleId (   $identifier)

Convert OAI identifier to article ID.

Parameters
$identifierstring
Returns
int

Definition at line 75 of file JournalOAI.inc.php.

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

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

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

References DAORegistry\getDAO(), Request\getJournal(), and PKPRequest\getSite().

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

Definition at line 158 of file JournalOAI.inc.php.

References identifierToArticleId().

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

Definition at line 172 of file JournalOAI.inc.php.

References HookRegistry\call(), and setSpecToSectionId().

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

Definition at line 112 of file JournalOAI.inc.php.

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

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

Definition at line 217 of file JournalOAI.inc.php.

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

Definition at line 229 of file JournalOAI.inc.php.

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

Definition at line 206 of file JournalOAI.inc.php.

References HookRegistry\call().

JournalOAI::setSpecToSectionId (   $setSpec,
  $journalId = null 
)

Get the journal ID and section ID corresponding to a set specifier.

Returns
int

Definition at line 88 of file JournalOAI.inc.php.

Referenced by identifiers(), and records().

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

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

References identifierToArticleId().


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