Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
RTDAO Class Reference
Inheritance diagram for RTDAO:
DAO

Public Member Functions

_returnContextFromRow (&$row)
 
_returnSearchFromRow (&$row)
 
_returnVersionFromRow (&$row)
 
 deleteContext ($contextId, $versionId)
 
 deleteContextsByVersionId ($versionId)
 
 deleteSearch ($searchId, $contextId)
 
 deleteSearchesByContextId ($contextId)
 
 deleteVersion ($versionId, $journalId)
 
 deleteVersionsByJournal ($journalId)
 
 deleteVersionsByJournalId ($journalId)
 
getContext ($contextId)
 
getContexts ($versionId, $pagingInfo=null)
 
getJournalRTByJournal (&$journal)
 
getSearch ($searchId)
 
getSearches ($contextId, $pagingInfo=null)
 
getVersion ($versionId, $journalId=null, $useCache=null)
 
getVersions ($journalId, $pagingInfo=null)
 
 insertContext (&$context)
 
 insertJournalRT (&$rt)
 
 insertSearch (&$search)
 
 insertVersion ($journalId, &$version)
 
 resequenceContexts ($versionId)
 
 resequenceSearches ($contextId)
 
 updateContext (&$context)
 
 updateSearch (&$search)
 
 updateVersion ($journalId, &$version)
 
- Public Member Functions inherited from DAO
 concat ()
 
 convertFromDB ($value, $type)
 
 convertToDB ($value, &$type)
 
 DAO ($dataSource=null, $callHooks=true)
 
 dateFromDB ($d)
 
 datetimeFromDB ($dt)
 
 datetimeToDB ($dt)
 
 dateToDB ($d)
 
 flushCache ()
 
 formatDateToDB ($date, $defaultNumWeeks=null, $acceptPastDate=true)
 
 getAffectedRows ()
 
 getDataChangedEvent ($elementId=null, $parentElementId=null)
 
getDataSource ()
 
 getDirectionMapping ($direction)
 
 getDriver ()
 
 getInsertId ($table= '', $id= '', $callHooks=true)
 
 getType ($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)
 

Additional Inherited Members

- Public Attributes inherited from DAO
 $_dataSource
 

Detailed Description

DAO operations for the OJS Reading Tools interface.

See Also
RT

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

Member Function Documentation

& RTDAO::_returnContextFromRow ( $row)

Return RTContext object from database row.

Parameters
$rowarray
Returns
RTContext

Definition at line 454 of file RTDAO.inc.php.

References HookRegistry\call(), and getSearches().

Referenced by getContext().

& RTDAO::_returnSearchFromRow ( $row)

Return RTSearch object from database row.

Parameters
$rowarray
Returns
RTSearch

Definition at line 284 of file RTDAO.inc.php.

References HookRegistry\call().

Referenced by getSearch().

& RTDAO::_returnVersionFromRow ( $row)

Return RTVersion object from database row.

Parameters
$rowarray
Returns
RTVersion

Definition at line 263 of file RTDAO.inc.php.

References HookRegistry\call(), and getContexts().

Referenced by getVersion().

RTDAO::deleteContext (   $contextId,
  $versionId 
)

Delete a context.

Parameters
$contextIdint
$versionIdint

Definition at line 414 of file RTDAO.inc.php.

References deleteSearchesByContextId(), and DAO\update().

Referenced by deleteContextsByVersionId().

RTDAO::deleteContextsByVersionId (   $versionId)

Delete all contexts by version ID.

Parameters
$versionIdint

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

References deleteContext(), and getContexts().

Referenced by deleteVersion().

RTDAO::deleteSearch (   $searchId,
  $contextId 
)

Delete a search.

Parameters
$searchIdint
$contextIdint

Definition at line 585 of file RTDAO.inc.php.

References DAO\update().

RTDAO::deleteSearchesByContextId (   $contextId)

Delete all searches by context ID.

Parameters
$contextIdint

Definition at line 573 of file RTDAO.inc.php.

References DAO\update().

Referenced by deleteContext().

RTDAO::deleteVersion (   $versionId,
  $journalId 
)

Delete a version.

Parameters
$versionIdint
$journalIdint

Definition at line 235 of file RTDAO.inc.php.

