CalendarEvent Class Reference

Inheritance diagram for CalendarEvent:

Collaboration diagram for CalendarEvent:

Public Member Functions
	CalendarEvent ($properties, $id='', $user_id='', $permission=NULL)
	getExpire ()
	setImportDate ($import_date=NULL)
	getImportDate ()
	toStringCategories ()
	getTs ()
	getUserId ()
	getRepeat ($index='')
	getType ()
	setType ($type)
	getPriority ()
	setPriority ($priority)
	toStringPriority ()
	toStringAccessibility ()
	setRepeat ($r_rule)
	createRepeat ($r_rule, $start, $end)
	getUid ()
	getCategory ()
	getAllCategories ()
	getCategoryStyle ($image_size='small')
	createUniqueId ()
	toStringRecurrence ()
	getExceptions ()
	setExceptions ($exceptions)
	toStringDate ($mod='SHORT')
	getEditorId ()
	getAuthorId ()
Public Member Functions inherited from Event
	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
	$ts
	$user_id
	$import_date = -1
	$editor = ''
Data Fields inherited from Event
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

CalendarEvent()

CalendarEvent	(		$properties,
			$id = '',
			$user_id = '',
			$permission = NULL
	)

Here is the call graph for this function:

createRepeat()

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()

createUniqueId

(

)

Returns a unique ID

public

Returns

String the unique ID

Here is the caller graph for this function:

getAllCategories()

getAllCategories

(

)

Returns all categories (internal categories defined in config.inc.php $PERS_TERMIN_KAT and imported or user entered categories) as an array of category names.

Returns

array An array of category names.

Here is the call graph for this function:

getAuthorId()

getAuthorId

(

)

Here is the call graph for this function:

getCategory()

getCategory

(

)

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

public

Returns

int the index of the category

Here is the caller graph for this function:

getCategoryStyle()

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:

getEditorId()

getEditorId

(

)

Here is the call graph for this function:

getExceptions()

getExceptions

(

)

getExpire()

getExpire

(

)

getImportDate()

getImportDate

(

)

getPriority()

getPriority

(

)

getRepeat()

getRepeat

(

$index = ''

)

Here is the caller graph for this function:

getTs()

getTs

(

)

getType()

getType

(

)

getUid()

getUid

(

)

Here is the caller graph for this function:

getUserId()

getUserId

(

)

setExceptions()

setExceptions

(

$exceptions

)

Here is the call graph for this function:

setImportDate()

setImportDate

(

$import_date = NULL

)

setPriority()

setPriority

(

$priority

)

setRepeat()

setRepeat

(

$r_rule

)

Here is the call graph for this function:

setType()

setType

(

$type

)

toStringAccessibility()

toStringAccessibility

(

)

toStringCategories()

toStringCategories

(

)

Returns the names of the categories.

public

Returns

String the name of the category

Here is the call graph for this function:

toStringDate()

toStringDate

(

$mod = 'SHORT'

)

Here is the call graph for this function:

toStringPriority()

toStringPriority

(

)

toStringRecurrence()

toStringRecurrence

(

)

Returns a string representation of the recurrence rule

public

Returns

String the recurrence rule - human readable

Field Documentation

$editor

$editor = ''

$import_date

$import_date = -1

$ts

$ts

$user_id

$user_id

---

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

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