JournalOAI Class Reference
[Oai_ojs]
OJS-specific OAI interface. Designed to support both a site-wide and journal-specific OAI interface (based on where the request is directed).
More...
Public Member Functions | |
| articleIdToIdentifier ($articleId) | |
| 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, &$total) |
| setSpecToSectionId ($setSpec, $journalId=null) | |
| 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 28 of file JournalOAI.inc.php.
Member Function Documentation
| JournalOAI.articleIdToIdentifier | ( | $ | articleId | ) |
Convert article ID to OAI identifier.
- Parameters:
-
$articleId int
- Returns:
- string
Definition at line 60 of file JournalOAI.inc.php.
Referenced by repositoryInfo().
| JournalOAI.identifierExists | ( | $ | identifier | ) |
- See also:
- OAI.identifierExists
Reimplemented from OAI.
Definition at line 131 of file JournalOAI.inc.php.
References identifierToArticleId().
| & JournalOAI.identifiers | ( | $ | metadataPrefix, | |
| $ | from, | |||
| $ | until, | |||
| $ | set, | |||
| $ | offset, | |||
| $ | limit, | |||
| &$ | total | |||
| ) |
- See also:
- OAI.identifiers
Reimplemented from OAI.
Definition at line 171 of file JournalOAI.inc.php.
References setSpecToSectionId().
| JournalOAI.identifierToArticleId | ( | $ | identifier | ) |
Convert OAI identifier to article ID.
- Parameters:
-
$identifier string
- Returns:
- int
Definition at line 69 of file JournalOAI.inc.php.
Referenced by identifierExists(), record(), and validIdentifier().
| JournalOAI.JournalOAI | ( | $ | config | ) |
- See also:
- OAI.OAI
Definition at line 45 of file JournalOAI.inc.php.
References DAORegistry.getDAO(), Request.getJournal(), and Request.getSite().
| & JournalOAI.record | ( | $ | identifier | ) |
- See also:
- OAI.record
Reimplemented from OAI.
Definition at line 143 of file JournalOAI.inc.php.
References identifierToArticleId().
| & JournalOAI.records | ( | $ | metadataPrefix, | |
| $ | from, | |||
| $ | until, | |||
| $ | set, | |||
| $ | offset, | |||
| $ | limit, | |||
| &$ | total | |||
| ) |
- See also:
- OAI.records
Reimplemented from OAI.
Definition at line 157 of file JournalOAI.inc.php.
References setSpecToSectionId().
| & JournalOAI.repositoryInfo | ( | ) |
- See also:
- OAI.repositoryInfo
Reimplemented from OAI.
Definition at line 103 of file JournalOAI.inc.php.
References articleIdToIdentifier().
| & JournalOAI.resumptionToken | ( | $ | tokenId | ) |
- See also:
- OAI.resumptionToken
Reimplemented from OAI.
Definition at line 193 of file JournalOAI.inc.php.
| & JournalOAI.saveResumptionToken | ( | $ | offset, | |
| $ | params | |||
| ) |
- See also:
- OAI.saveResumptionToken
Reimplemented from OAI.
Definition at line 205 of file JournalOAI.inc.php.
| & JournalOAI.sets | ( | $ | offset, | |
| &$ | total | |||
| ) |
| JournalOAI.setSpecToSectionId | ( | $ | setSpec, | |
| $ | journalId = null | |||
| ) |
Get the journal ID and section ID corresponding to a set specifier.
- Returns:
- int
Definition at line 82 of file JournalOAI.inc.php.
Referenced by identifiers(), and records().
| JournalOAI.validIdentifier | ( | $ | identifier | ) |
- See also:
- OAI.validIdentifier
Reimplemented from OAI.
Definition at line 124 of file JournalOAI.inc.php.
References identifierToArticleId().
The documentation for this class was generated from the following file:
- classes/oai/ojs/JournalOAI.inc.php
