CalendarEvent Class Reference

Inheritance diagram for CalendarEvent:

Collaboration diagram for CalendarEvent:

Public Member Functions
	CalendarEvent ($properties, $id= '')
	getExpire ()
	toStringCategories ()
	isDayEvent ()
	setDayEvent ($is_dev)
	getTs ()
	getUserId ()
	getRepeat ($index= '')
	getType ()
	setType ($type)
	getPriority ()
	setPriority ($priority)
	toStringPriority ()
	toStringAccessibility ()
	setRepeat ($r_rule)
	createRepeat ($r_rule, $start, $end)
	getUid ()
	getCategory ()
	getCategoryStyle ($image_size= 'small')
	createUniqueId ()
	toStringRecurrence ()
	getExceptions ()
	setExceptions ($exceptions)
	toStringDate ($mod= 'SHORT')
&	getClone ()
Public Member Functions inherited from Event
	Event ($properties)
	getProperty ($property_name="")
	setProperty ($property_name, $value)
	setId ($id)
	getId ()
	getTitle ()
	getStart ()
	getEnd ()
	getStudipCategory ()
	getDescription ()
	getDuration ()
	getLocation ()
	getMakeDate ()
	setMakeDate ($timestamp="")
	getChangeDate ()
	setChangeDate ($timestamp="")
	isModified ()
	setDescription ($description)
	setLocation ($location)
	setStart ($start)
	setEnd ($end)
	setCategory ($category)
	setTitle ($title= '')

Data Fields
	$ts
	$user_id
	$dev = FALSE
Data Fields inherited from Event
	$id
	$properties = array()
	$chng_flag = FALSE

Member Function Documentation

CalendarEvent	(		$properties,
			$id = ''
	)

Here is the call graph for this function:

Here is the caller graph for this function:

createRepeat	(		$r_rule,
			$start,
			$end
	)

Sets the recurrence rule of this event

The possible repetitions are: SINGLE, DAILY, WEEKLY, MONTHLY, YEARLY

Here is the caller graph for this function:

createUniqueId

(

)

Returns a unique ID

public

Returns

String the unique ID

Here is the caller graph for this function:

getCategory

(

)

Returns the index of a category. See config.inc.php $PERS_TERMIN_KAT.

public

Returns

int the index of the category

Reimplemented from Event.

Here is the caller graph for this function:

getCategoryStyle

(

$image_size = 'small'

)

Returns an array with the path to a background image (index 'image') and the color (index 'color') of a category. If $image_size is 'small' returns th path to the smaller version of the image. See config.inc.php $PERS_TERMIN_KAT.

public

Parameters

$image_size

the size of the image ('small' or 'big')

Returns

array image path and color

Here is the call graph for this function:

& getClone

(

)

Here is the call graph for this function:

getExceptions

(

)

getExpire

(

)

getPriority

(

)

getRepeat

(

$index = ''

)

Here is the caller graph for this function:

getTs

(

)

getType

(

)

getUid

(

)

Here is the caller graph for this function:

getUserId

(

)

isDayEvent

(

)

Reimplemented from Event.

Here is the call graph for this function:

Here is the caller graph for this function:

setDayEvent

(

$is_dev

)

Here is the caller graph for this function:

setExceptions

(

$exceptions

)

Here is the call graph for this function:

setPriority

(

$priority

)

setRepeat

(

$r_rule

)

Here is the call graph for this function:

setType

(

$type

)

toStringAccessibility

(

)

toStringCategories

(

)

Returns the names of the categories.

public

Returns

String the name of the category

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'

Reimplemented from Event.

Here is the call graph for this function:

toStringPriority

(

)

toStringRecurrence

(

)

Returns a string representation of the recurrence rule

public

Returns

String the recurrence rule - human readable

Field Documentation

$dev = FALSE

$ts

$user_id

---

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

• lib/calendar/lib/CalendarEvent.class.php