TimeBlock Class Reference

List of all members.

Public Member Functions
	getAssignedColour ()
	getEndTime ()
	getName ($locale)
	getSchedConfId ()
	getStartTime ()
	getTimeBlockId ()
	getUnassignedColour ()
	setAssignedColour ($assignedColour)
	setEndTime ($endTime)
	setName ($name, $locale)
	setSchedConfId ($schedConfId)
	setStartTime ($startTime)
	setTimeBlockId ($timeBlockId)
	setUnassignedColour ($unassignedColour)

---

Detailed Description

TimeBlock class. Basic class describing a block of time available for scheduling.

$Id$

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

---

Member Function Documentation

TimeBlock.getAssignedColour

(

)

Get the colour of this time block for use when it has been assigned to a presentation or special event.

Returns:

string

Definition at line 111 of file TimeBlock.inc.php.

TimeBlock.getEndTime

(

)

Get the end time of the timeBlock.

Returns:

string

Definition at line 77 of file TimeBlock.inc.php.

TimeBlock.getName

(

$

locale

)

Get the name of the time block.

Parameters:

$locale

string

Returns:

string

Definition at line 94 of file TimeBlock.inc.php.

TimeBlock.getSchedConfId

(

)

Get the sched conf ID of the timeBlock.

Returns:

int

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

TimeBlock.getStartTime

(

)

Get the start time of the timeBlock.

Returns:

string

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

TimeBlock.getTimeBlockId

(

)

Get the ID of the timeBlock.

Returns:

int

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

TimeBlock.getUnassignedColour

(

)

Get the colour of this time block for use when it has not been assigned to a presentation or special event.

Returns:

string

Definition at line 127 of file TimeBlock.inc.php.

TimeBlock.setAssignedColour

(

$

assignedColour

)

Set the colour of this time block for use when it has been assigned to a presentation or special event.

Parameters:

$assignedColour

string

Definition at line 119 of file TimeBlock.inc.php.

TimeBlock.setEndTime

(

$

endTime

)

Set the end time of the timeBlock.

Parameters:

$endTime

string

Definition at line 85 of file TimeBlock.inc.php.

TimeBlock.setName	(	$	name,
		$	locale
	)

Set the name of the time block.

Parameters:

	$name	string
	$locale	string

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

TimeBlock.setSchedConfId

(

$

schedConfId

)

Set the sched conf ID of the timeBlock.

Parameters:

$schedConfId

int

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

TimeBlock.setStartTime

(

$

startTime

)

Set the start time of the timeBlock.

Parameters:

$startTime

string

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

TimeBlock.setTimeBlockId

(

$

timeBlockId

)

Set the ID of the timeBlock.

Parameters:

$timeBlockId

int

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

TimeBlock.setUnassignedColour

(

$

unassignedColour

)

Set the colour of this time block for use when it has not been assigned to a presentation or special event.

Parameters:

$unassignedColour

string

Definition at line 135 of file TimeBlock.inc.php.

---

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

• classes/scheduler/TimeBlock.inc.php

---