BuildingDAO Class Reference
[Scheduler]

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

List of all members.

Public Member Functions
&	_returnBuildingFromRow (&$row)
	buildingExistsForSchedConf ($buildingId, $schedConfId)
	deleteBuilding ($building)
	deleteBuildingById ($buildingId)
	deleteBuildingsBySchedConfId ($schedConfId)
&	getBuilding ($buildingId)
&	getBuildingsBySchedConfId ($schedConfId, $rangeInfo=null)
	getBuildingSchedConfId ($buildingId)
	getInsertBuildingId ()
	getLocaleFieldNames ()
	insertBuilding (&$building)
	updateBuilding (&$building)
	updateLocaleFields (&$building)

---

Detailed Description

Operations for retrieving and modifying Building objects.

See also:

Building

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

---

Member Function Documentation

& BuildingDAO._returnBuildingFromRow

(

&$

row

)

Internal function to return a Building object from a row.

Parameters:

$row

array

Returns:

Building

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

Referenced by getBuilding(), and getBuildingsBySchedConfId().

BuildingDAO.buildingExistsForSchedConf	(	$	buildingId,
		$	schedConfId
	)

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

Parameters:

	$buildingId	int
	$schedConfId	int

Returns:

boolean

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

BuildingDAO.deleteBuilding

(

$

building

)

Delete a building and all dependent items.

Parameters:

$building

Building

Returns:

boolean

Definition at line 154 of file BuildingDAO.inc.php.

References deleteBuildingById().

Referenced by deleteBuildingsBySchedConfId().

BuildingDAO.deleteBuildingById

(

$

buildingId

)

Delete a building by ID. Deletes dependents.

Parameters:

$buildingId

int

Returns:

boolean

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

Referenced by deleteBuilding().

BuildingDAO.deleteBuildingsBySchedConfId

(

$

schedConfId

)

Delete buildings by scheduled conference ID.

Parameters:

$conferenceId

int

Definition at line 177 of file BuildingDAO.inc.php.

References deleteBuilding(), and getBuildingsBySchedConfId().

& BuildingDAO.getBuilding

(

$

buildingId

)

Retrieve a building by ID.

Parameters:

$buildingId

int

Returns:

object Building

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

References _returnBuildingFromRow().

& BuildingDAO.getBuildingsBySchedConfId	(	$	schedConfId,
		$	rangeInfo = null
	)

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

Parameters:

$schedConfId

int

Returns:

object DAOResultFactory containing matching Buildings

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

References _returnBuildingFromRow().

Referenced by deleteBuildingsBySchedConfId().

BuildingDAO.getBuildingSchedConfId

(

$

buildingId

)

Retrieve building sched conf ID by building ID.

Parameters:

$buildingId

int

Returns:

int

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

BuildingDAO.getInsertBuildingId

(

)

Get the ID of the last inserted building.

Returns:

int

Definition at line 205 of file BuildingDAO.inc.php.

Referenced by insertBuilding().

BuildingDAO.getLocaleFieldNames

(

)

Retrieve a list of localized fields for this object.

Returns:

array

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

BuildingDAO.insertBuilding

(

&$

building

)

Insert a new Building.

Parameters:

$building

Building

Returns:

int

Definition at line 114 of file BuildingDAO.inc.php.

References getInsertBuildingId(), and updateLocaleFields().

BuildingDAO.updateBuilding

(

&$

building

)

Update an existing building.

Parameters:

$building

Building

Returns:

boolean

Definition at line 134 of file BuildingDAO.inc.php.

References updateLocaleFields().

BuildingDAO.updateLocaleFields

(

&$

building

)

Update the localized settings for this object

Parameters:

$building

object

Definition at line 103 of file BuildingDAO.inc.php.

Referenced by insertBuilding(), and updateBuilding().

---

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

• classes/scheduler/BuildingDAO.inc.php

---