Event Class Reference

Inheritance diagram for Event:

Collaboration diagram for Event:

Public Member Functions
	Event ($properties, $permission=NULL)
	getPermission ()
	setPermission ($perm)
	havePermission ($perm)
	getProperty ($property_name="")
	setProperty ($property_name, $value)
	setId ($id)
	getId ()
	getAccessibility ()
	getTitle ()
	getStart ()
	getEnd ()
	getCategory ()
	getStudipCategory ()
	getDescription ()
	getDuration ()
	getLocation ()
	getMakeDate ()
	getImportDate ()
	setMakeDate ($timestamp='')
	getChangeDate ()
	setChangeDate ($timestamp='')
	isModified ()
	setDescription ($description)
	setLocation ($location)
	setStart ($start)
	setEnd ($end)
	isDayEvent ()
	setDayEvent ()
	setCategory ($category)
	setTitle ($title='')
	toStringDate ($mod='SHORT')
	getExceptions ()
	getSeminarId ()

Data Fields
const	PERMISSION_FORBIDDEN = 0
const	PERMISSION_CONFIDENTIAL = 1
const	PERMISSION_READABLE = 2
const	PERMISSION_WRITABLE = 4
	$id
	$properties = array()
	$chng_flag = false
	$permission = Event::PERMISSION_WRITABLE

Member Function Documentation

Event()

Event	(		$properties,
			$permission = NULL
	)

Here is the call graph for this function:

getAccessibility()

getAccessibility

(

)

getCategory()

getCategory

(

)

Returns the categories.

public

Returns

String the categories

Here is the call graph for this function:

getChangeDate()

getChangeDate

(

)

Returns the unix timestamp of the last change

public

Here is the call graph for this function:

Here is the caller graph for this function:

getDescription()

getDescription

(

)

Returns the description.

If the description is not set it returns false.

public

Returns

String the description

Here is the call graph for this function:

Here is the caller graph for this function:

getDuration()

getDuration

(

)

Returns the duration of this event in seconds

public

Returns

int the duration of this event in seconds

Here is the call graph for this function:

getEnd()

getEnd

(

)

Returns the endtime of this event.

public

Returns

int the endtime of this event as a unix timestamp

Here is the caller graph for this function:

getExceptions()

getExceptions

(

)

getId()

getId

(

)

getImportDate()

getImportDate

(

)

Here is the call graph for this function:

getLocation()

getLocation

(

)

Returns the location. If the location is not set, it returns false.

public

Returns

String the location

Here is the call graph for this function:

Here is the caller graph for this function:

getMakeDate()

getMakeDate

(

)

Returns the unix timestamp of creating

public

Here is the call graph for this function:

Here is the caller graph for this function:

getPermission()

getPermission

(

)

getProperty()

getProperty

(

$property_name = ""

)

Here is the caller graph for this function:

getSeminarId()

getSeminarId

(

)

getStart()

getStart

(

)

Returns the starttime of this event.

public

Returns

int the starttime of this event as a unix timestamp

Here is the caller graph for this function:

getStudipCategory()

getStudipCategory

(

)

Returns the Stud.IP build in category as integer value. See config.inc.php $PERS_TERMIN_KAT.

public

Returns

int the categories

Here is the call graph for this function:

Here is the caller graph for this function:

getTitle()

getTitle

(

)

Returns the title of this event.

public

Returns

String the title of this event

Here is the call graph for this function:

Here is the caller graph for this function:

havePermission()

havePermission

(

$perm

)

Here is the caller graph for this function:

isDayEvent()

isDayEvent

(

)

Here is the call graph for this function:

Here is the caller graph for this function:

isModified()

isModified

(

)

Returns true if this event has been modified after creation

public

Returns

boolean

Here is the caller graph for this function:

setCategory()

setCategory

(

$category

)

Changes the category of this event. Only skeleton, overwrite this function in child classes.

See config.inc.php for further information and values of categories.

After calling this method, isModified() returns true.

public

Parameters

int

$category

a valid integer representation of a category (see config.inc.php)

Returns

boolean true if the value of $category is valid, otherwise false

setChangeDate()

setChangeDate

(

$timestamp = ''

)

Sets the unix timestamp of the last change

Access to this method is useful only from the container classes DbCalendarEventList, DbCalendarDay, DbCalendarMonth. Normally every modification of this object sets this value automatically. Nevertheless it is a public function.

public

Parameters

int

$timestamp

a valid unix timestamp

Here is the caller graph for this function:

setDayEvent()

setDayEvent

(

)

Here is the call graph for this function:

setDescription()

setDescription

(

$description

)

Changes the description.

After calling this method, isModified() returns true.

public

Parameters

String

$description

the description

setEnd()

setEnd

(

$end

)

Changes the endtime of this event.

After calling this method, isModified() returns true.

public

Parameters

int

$end

a valid unix timestamp

Here is the caller graph for this function:

setId()

setId

(

$id

)

setLocation()

setLocation

(

$location

)

Changes the location.

After calling this method, isModified() returns true.

public

Parameters

String

$location

the location

setMakeDate()

setMakeDate

(

$timestamp = ''

)

Sets the unix timestamp of the creation date

Access to this method is useful only from the container classes DbCalendarEventList, DbCalendarDay, DbCalendarMonth. Normally the constructor sets this timestamp.

public

Parameters

int

$timestamp

a valid unix timestamp

Here is the caller graph for this function:

setPermission()

setPermission

(

$perm

)

setProperty()

setProperty	(		$property_name,
			$value
	)

Here is the caller graph for this function:

setStart()

setStart

(

$start

)

Changes the starttime of this event.

After calling this method, isModified() returns true.

public

Parameters

int

$start

a valid unix timestamp

Here is the caller graph for this function:

setTitle()

setTitle

(

$title = ''

)

Changes the title of this event.

If no title is set it returns 'Kein Titel'.

After calling this method, isModified() returns true.

public

Parameters

String

$title

title of this event

toStringDate()

toStringDate

(

$mod = 'SHORT'

)

Returns the string representation of start- and end-time

Without parameters it returns the short version:
12:30 - 09:45
If $mod = 'LONG' it returns the long version:
Monday, 20.03.2004 12:30 - Tuesday, 21.03.2004 09:45
If $mod = 'SHORT_DAY' it returns the long version with short day names
Mo. 20.03.2004 12:30 - Tu. 21.03.2004 09:45

public

Parameters

String

$mod

'LONG', 'SHORT' or 'SHORT_DAY'

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$chng_flag

$chng_flag = false

$id

$id

$permission

$permission = Event::PERMISSION_WRITABLE

$properties

$properties = array()

PERMISSION_CONFIDENTIAL

const PERMISSION_CONFIDENTIAL = 1

PERMISSION_FORBIDDEN

const PERMISSION_FORBIDDEN = 0

PERMISSION_READABLE

const PERMISSION_READABLE = 2

PERMISSION_WRITABLE

const PERMISSION_WRITABLE = 4

---

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

• lib/calendar/lib/Event.class.php