SpecialEventDAO Class Reference
[Scheduler]

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

List of all members.

Public Member Functions
&	_returnSpecialEventFromRow (&$row)
	deleteSpecialEvent ($specialEvent)
	deleteSpecialEventById ($specialEventId)
	deleteSpecialEventsBySchedConfId ($schedConfId)
	getInsertSpecialEventId ()
	getLocaleFieldNames ()
&	getSpecialEvent ($specialEventId)
&	getSpecialEventsBySchedConfId ($schedConfId, $rangeInfo=null)
	getSpecialEventSchedConfId ($specialEventId)
	insertSpecialEvent (&$specialEvent)
	specialEventExistsForSchedConf ($specialEventId, $schedConfId)
	updateLocaleFields (&$specialEvent)
	updateSpecialEvent (&$specialEvent)

---

Detailed Description

Operations for retrieving and modifying SpecialEvent objects.

See also:

SpecialEvent

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

---

Member Function Documentation

& SpecialEventDAO._returnSpecialEventFromRow

(

&$

row

)

Internal function to return a SpecialEvent object from a row.

Parameters:

$row

array

Returns:

SpecialEvent

Definition at line 90 of file SpecialEventDAO.inc.php.

Referenced by getSpecialEvent(), and getSpecialEventsBySchedConfId().

SpecialEventDAO.deleteSpecialEvent

(

$

specialEvent

)

Delete a special event and all dependent items.

Parameters:

$specialEvent

SpecialEvent

Returns:

boolean

Definition at line 159 of file SpecialEventDAO.inc.php.

References deleteSpecialEventById().

Referenced by deleteSpecialEventsBySchedConfId().

SpecialEventDAO.deleteSpecialEventById

(

$

specialEventId

)

Delete a special event by ID. Deletes dependents.

Parameters:

$specialEventId

int

Returns:

boolean

Definition at line 168 of file SpecialEventDAO.inc.php.

Referenced by deleteSpecialEvent().

SpecialEventDAO.deleteSpecialEventsBySchedConfId

(

$

schedConfId

)

Delete special events by scheduled conference ID.

Parameters:

$conferenceId

int

Definition at line 178 of file SpecialEventDAO.inc.php.

References deleteSpecialEvent(), and getSpecialEventsBySchedConfId().

SpecialEventDAO.getInsertSpecialEventId

(

)

Get the ID of the last inserted special event.

Returns:

int

Definition at line 201 of file SpecialEventDAO.inc.php.

Referenced by insertSpecialEvent().

SpecialEventDAO.getLocaleFieldNames

(

)

Retrieve a list of localized fields for this object.

Returns:

array

Definition at line 81 of file SpecialEventDAO.inc.php.

& SpecialEventDAO.getSpecialEvent

(

$

specialEventId

)

Retrieve a special event by ID.

Parameters:

$specialEventId

int

Returns:

object SpecialEvent

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

References _returnSpecialEventFromRow().

& SpecialEventDAO.getSpecialEventsBySchedConfId	(	$	schedConfId,
		$	rangeInfo = null
	)

Retrieve an array of special events matching a particular sched conf ID.

Parameters:

$schedConfId

int

Returns:

object DAOResultFactory containing matching special events

Definition at line 191 of file SpecialEventDAO.inc.php.

References _returnSpecialEventFromRow().

Referenced by deleteSpecialEventsBySchedConfId().

SpecialEventDAO.getSpecialEventSchedConfId

(

$

specialEventId

)

Retrieve special event sched conf ID by special_event ID.

Parameters:

$specialEventId

int

Returns:

int

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

SpecialEventDAO.insertSpecialEvent

(

&$

specialEvent

)

Insert a new SpecialEvent.

Parameters:

$specialEvent

SpecialEvent

Returns:

int

Definition at line 116 of file SpecialEventDAO.inc.php.

References getInsertSpecialEventId(), and updateLocaleFields().

SpecialEventDAO.specialEventExistsForSchedConf	(	$	specialEventId,
		$	schedConfId
	)

Check if a special event exists with the given special event id for a sched conf.

Parameters:

	$specialEventId	int
	$schedConfId	int

Returns:

boolean

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

SpecialEventDAO.updateLocaleFields

(

&$

specialEvent

)

Update the localized settings for this object

Parameters:

$specialEvent

object

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

Referenced by insertSpecialEvent(), and updateSpecialEvent().

SpecialEventDAO.updateSpecialEvent

(

&$

specialEvent

)

Update an existing special event.

Parameters:

$specialEvent

SpecialEvent

Returns:

boolean

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

References updateLocaleFields().

---

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

• classes/scheduler/SpecialEventDAO.inc.php

---