OAIDAO Class Reference
[Oai_ocs]

DAO operations for the OCS OAI interface. More...

List of all members.

Public Member Functions
&	_returnIdentifierFromRow (&$row)
&	_returnRecordFromRow (&$row)
	clearTokens ()
&	getConference ($conferenceId)
&	getConferenceSets ($conferenceId, $offset, &$total)
	getEarliestDatestamp ($conferenceId=null)
&	getIdentifiers ($conferenceId, $schedConfId, $trackId, $from, $until, $offset, $limit, &$total)
&	getRecord ($paperId, $conferenceId=null)
&	getRecords ($conferenceId, $schedConfId, $trackId, $from, $until, $offset, $limit, &$total)
&	getSchedConf ($schedConfId)
	getSetConferenceTrackId ($conferenceSpec, $schedConfSpec, $trackSpec, $restrictConferenceId=null)
&	getToken ($tokenId)
&	getTrack ($trackId)
&	insertToken (&$token)
	OAIDAO ()
	recordExists ($paperId, $conferenceId=null)
	setOAI (&$oai)
	stripAssocArray ($values)
Public Attributes
	$authorDao
	$conferenceCache
	$conferenceDao
	$conferenceSettingsDao
	$oai
	$paperGalleyDao
	$publishedPaperDao
	$schedConfCache
	$suppFileDao
	$trackCache
	$trackDao

---

Detailed Description

DAO operations for the OCS OAI interface.

See also:

OAI

Definition at line 20 of file OAIDAO.inc.php.

---

Member Function Documentation

& OAIDAO._returnIdentifierFromRow

(

&$

row

)

Return OAIIdentifier object from database row.

Parameters:

$row

array

Returns:

OAIIdentifier

Definition at line 379 of file OAIDAO.inc.php.

References getConference(), getSchedConf(), and getTrack().

Referenced by getIdentifiers().

& OAIDAO._returnRecordFromRow

(

&$

row

)

Return OAIRecord object from database row.

Parameters:

$row

array

Returns:

OAIRecord

Definition at line 344 of file OAIDAO.inc.php.

References getConference(), getSchedConf(), and getTrack().

Referenced by getRecord(), and getRecords().

OAIDAO.clearTokens

(

)

Clear stale resumption tokens.

Definition at line 399 of file OAIDAO.inc.php.

& OAIDAO.getConference

(

$

conferenceId

)

Cached function to get a conference

Parameters:

$conferenceId

int

Returns:

object

Definition at line 308 of file OAIDAO.inc.php.

Referenced by _returnIdentifierFromRow(), and _returnRecordFromRow().

& OAIDAO.getConferenceSets	(	$	conferenceId,
		$	offset,
		&$	total
	)

Return hierarchy of OAI sets (conferences plus conference tracks).

Parameters:

	$conferenceId	int
	$offset	int
	$total	int

Returns:

array OAISet

Definition at line 469 of file OAIDAO.inc.php.

References getSchedConf().

OAIDAO.getEarliestDatestamp

(

$

conferenceId = null

)

Return the *nix timestamp of the earliest published paper.

Parameters:

$conferenceId

int optional

Returns:

int

Definition at line 74 of file OAIDAO.inc.php.

& OAIDAO.getIdentifiers	(	$	conferenceId,
		$	schedConfId,
		$	trackId,
		$	from,
		$	until,
		$	offset,
		$	limit,
		&$	total
	)

Return set of OAI identifiers matching specified parameters.

Parameters:

	$conferenceId	int
	$schedConfId	int
	$trackId	int $from int timestamp $until int timestamp
	$offset	int
	$limit	int
	$total	int

Returns:

array OAIIdentifier

Definition at line 243 of file OAIDAO.inc.php.

References _returnIdentifierFromRow().

& OAIDAO.getRecord	(	$	paperId,
		$	conferenceId = null
	)

Return OAI record for specified paper.

Parameters:

	$paperId	int
	$conferenceId	int optional

Returns:

OAIRecord

Definition at line 140 of file OAIDAO.inc.php.

References _returnRecordFromRow().

& OAIDAO.getRecords	(	$	conferenceId,
		$	schedConfId,
		$	trackId,
		$	from,
		$	until,
		$	offset,
		$	limit,
		&$	total
	)

Return set of OAI records matching specified parameters.

Parameters:

	$conferenceId	int
	$schedConfId	int
	$trackId	int $from int timestamp $until int timestamp
	$offset	int
	$limit	int
	$total	int

Returns:

array OAIRecord

Definition at line 181 of file OAIDAO.inc.php.

References _returnRecordFromRow().

& OAIDAO.getSchedConf

(

$

schedConfId

)

Cached function to get a schedConf

Parameters:

$schedConfId

int

Returns:

object

Definition at line 320 of file OAIDAO.inc.php.

Referenced by _returnIdentifierFromRow(), _returnRecordFromRow(), and getConferenceSets().

OAIDAO.getSetConferenceTrackId	(	$	conferenceSpec,
		$	schedConfSpec,
		$	trackSpec,
		$	restrictConferenceId = null
	)

Return the conference ID and track ID corresponding to a conference/sched conf/track group.

Parameters:

	$conferenceSpec	string
	$schedConfSpec	string
	$trackSpec	string
	$restrictConferenceId	int

Returns:

array (int, int)

Definition at line 507 of file OAIDAO.inc.php.

& OAIDAO.getToken

(

$

tokenId

)

Retrieve a resumption token.

Returns:

OAIResumptionToken

Definition at line 409 of file OAIDAO.inc.php.

& OAIDAO.getTrack

(

$

trackId

)

Cached function to get a track

Parameters:

$trackId

int

Returns:

object

Definition at line 332 of file OAIDAO.inc.php.

Referenced by _returnIdentifierFromRow(), and _returnRecordFromRow().

& OAIDAO.insertToken

(

&$

token

)

Insert an OAI resumption token, generating a new ID.

Parameters:

$token

OAIResumptionToken

Returns:

OAIResumptionToken

Definition at line 434 of file OAIDAO.inc.php.

OAIDAO.OAIDAO

(

)

Constructor.

Definition at line 41 of file OAIDAO.inc.php.

OAIDAO.recordExists	(	$	paperId,
		$	conferenceId = null
	)

Check if an paper ID specifies a published paper.

Parameters:

	$paperId	int
	$conferenceId	int optional

Returns:

boolean

Definition at line 109 of file OAIDAO.inc.php.

OAIDAO.setOAI

(

&$

oai

)

Set parent OAI object.

Parameters:

ConferenceOAI

Definition at line 61 of file OAIDAO.inc.php.

References $oai.

---

Member Data Documentation

OAIDAO.$conferenceDao

Helper DAOs

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

---

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

• classes/oai/ocs/OAIDAO.inc.php

---