OAIDAO Class Reference

Inheritance diagram for OAIDAO:

Public Member Functions
	__construct ()
	_getRecordsRecordSet ($setIds, $from, $until, $set, $submissionId=null, $orderBy='press_id, data_object_id')
	getPress ($pressId)
	getSeries ($seriesId)
	getSetPressSeriesId ($pressSpec, $seriesSpec, $restrictPressId=null)
	getSets ($pressId=null, $offset, $limit, &$total)
	setOAIData ($record, $row, $isRecord=true)
Public Member Functions inherited from PKPOAIDAO
	_doCommonOAIFromRowOperations ($record, $row)
	_getRecordsRecordSet ($setIds, $from, $until, $set, $submissionId=null, $orderBy='journal_id, submission_id')
	_returnIdentifierFromRow ($row)
	_returnRecordFromRow ($row)
	clearTokens ()
	getEarliestDatestamp ($setIds=array())
	getIdentifiers ($setIds, $from, $until, $set, $offset, $limit, &$total)
	getRecord ($dataObjectId, $setIds=array())
	getRecords ($setIds, $from, $until, $set, $offset, $limit, &$total)
	getToken ($tokenId)
	insertToken ($token)
	recordExists ($dataObjectId, $setIds=array())
	setOAI ($oai)
Public Member Functions inherited from DAO
	__construct ($dataSource=null, $callHooks=true)
	concat ()
	convertFromDB ($value, $type)
	convertToDB ($value, &$type)
	dateFromDB ($d)
	datetimeFromDB ($dt)
	datetimeToDB ($dt)
	dateToDB ($d)
	flushCache ()
	formatDateToDB ($date, $defaultNumWeeks=null, $acceptPastDate=true)
	getAdditionalFieldNames ()
	getAffectedRows ()
	getDataObjectSettings ($tableName, $idFieldName, $idFieldValue, $dataObject)
	getDataSource ()
	getDirectionMapping ($direction)
	getDriver ()
	getLocaleFieldNames ()
	getType ($value)
	handleError ($dataSource, $sql)
	nullOrInt ($value)
	replace ($table, $arrFields, $keyCols)
&	retrieve ($sql, $params=false, $callHooks=true)
&	retrieveCached ($sql, $params=false, $secsToCache=3600, $callHooks=true)
&	retrieveLimit ($sql, $params=false, $numRows=false, $offset=false, $callHooks=true)
&	retrieveRange ($sql, $params=false, $dbResultRange=null, $callHooks=true)
	setCacheDir ()
	setDataSource ($dataSource)
	update ($sql, $params=false, $callHooks=true, $dieOnError=true)
	updateDataObjectSettings ($tableName, $dataObject, $idArray)

Data Fields
	$_pressCache
	$_pressDao
	$_publicationFormatDao
	$_seriesCache
	$_seriesDao
Data Fields inherited from PKPOAIDAO
	$oai
Data Fields inherited from DAO
	$_dataSource

Additional Inherited Members
Static Public Member Functions inherited from DAO
static	getDataChangedEvent ($elementId=null, $parentElementId=null, $content='')
Protected Member Functions inherited from DAO
	_getInsertId ($table='', $id='')

Detailed Description

DAO operations for the OMP OAI interface.

See also

OAI

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

Constructor & Destructor Documentation

__construct()

OAIDAO::__construct

(

)

Constructor.

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

References DAORegistry\getDAO().

Member Function Documentation

_getRecordsRecordSet()

OAIDAO::_getRecordsRecordSet	(		$setIds,
			$from,
			$until,
			$set,
			$submissionId = null,
			$orderBy = 'press_id,
		data_object_id'
	)

Get a OAI records record set.

Parameters

$setIds	array Objects ids that specify an OAI set, in hierarchical order.
$from	int/string *nix timestamp or ISO datetime string
$until	int/string *nix timestamp or ISO datetime string
$set	string
$submissionId	int Optional
$orderBy	string UNFILTERED

Returns

ADORecordSet

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

References DAO\datetimeToDB(), and DAO\retrieve().

getPress()

OAIDAO::getPress

(

$pressId

)

Cached function to get a press

Parameters

$pressId

int

Returns

Press

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

Referenced by getSets(), and setOAIData().

getSeries()

OAIDAO::getSeries

(

$seriesId

)

Cached function to get a press series

Parameters

$seriesId

int

Returns

Series

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

Referenced by setOAIData().

getSetPressSeriesId()

OAIDAO::getSetPressSeriesId	(		$pressSpec,
			$seriesSpec,
			$restrictPressId = null
	)

Return the press ID and series ID corresponding to a press/series pairing.

Parameters

$pressSpec	string
$seriesSpec	string
$restrictPressId	int

Returns

array (int, int, int)

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

getSets()

OAIDAO::getSets	(		$pressId = null,
			$offset,
			$limit,
		&	$total
	)

Return hierarchy of OAI sets (presses plus press series).

Parameters

$pressId	int
$offset	int
$total	int

Returns

array OAISet

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

References HookRegistry\call(), DAORegistry\getDAO(), and getPress().

setOAIData()

OAIDAO::setOAIData	(		$record,
			$row,
			$isRecord = true
	)

See also

lib/pkp/classes/oai/PKPOAIDAO::setOAIData()

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

References PKPServices\get(), getPress(), and getSeries().

Field Documentation

$_pressCache

array OAIDAO::$_pressCache

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

$_pressDao

PressDAO OAIDAO::$_pressDao

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

$_publicationFormatDao

PublicationFormatDAO OAIDAO::$_publicationFormatDao

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

$_seriesCache

array OAIDAO::$_seriesCache

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

$_seriesDao

SeriesDAO OAIDAO::$_seriesDao

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

---

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

• OAIDAO.inc.php