Open Journal Systems
3.3.0
|
Public Member Functions | |
__construct ($config) | |
articleIdToIdentifier ($articleId) | |
getNonPathInfoParams () | |
identifierExists ($identifier) | |
identifiers ($metadataPrefix, $from, $until, $set, $offset, $limit, &$total) | |
identifierToArticleId ($identifier) | |
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) | |
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 | |
$journal | |
$journalId | |
$site | |
Data Fields inherited from OAI | |
$config | |
$params | |
$protocolVersion = '2.0' | |
OJS-specific OAI interface. Designed to support both a site-wide and journal-specific OAI interface (based on where the request is directed).
Definition at line 22 of file JournalOAI.inc.php.
JournalOAI::__construct | ( | $config | ) |
Reimplemented from OAI.
Definition at line 51 of file JournalOAI.inc.php.
References OAI\$config, PKPApplication\get(), and DAORegistry\getDAO().
JournalOAI::articleIdToIdentifier | ( | $articleId | ) |
Convert article ID to OAI identifier.
$articleId | int |
Definition at line 75 of file JournalOAI.inc.php.
Referenced by repositoryInfo().
JournalOAI::getNonPathInfoParams | ( | ) |
Return a list of ignorable GET parameters.
Reimplemented from OAI.
Definition at line 66 of file JournalOAI.inc.php.
JournalOAI::identifierExists | ( | $identifier | ) |
Check if identifier exists.
$identifier | string |
Reimplemented from OAI.
Definition at line 155 of file JournalOAI.inc.php.
References identifierToArticleId().
JournalOAI::identifiers | ( | $metadataPrefix, | |
$from, | |||
$until, | |||
$set, | |||
$offset, | |||
$limit, | |||
& | $total | ||
) |
Return set of OAI identifiers.
Reimplemented from OAI.
Definition at line 198 of file JournalOAI.inc.php.
References $journalId, HookRegistry\call(), and setSpecToSectionId().
JournalOAI::identifierToArticleId | ( | $identifier | ) |
Convert OAI identifier to article ID.
$identifier | string |
Definition at line 84 of file JournalOAI.inc.php.
Referenced by identifierExists(), record(), and validIdentifier().
JournalOAI::record | ( | $identifier | ) |
Return OAI record for specified identifier.
$identifier | string |
Reimplemented from OAI.
Definition at line 167 of file JournalOAI.inc.php.
References identifierToArticleId().
JournalOAI::records | ( | $metadataPrefix, | |
$from, | |||
$until, | |||
$set, | |||
$offset, | |||
$limit, | |||
& | $total | ||
) |
Return set of OAI records.
$metadataPrefix | string specified metadata prefix |
$from | int minimum timestamp |
$until | int maximum timestamp |
$set | string specified set |
$offset | int current record offset |
$limit | int maximum number of records to return |
$total | int output parameter, set to total number of records |
Reimplemented from OAI.
Definition at line 181 of file JournalOAI.inc.php.
References $journalId, HookRegistry\call(), and setSpecToSectionId().
JournalOAI::repositoryInfo | ( | ) |
Return information about the repository.
Reimplemented from OAI.
Definition at line 121 of file JournalOAI.inc.php.
References articleIdToIdentifier(), and DAORegistry\getDAO().
JournalOAI::resumptionToken | ( | $tokenId | ) |
Retrieve a resumption token.
$tokenId | string |
Reimplemented from OAI.
Definition at line 226 of file JournalOAI.inc.php.
JournalOAI::saveResumptionToken | ( | $offset, | |
$params | |||
) |
Save a resumption token.
$offset | int current offset |
$params | array request parameters |
Reimplemented from OAI.
Definition at line 238 of file JournalOAI.inc.php.
References OAI\$params.
JournalOAI::sets | ( | $offset, | |
$limit, | |||
& | $total | ||
) |
Return set of OAI sets.
$offset | int current set offset |
$limit | int Maximum number of sets to return |
$total | int output parameter, set to total number of sets |
Reimplemented from OAI.
Definition at line 215 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.
Definition at line 97 of file JournalOAI.inc.php.
Referenced by identifiers(), and records().
JournalOAI::validIdentifier | ( | $identifier | ) |
Check if identifier is in the valid format.
$identifier | string |
Reimplemented from OAI.
Definition at line 148 of file JournalOAI.inc.php.
References identifierToArticleId().
OAIDAO JournalOAI::$dao |
DAO for retrieving OAI records/tokens from database
Definition at line 45 of file JournalOAI.inc.php.
Journal JournalOAI::$journal |
associated journal object
Definition at line 33 of file JournalOAI.inc.php.
int null JournalOAI::$journalId |
Journal ID; null if no journal
Definition at line 39 of file JournalOAI.inc.php.
Referenced by identifiers(), and records().
Site JournalOAI::$site |
associated site object
Definition at line 27 of file JournalOAI.inc.php.