TimeBlockDAO Class Reference

List of all members.

Public Member Functions
&	_returnTimeBlockFromRow (&$row)
	deleteTimeBlock ($timeBlock)
	deleteTimeBlockById ($timeBlockId)
	deleteTimeBlocksBySchedConfId ($schedConfId)
	getInsertTimeBlockId ()
	getLocaleFieldNames ()
&	getTimeBlock ($timeBlockId)
&	getTimeBlocksBySchedConfId ($schedConfId, $rangeInfo=null)
	getTimeBlockSchedConfId ($timeBlockId)
	insertTimeBlock (&$timeBlock)
	timeBlockExistsForSchedConf ($timeBlockId, $schedConfId)
	timeBlocksExistForSchedConf ($schedConfId)
	updateLocaleFields (&$timeBlock)
	updateTimeBlock (&$timeBlock)

---

Detailed Description

Class for TimeBlock DAO. Operations for retrieving and modifying TimeBlock objects.

$Id$

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

---

Member Function Documentation

& TimeBlockDAO._returnTimeBlockFromRow

(

&$

row

)

Internal function to return a TimeBlock object from a row.

Parameters:

$row

array

Returns:

TimeBlock

Definition at line 110 of file TimeBlockDAO.inc.php.

Referenced by getTimeBlock(), and getTimeBlocksBySchedConfId().

TimeBlockDAO.deleteTimeBlock

(

$

timeBlock

)

Delete a timeBlock and all dependent items.

Parameters:

$timeBlock

TimeBlock

Returns:

boolean

Definition at line 190 of file TimeBlockDAO.inc.php.

References deleteTimeBlockById().

Referenced by deleteTimeBlocksBySchedConfId().

TimeBlockDAO.deleteTimeBlockById

(

$

timeBlockId

)

Delete a timeBlock by ID. Deletes dependents.

Parameters:

$timeBlockId

int

Returns:

boolean

Definition at line 199 of file TimeBlockDAO.inc.php.

Referenced by deleteTimeBlock().

TimeBlockDAO.deleteTimeBlocksBySchedConfId

(

$

schedConfId

)

Delete time blocks by scheduled conference ID.

Parameters:

$conferenceId

int

Definition at line 209 of file TimeBlockDAO.inc.php.

References deleteTimeBlock(), and getTimeBlocksBySchedConfId().

TimeBlockDAO.getInsertTimeBlockId

(

)

Get the ID of the last inserted timeBlock.

Returns:

int

Definition at line 237 of file TimeBlockDAO.inc.php.

Referenced by insertTimeBlock().

TimeBlockDAO.getLocaleFieldNames

(

)

Retrieve a list of localized fields for this object.

Returns:

array

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

& TimeBlockDAO.getTimeBlock

(

$

timeBlockId

)

Retrieve a timeBlock by ID.

Parameters:

$timeBlockId

int

Returns:

object TimeBlock

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

References _returnTimeBlockFromRow().

& TimeBlockDAO.getTimeBlocksBySchedConfId	(	$	schedConfId,
		$	rangeInfo = null
	)

Retrieve an array of timeBlocks matching a particular sched conf ID.

Parameters:

$schedConfId

int

Returns:

object DAOResultFactory containing matching TimeBlocks

Definition at line 222 of file TimeBlockDAO.inc.php.

References _returnTimeBlockFromRow().

Referenced by deleteTimeBlocksBySchedConfId().

TimeBlockDAO.getTimeBlockSchedConfId

(

$

timeBlockId

)

Retrieve timeBlock sched conf ID by time block ID.

Parameters:

$timeBlockId

int

Returns:

int

Definition at line 44 of file TimeBlockDAO.inc.php.

TimeBlockDAO.insertTimeBlock

(

&$

timeBlock

)

Insert a new TimeBlock.

Parameters:

$timeBlock

TimeBlock

Returns:

int

Definition at line 137 of file TimeBlockDAO.inc.php.

References getInsertTimeBlockId(), and updateLocaleFields().

TimeBlockDAO.timeBlockExistsForSchedConf	(	$	timeBlockId,
		$	schedConfId
	)

Check if a timeBlock exists with the given time block id for a sched conf.

Parameters:

	$timeBlockId	int
	$schedConfId	int

Returns:

boolean

Definition at line 58 of file TimeBlockDAO.inc.php.

TimeBlockDAO.timeBlocksExistForSchedConf

(

$

schedConfId

)

Check if any timeBlock exists for a sched conf.

Parameters:

$schedConfId

int

Returns:

boolean

Definition at line 82 of file TimeBlockDAO.inc.php.

TimeBlockDAO.updateLocaleFields

(

&$

timeBlock

)

Update the localized settings for this object

Parameters:

$timeBlock

object

Definition at line 126 of file TimeBlockDAO.inc.php.

Referenced by insertTimeBlock(), and updateTimeBlock().

TimeBlockDAO.updateTimeBlock

(

&$

timeBlock

)

Update an existing timeBlock.

Parameters:

$timeBlock

TimeBlock

Returns:

boolean

Definition at line 163 of file TimeBlockDAO.inc.php.

References updateLocaleFields().

---

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

• classes/scheduler/TimeBlockDAO.inc.php

---