PHP Class JournalOAI, ojs

Inheritance: extends OAI
Exibir arquivo Open project: pkp/ojs Class Usage Examples

Public Properties

Property Type Description
$dao DAO for retrieving OAI records/tokens from database
$journal associated journal object
$journalId Journal ID; null if no journal
$site associated site object

Public Methods

Method Description
__construct ( $config )
articleIdToIdentifier ( $articleId ) : string Convert article ID to OAI identifier.
getNonPathInfoParams ( ) : array Return a list of ignorable GET parameters.
identifierExists ( $identifier )
identifierToArticleId ( $identifier ) : integer Convert OAI identifier to article ID.
identifiers ( $metadataPrefix, $from, $until, $set, $offset, $limit, &$total )
record ( $identifier )
records ( $metadataPrefix, $from, $until, $set, $offset, $limit, &$total )
repositoryInfo ( )
resumptionToken ( $tokenId )
saveResumptionToken ( $offset, $params )
setSpecToSectionId ( $setSpec, $journalId = null ) : integer Get the journal ID and section ID corresponding to a set specifier.
sets ( $offset, $limit, &$total )
validIdentifier ( $identifier )

Method Details

__construct() public method

public __construct ( $config )

articleIdToIdentifier() public method

Convert article ID to OAI identifier.
public articleIdToIdentifier ( $articleId ) : string
$articleId int
return string

getNonPathInfoParams() public method

Return a list of ignorable GET parameters.
public getNonPathInfoParams ( ) : array
return array

identifierExists() public method

public identifierExists ( $identifier )

identifierToArticleId() public method

Convert OAI identifier to article ID.
public identifierToArticleId ( $identifier ) : integer
$identifier string
return integer

identifiers() public method

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

record() public method

public record ( $identifier )

records() public method

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

repositoryInfo() public method

public repositoryInfo ( )

resumptionToken() public method

public resumptionToken ( $tokenId )

saveResumptionToken() public method

public saveResumptionToken ( $offset, $params )

setSpecToSectionId() public method

Get the journal ID and section ID corresponding to a set specifier.
public setSpecToSectionId ( $setSpec, $journalId = null ) : integer
return integer

sets() public method

public sets ( $offset, $limit, &$total )

validIdentifier() public method

public validIdentifier ( $identifier )

Property Details

$dao public_oe property

DAO for retrieving OAI records/tokens from database
public $dao

$journal public_oe property

associated journal object
public $journal

$journalId public_oe property

Journal ID; null if no journal
public $journalId

$site public_oe property

associated site object
public $site