RTDAO Class Reference
[Rt_ocs]

DAO operations for the OCS Reading Tools interface. More...

List of all members.

Public Member Functions

_returnContextFromRow (&$row)
_returnSearchFromRow (&$row)
_returnVersionFromRow (&$row)
 deleteContext ($contextId, $versionId)
 deleteContextsByVersionId ($versionId)
 deleteSearch ($searchId, $contextId)
 deleteSearchesByContextId ($contextId)
 deleteVersion ($versionId, $conferenceId)
 deleteVersionsByConference ($conferenceId)
 deleteVersionsByConferenceId ($conferenceId)
getConferenceRTByConference (&$conference)
getContext ($contextId)
getContexts ($versionId, $pagingInfo=null)
getSearch ($searchId)
getSearches ($contextId, $pagingInfo=null)
getVersion ($versionId, $conferenceId)
getVersions ($conferenceId, $pagingInfo=null)
 insertConferenceRT (&$rt)
 insertContext (&$context)
 insertSearch (&$search)
 insertVersion ($conferenceId, &$version)
 resequenceContexts ($versionId)
 resequenceSearches ($contextId)
 updateConferenceRT (&$rt)
 updateContext (&$context)
 updateSearch (&$search)
 updateVersion ($conferenceId, &$version)


Detailed Description

DAO operations for the OCS Reading Tools interface.

See also:
RT

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


Member Function Documentation

& RTDAO._returnContextFromRow ( &$  row  ) 

Return RTContext object from database row.

Parameters:
$row array
Returns:
RTContext

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

References getSearches().

Referenced by getContext(), and getContexts().

& RTDAO._returnSearchFromRow ( &$  row  ) 

Return RTSearch object from database row.

Parameters:
$row array
Returns:
RTSearch

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

Referenced by getSearch(), and getSearches().

& RTDAO._returnVersionFromRow ( &$  row  ) 

Return RTVersion object from database row.

Parameters:
$row array
Returns:
RTVersion

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

References getContexts().

Referenced by getVersion(), and getVersions().

RTDAO.deleteContext ( contextId,
versionId 
)

Delete a context.

Parameters:
$contextId int
$versionId int

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

References deleteSearchesByContextId().

Referenced by deleteContextsByVersionId().

RTDAO.deleteContextsByVersionId ( versionId  ) 

Delete all contexts by version ID.

Parameters:
$versionId int

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

References deleteContext(), and getContexts().

Referenced by deleteVersion().

RTDAO.deleteSearch ( searchId,
contextId 
)

Delete a search.

Parameters:
$searchId int
$contextId int

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

RTDAO.deleteSearchesByContextId ( contextId  ) 

Delete all searches by context ID.

Parameters:
$contextId int

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

Referenced by deleteContext().

RTDAO.deleteVersion ( versionId,
conferenceId 
)

Delete a version.

Parameters:
$versionId int
$conferenceId int

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

References deleteContextsByVersionId().

Referenced by deleteVersionsByConference(), and deleteVersionsByConferenceId().

RTDAO.deleteVersionsByConference ( conferenceId  ) 

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

Parameters:
$conferenceId int

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

References deleteVersion(), and getVersions().

RTDAO.deleteVersionsByConferenceId ( conferenceId  ) 

Delete all versions by conference ID.

Parameters:
$conferenceId int

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

References deleteVersion(), and getVersions().

& RTDAO.getConferenceRTByConference ( &$  conference  ) 

Retrieve an RT configuration.

Parameters:
$conferenceId int
Returns:
RT

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

& RTDAO.getContext ( contextId  ) 

Retrieve an RT context.

Parameters:
$contextId int
Returns:
RT

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

References _returnContextFromRow().

& RTDAO.getContexts ( versionId,
pagingInfo = null 
)

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

Parameters:
$versionId int
$pagingInfo object DBResultRange (optional)
Returns:
array RTContext

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

References _returnContextFromRow().

Referenced by _returnVersionFromRow(), and deleteContextsByVersionId().

& RTDAO.getSearch ( searchId  ) 

Retrieve an RT search.

Parameters:
$searchId int
Returns:
RTSearch

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

References _returnSearchFromRow().

& RTDAO.getSearches ( contextId,
pagingInfo = null 
)

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

Parameters:
$contextId int
$pagingInfo object DBResultRange (optional)
Returns:
array RTSearch

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

References _returnSearchFromRow().

Referenced by _returnContextFromRow().

& RTDAO.getVersion ( versionId,
conferenceId 
)

Retrieve a version.

Parameters:
$versionId int
$conferenceId int
Returns:
RTVersion

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

References _returnVersionFromRow().

Referenced by updateConferenceRT().

& RTDAO.getVersions ( conferenceId,
pagingInfo = null 
)

Retrieve all RT versions for a conference.

Parameters:
$conferenceId int
$pagingInfo object DBResultRange (optional)
Returns:
array RTVersion

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

References _returnVersionFromRow().

Referenced by deleteVersionsByConference(), and deleteVersionsByConferenceId().

RTDAO.insertConferenceRT ( &$  rt  ) 

Insert a new RT configuration.

Parameters:
$rt object

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

References updateConferenceRT().

RTDAO.insertContext ( &$  context  ) 

Insert a context.

Parameters:
$versionId int
$context RTContext

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

References insertSearch().

Referenced by insertVersion().

RTDAO.insertSearch ( &$  search  ) 

Insert new search.

Parameters:
$search RTSearch

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

Referenced by insertContext().

RTDAO.insertVersion ( conferenceId,
&$  version 
)

Insert a new version.

Parameters:
$conferenceId int
$version RTVersion

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

References insertContext().

RTDAO.resequenceContexts ( versionId  ) 

Sequentially renumber contexts in their sequence order.

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

RTDAO.resequenceSearches ( contextId  ) 

Sequentially renumber searches in their sequence order.

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

RTDAO.updateContext ( &$  context  ) 

Update an existing context.

Parameters:
$context RTContext

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

RTDAO.updateSearch ( &$  search  ) 

Update an existing search.

Parameters:
$search RTSearch

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

RTDAO.updateVersion ( conferenceId,
&$  version 
)

Update an exisiting verison.

Parameters:
$conferenceId int
$version RTVersion

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


The documentation for this class was generated from the following file:
Generated on 25 Jul 2013 for Open Conference Systems by  doxygen 1.4.7