References deleteContextsByVersionId(), and DAO\update().

Referenced by deleteVersionsByJournal(), and deleteVersionsByJournalId().

RTDAO::deleteVersionsByJournal (   $journalId)

Delete RT versions (and dependent entities) by journal ID.

Parameters
$journalIdint

Definition at line 250 of file RTDAO.inc.php.

References deleteVersion(), and getVersions().

RTDAO::deleteVersionsByJournalId (   $journalId)

Delete all versions by journal ID.

Parameters
$journalIdint

Definition at line 223 of file RTDAO.inc.php.

References deleteVersion(), and getVersions().

& RTDAO::getContext (   $contextId)

Retrieve an RT context.

Parameters
$contextIdint
Returns
RT

Definition at line 311 of file RTDAO.inc.php.

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

& RTDAO::getContexts (   $versionId,
  $pagingInfo = null 
)

Retrieve all RT contexts for a version (in order).

Parameters
$versionIdint
$pagingInfoobject DBResultRange (optional)
Returns
array RTContext

Definition at line 334 of file RTDAO.inc.php.

References DAO\retrieveRange().

Referenced by _returnVersionFromRow(), and deleteContextsByVersionId().

& RTDAO::getJournalRTByJournal ( $journal)

Retrieve an RT configuration.

Parameters
$journalIdint
Returns
RT

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

References RT\setEnabled().

& RTDAO::getSearch (   $searchId)

Retrieve an RT search.

Parameters
$searchIdint
Returns
RTSearch

Definition at line 486 of file RTDAO.inc.php.

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

& RTDAO::getSearches (   $contextId,
  $pagingInfo = null 
)

Retrieve all RT searches for a context (in order).

Parameters
$contextIdint
$pagingInfoobject DBResultRange (optional)
Returns
array RTSearch

Definition at line 509 of file RTDAO.inc.php.

References DAO\retrieveRange().

Referenced by _returnContextFromRow().

& RTDAO::getVersion (   $versionId,
  $journalId = null,
  $useCache = null 
)

Retrieve a version.

Parameters
$versionIdint
$journalIdint optional
Returns
RTVersion optional

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

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

& RTDAO::getVersions (   $journalId,
  $pagingInfo = null 
)

Retrieve all RT versions for a journal.

Parameters
$journalIdint
$pagingInfoobject DBResultRange (optional)
Returns
array RTVersion

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

References DAO\retrieveRange().

Referenced by deleteVersionsByJournal(), and deleteVersionsByJournalId().

RTDAO::insertContext ( $context)

Insert a context.

Parameters
$versionIdint
$contextRTContext

Definition at line 352 of file RTDAO.inc.php.

References DAO\getInsertId(), insertSearch(), and DAO\update().

Referenced by insertVersion().

RTDAO::insertJournalRT ( $rt)

Insert a new RT configuration.

Parameters
$rtobject

Definition at line 95 of file RTDAO.inc.php.

RTDAO::insertSearch ( $search)

Insert new search.

Parameters
$searchRTSearch

Definition at line 526 of file RTDAO.inc.php.

References DAO\getInsertId(), and DAO\update().

Referenced by insertContext().

RTDAO::insertVersion (   $journalId,
$version 
)

Insert a new version.

Parameters
$journalIdint
$versionRTVersion

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

References DAO\getInsertId(), insertContext(), and DAO\update().

RTDAO::resequenceContexts (   $versionId)

Sequentially renumber contexts in their sequence order.

Definition at line 426 of file RTDAO.inc.php.

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

RTDAO::resequenceSearches (   $contextId)

Sequentially renumber searches in their sequence order.

Definition at line 595 of file RTDAO.inc.php.

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

RTDAO::updateContext ( $context)

Update an existing context.

Parameters
$contextRTContext

Definition at line 385 of file RTDAO.inc.php.

References DAO\update().

RTDAO::updateSearch ( $search)

Update an existing search.

Parameters
$searchRTSearch

Definition at line 551 of file RTDAO.inc.php.

References DAO\update().

RTDAO::updateVersion (   $journalId,
$version 
)

Update an exisiting verison.

Parameters
$journalIdint
$versionRTVersion

Definition at line 195 of file RTDAO.inc.php.

References DAO\update().


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