Room Class Reference
[Scheduler]

Basic class describing a room. More...

List of all members.

Public Member Functions
	getAbbrev ($locale)
	getBuildingId ()
	getDescription ($locale)
	getName ($locale)
	getRoomAbbrev ()
	getRoomDescription ()
	getRoomId ()
	getRoomName ()
	setAbbrev ($abbrev, $locale)
	setBuildingId ($buildingId)
	setDescription ($description, $locale)
	setName ($name, $locale)
	setRoomId ($roomId)

---

Detailed Description

Basic class describing a room.

See also:

RoomDAO

Definition at line 18 of file Room.inc.php.

---

Member Function Documentation

Room.getAbbrev

(

$

locale

)

Get the abbreviation of the room.

Parameters:

$locale

string

Returns:

string

Definition at line 96 of file Room.inc.php.

Room.getBuildingId

(

)

Get the building ID of the room.

Returns:

int

Definition at line 45 of file Room.inc.php.

Room.getDescription

(

$

locale

)

Get the description of the room.

Parameters:

$locale

string

Returns:

string

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

Room.getName

(

$

locale

)

Get the name of the room.

Parameters:

$locale

string

Returns:

string

Definition at line 70 of file Room.inc.php.

Room.getRoomAbbrev

(

)

Get the localized abbreviation of the room.

Returns:

string

Definition at line 87 of file Room.inc.php.

Room.getRoomDescription

(

)

Get the localized description of the room.

Returns:

string

Definition at line 113 of file Room.inc.php.

Room.getRoomId

(

)

Get the ID of the room.

Returns:

int

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

Room.getRoomName

(

)

Get the localized name of the room.

Returns:

string

Definition at line 61 of file Room.inc.php.

Room.setAbbrev	(	$	abbrev,
		$	locale
	)

Set the abbreviation of the room.

Parameters:

	$abbrev	string
	$locale	string

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

Room.setBuildingId

(

$

buildingId

)

Set the building ID of the room.

Parameters:

$buildingId

int

Definition at line 53 of file Room.inc.php.

Room.setDescription	(	$	description,
		$	locale
	)

Set the description of the room.

Parameters:

	$description	string
	$locale	string

Definition at line 131 of file Room.inc.php.

Room.setName	(	$	name,
		$	locale
	)

Set the name of the room.

Parameters:

	$name	string
	$locale	string

Definition at line 79 of file Room.inc.php.

Room.setRoomId

(

$

roomId

)

Set the ID of the room.

Parameters:

$roomId

int

Definition at line 36 of file Room.inc.php.

---

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

• classes/scheduler/Room.inc.php

---