Open Journal Systems  3.3.0
OAIDAO Class Reference
Inheritance diagram for OAIDAO:
PKPOAIDAO DAO DRIVERDAO

Public Member Functions

 __construct ()
 
 _getRecordsRecordSet ($setIds, $from, $until, $set, $submissionId=null, $orderBy='journal_id, submission_id')
 
 getEarliestDatestampQuery ()
 
getIssue ($issueId)
 
getJournal ($journalId)
 
getJournalSets ($journalId, $offset, $limit, &$total)
 
getSection ($sectionId)
 
 getSetJournalSectionId ($journalSpec, $sectionSpec, $restrictJournalId=null)
 
 setOAIData ($record, $row, $isRecord=true)
 
- Public Member Functions inherited from PKPOAIDAO
 _doCommonOAIFromRowOperations ($record, $row)
 
 _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

 $articleGalleyDao
 
 $authorDao
 
 $issueCache
 
 $issueDao
 
 $journalCache
 
 $journalDao
 
 $sectionCache
 
 $sectionDao
 
- 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 OJS OAI interface.

See also
OAI

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

Constructor & Destructor Documentation

◆ __construct()

OAIDAO::__construct ( )

Constructor.

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

References DAORegistry\getDAO().

Member Function Documentation

◆ _getRecordsRecordSet()

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

Get a OAI records record set.

Parameters
$setIdsarray Objects ids that specify an OAI set, in hierarchical order.
$fromint/string *nix timestamp or ISO datetime string
$untilint/string *nix timestamp or ISO datetime string
$setstring
$submissionIdint optional
$orderBystring UNFILTERED
Returns
ADORecordSet

Reimplemented from PKPOAIDAO.

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

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

Referenced by DRIVERDAO\getDRIVERRecordsOrIdentifiers().

◆ getEarliestDatestampQuery()

OAIDAO::getEarliestDatestampQuery ( )

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

◆ getIssue()

& OAIDAO::getIssue (   $issueId)

Cached function to get an issue

Parameters
$issueIdint
Returns
object

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

Referenced by setOAIData().

◆ getJournal()

& OAIDAO::getJournal (   $journalId)

Cached function to get a journal

Parameters
$journalIdint
Returns
object

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

Referenced by setOAIData().

◆ getJournalSets()

& OAIDAO::getJournalSets (   $journalId,
  $offset,
  $limit,
$total 
)

Return hierarchy of OAI sets (journals plus journal sections).

Parameters
$journalIdint
$offsetint
$totalint
Returns
array OAISet

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

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

◆ getSection()

& OAIDAO::getSection (   $sectionId)

Cached function to get a journal section

Parameters
$sectionIdint
Returns
object

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

Referenced by setOAIData().

◆ getSetJournalSectionId()

OAIDAO::getSetJournalSectionId (   $journalSpec,
  $sectionSpec,
  $restrictJournalId = null 
)

Return the journal ID and section ID corresponding to a journal/section pairing.

Parameters
$journalSpecstring
$sectionSpecstring
$restrictJournalIdint
Returns
array (int, int)

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

◆ setOAIData()

OAIDAO::setOAIData (   $record,
  $row,
  $isRecord = true 
)
See also
lib/pkp/classes/oai/PKPOAIDAO::setOAIData()

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

References PKPServices\get(), getIssue(), getJournal(), getSection(), and OAI\sets().

Field Documentation

◆ $articleGalleyDao

OAIDAO::$articleGalleyDao

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

◆ $authorDao

OAIDAO::$authorDao

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

◆ $issueCache

OAIDAO::$issueCache

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

◆ $issueDao

OAIDAO::$issueDao

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

◆ $journalCache

OAIDAO::$journalCache

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

◆ $journalDao

OAIDAO::$journalDao

Helper DAOs

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

◆ $sectionCache

OAIDAO::$sectionCache

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

◆ $sectionDao

OAIDAO::$sectionDao

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


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