SchedConfDAO Class Reference
[SchedConf]

Operations for retrieving and modifying SchedConf objects. More...

List of all members.

Public Member Functions

_returnSchedConfFromRow (&$row)
 archivedSchedConfsExist ($conferenceId)
 currentSchedConfsExist ($conferenceId)
 deleteSchedConf (&$schedConf)
 deleteSchedConfById ($schedConfId)
 deleteSchedConfsByConferenceId ($conferenceId)
getCurrentSchedConfs ($conferenceId)
getEnabledSchedConfs ($conferenceId=null)
 getInsertSchedConfId ()
getSchedConf ($schedConfId, $conferenceId=null)
getSchedConfByPath ($path, $conferenceId=null)
getSchedConfs ($rangeInfo=null)
getSchedConfsByConferenceId ($conferenceId, $rangeInfo=null)
getSchedConfTitles ($conferenceId)
 insertSchedConf (&$schedConf)
 resequenceSchedConfs ($conferenceId)
 schedConfExistsByPath ($path)
 updateSchedConf (&$schedConf)


Detailed Description

Operations for retrieving and modifying SchedConf objects.

See also:
SchedConf

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


Member Function Documentation

& SchedConfDAO._returnSchedConfFromRow ( &$  row  ) 

Internal function to return a scheduled conference object from a row.

Parameters:
$row array
Returns:
SchedConf

Definition at line 76 of file SchedConfDAO.inc.php.

Referenced by getCurrentSchedConfs(), getEnabledSchedConfs(), getSchedConf(), getSchedConfByPath(), getSchedConfs(), and getSchedConfsByConferenceId().

SchedConfDAO.archivedSchedConfsExist ( conferenceId  ) 

Check if one or more archived scheduled conferences exist for a conference.

Parameters:
$conferenceId the conference owning the scheduled conference
Returns:
boolean

Definition at line 342 of file SchedConfDAO.inc.php.

SchedConfDAO.currentSchedConfsExist ( conferenceId  ) 

Check if one or more archived scheduled conferences exist for a conference.

Parameters:
$conferenceId the conference owning the scheduled conference
Returns:
boolean

Definition at line 359 of file SchedConfDAO.inc.php.

SchedConfDAO.deleteSchedConf ( &$  schedConf  ) 

Delete a scheduled conference, INCLUDING ALL DEPENDENT ITEMS.

Parameters:
$schedConf SchedConf

Definition at line 142 of file SchedConfDAO.inc.php.

References deleteSchedConfById().

SchedConfDAO.deleteSchedConfById ( schedConfId  ) 

Delete a scheduled conference by ID, INCLUDING ALL DEPENDENT ITEMS.

Parameters:
$schedConfId int

Definition at line 196 of file SchedConfDAO.inc.php.

Referenced by deleteSchedConf(), and deleteSchedConfsByConferenceId().

SchedConfDAO.deleteSchedConfsByConferenceId ( conferenceId  ) 

Delete all scheduled conferences by conference ID.

Parameters:
$schedConfId int

Definition at line 183 of file SchedConfDAO.inc.php.

References deleteSchedConfById(), and getSchedConfsByConferenceId().

& SchedConfDAO.getCurrentSchedConfs ( conferenceId  ) 

Retrieve most recent enabled scheduled conference of a given conference

Returns:
array SchedConfs ordered by sequence

Definition at line 322 of file SchedConfDAO.inc.php.

References _returnSchedConfFromRow().

& SchedConfDAO.getEnabledSchedConfs ( conferenceId = null  ) 

Retrieve all scheduled conferences

Parameters:
conferenceId optional conference ID
Returns:
array SchedConfs ordered by sequence

Definition at line 254 of file SchedConfDAO.inc.php.

References _returnSchedConfFromRow().

SchedConfDAO.getInsertSchedConfId (  ) 

Get the ID of the last inserted scheduled conference.

Returns:
int

Definition at line 314 of file SchedConfDAO.inc.php.

Referenced by insertSchedConf().

& SchedConfDAO.getSchedConf ( schedConfId,
conferenceId = null 
)

Retrieve a scheduled conference by ID.

Parameters:
$schedConfId int
$conferenceId int optional
Returns:
SchedConf

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

References _returnSchedConfFromRow().

& SchedConfDAO.getSchedConfByPath ( path,
conferenceId = null 
)

Retrieve a scheduled conference by path.

Parameters:
$path string
Returns:
SchedConf

Definition at line 48 of file SchedConfDAO.inc.php.

References _returnSchedConfFromRow(), and Request.getConference().

& SchedConfDAO.getSchedConfs ( rangeInfo = null  ) 

Retrieve all scheduled conferences.

Returns:
DAOResultFactory containing matching scheduled conferences

Definition at line 239 of file SchedConfDAO.inc.php.

References _returnSchedConfFromRow().

& SchedConfDAO.getSchedConfsByConferenceId ( conferenceId,
rangeInfo = null 
)

Retrieves all scheduled conferences for a conference

Parameters:
$conferenceId 
$rangeInfo object

Definition at line 165 of file SchedConfDAO.inc.php.

References _returnSchedConfFromRow().

Referenced by deleteSchedConfsByConferenceId(), and getSchedConfTitles().

& SchedConfDAO.getSchedConfTitles ( conferenceId  ) 

Retrieve the IDs and titles of all scheduled conferences for a conference in an associative array.

Returns:
array

Definition at line 150 of file SchedConfDAO.inc.php.

References getSchedConfsByConferenceId().

SchedConfDAO.insertSchedConf ( &$  schedConf  ) 

Insert a new scheduled conference.

Parameters:
$schedConf SchedConf

Definition at line 94 of file SchedConfDAO.inc.php.

References getInsertSchedConfId().

SchedConfDAO.resequenceSchedConfs ( conferenceId  ) 

Sequentially renumber scheduled conferences in their sequence order.

Definition at line 287 of file SchedConfDAO.inc.php.

SchedConfDAO.schedConfExistsByPath ( path  ) 

Check if a scheduled conference exists with a specified path.

Parameters:
$path the path of the scheduled conference
Returns:
boolean

Definition at line 272 of file SchedConfDAO.inc.php.

SchedConfDAO.updateSchedConf ( &$  schedConf  ) 

Update an existing scheduled conference.

Parameters:
$schedConf SchedConf

Definition at line 117 of file SchedConfDAO.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