RoomDAO Class Reference
[Scheduler]

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

List of all members.

Public Member Functions

_returnRoomFromRow (&$row)
 deleteRoom ($room)
 deleteRoomById ($roomId)
 deleteRoomsByBuildingId ($buildingId)
 getInsertRoomId ()
 getLocaleFieldNames ()
getRoom ($roomId)
 getRoomBuildingId ($roomId)
getRoomsByBuildingId ($buildingId, $rangeInfo=null)
 getRoomSchedConfId ($roomId)
 insertRoom (&$room)
 updateLocaleFields (&$room)
 updateRoom (&$room)


Detailed Description

Operations for retrieving and modifying Room objects.

See also:
Room

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


Member Function Documentation

& RoomDAO._returnRoomFromRow ( &$  row  ) 

Internal function to return a Room object from a row.

Parameters:
$row array
Returns:
Room

Definition at line 78 of file RoomDAO.inc.php.

Referenced by getRoom(), and getRoomsByBuildingId().

RoomDAO.deleteRoom ( room  ) 

Delete a room and all dependent items.

Parameters:
$room Room
Returns:
boolean

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

References deleteRoomById().

Referenced by deleteRoomsByBuildingId().

RoomDAO.deleteRoomById ( roomId  ) 

Delete a room by ID. Deletes dependents.

Parameters:
$roomId int
Returns:
boolean

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

Referenced by deleteRoom().

RoomDAO.deleteRoomsByBuildingId ( buildingId  ) 

Delete rooms by scheduled conference ID.

Parameters:
$buildingId int

Definition at line 161 of file RoomDAO.inc.php.

References deleteRoom(), and getRoomsByBuildingId().

RoomDAO.getInsertRoomId (  ) 

Get the ID of the last inserted room.

Returns:
int

Definition at line 189 of file RoomDAO.inc.php.

Referenced by insertRoom().

RoomDAO.getLocaleFieldNames (  ) 

Retrieve a list of localized fields for this object.

Returns:
array

Definition at line 69 of file RoomDAO.inc.php.

& RoomDAO.getRoom ( roomId  ) 

Retrieve a room by ID.

Parameters:
$roomId int
Returns:
object Room

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

References _returnRoomFromRow().

RoomDAO.getRoomBuildingId ( roomId  ) 

Retrieve room building ID by room ID.

Parameters:
$roomId int
Returns:
int

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

& RoomDAO.getRoomsByBuildingId ( buildingId,
rangeInfo = null 
)

Retrieve an array of rooms matching a particular building ID.

Parameters:
$buildingId int
Returns:
object DAOResultFactory containing matching Rooms

Definition at line 174 of file RoomDAO.inc.php.

References _returnRoomFromRow().

Referenced by deleteRoomsByBuildingId().

RoomDAO.getRoomSchedConfId ( roomId  ) 

Retrieve sched conf ID by room ID.

Parameters:
$roomId int
Returns:
int

Definition at line 57 of file RoomDAO.inc.php.

RoomDAO.insertRoom ( &$  room  ) 

Insert a new Room.

Parameters:
$room Room
Returns:
int

Definition at line 102 of file RoomDAO.inc.php.

References getInsertRoomId(), and updateLocaleFields().

RoomDAO.updateLocaleFields ( &$  room  ) 

Update the localized settings for this object

Parameters:
$room object

Definition at line 91 of file RoomDAO.inc.php.

Referenced by insertRoom(), and updateRoom().

RoomDAO.updateRoom ( &$  room  ) 

Update an existing room.

Parameters:
$room Room
Returns:
boolean

Definition at line 122 of file RoomDAO.inc.php.

References updateLocaleFields().


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