Stud.IP  4.0
 All Data Structures Namespaces Files Functions Variables Groups
CourseEvent Class Reference
Inheritance diagram for CourseEvent:
CourseDate Event SimpleORMap PrivacyObject CourseCancelledEvent CourseMarkedEvent

Public Member Functions

 __construct ($id=null)
 
 toStringCategories ($as_array=false)
 
 getSeminarId ()
 
 getRecurrence ($index=null)
 
 getSemName ()
 
 getType ()
 
 getTitle ()
 
 getStart ()
 
 setStart ($timestamp)
 
 getEnd ()
 
 setEnd ($timestamp)
 
 getDuration ()
 
 getLocation ()
 
 getUid ()
 
 getDescription ()
 
 getStudipCategory ()
 
 getCategory ()
 
 getEditorId ()
 
 isDayEvent ()
 
 getAccessibility ()
 
 getChangeDate ()
 
 getImportDate ()
 
 getRelatedGroups ()
 
 getProperties ()
 
 getProperty ($name)
 
 setPermissionUser ($user_id)
 
 havePermission ($permission, $user_id=null)
 
 getPermission ($user_id=null)
 
 toStringPriority ()
 
 toStringAccessibility ()
 
 toStringRecurrence ($only_type=false)
 
 getAuthor ()
 
 getEditor ()
 
- Public Member Functions inherited from CourseDate
 addTopic ($topic)
 
 removeTopic ($topic)
 
 getRoomName ()
 
 getRoom ()
 
 getTypeName ()
 
 getFullname ($format= 'default')
 
 cancelDate ()
 
 store ()
 
 delete ()
 
 getDeletionWarnings ()
 
 getAccessibleFolderFiles ($user_or_id)
 
 __toString ()
 
- Public Member Functions inherited from SimpleORMap
 __construct ($id=null)
 
 __clone ()
 
 getRelationOptions ($relation)
 
 getTableMetadata ()
 
 hasAutoIncrementColumn ()
 
 setId ($id)
 
 getId ()
 
 getNewId ()
 
 toArray ($only_these_fields=null)
 
 toRawArray ($only_these_fields=null)
 
 toArrayRecursive ($only_these_fields=null)
 
 getValue ($field)
 
 getRelationValue ($relation, $field)
 
 getDefaultValue ($field)
 
 setValue ($field, $value)
 
 __get ($field)
 
 __set ($field, $value)
 
 __isset ($field)
 
 offsetExists ($offset)
 
 offsetGet ($offset)
 
 offsetSet ($offset, $value)
 
 offsetUnset ($offset)
 
 getIterator ()
 
 count ()
 
 isField ($field)
 
 isAdditionalField ($field)
 
 isAliasField ($field)
 
 isI18nField ($field)
 
 setData ($data, $reset=false)
 
 isNew ()
 
 isDeleted ()
 
 setNew ($is_new)
 
 getWhereQuery ()
 
 restore ()
 
 store ()
 
 triggerChdate ()
 
 delete ()
 
 isDirty ()
 
 isFieldDirty ($field)
 
 revertValue ($field)
 
 getPristineValue ($field)
 
 initRelation ($relation)
 
 resetRelation ($relation)
 
 cleanup ()
 
- Public Member Functions inherited from Event
 toStringCategories ()
 

Static Public Member Functions

static getEventsByInterval ($user_id, DateTime $start, dateTime $end)
 
- Static Public Member Functions inherited from CourseDate
static getConsecutiveNumber ($date, $semester=null)
 
static findByIssue_id ($issue_id)
 
static findBySeminar_id ($seminar_id)
 
static findByRange_id ($seminar_id, $order_by= 'ORDER BY date')
 
static findByStatusgruppe_id ($group_id)
 
static exportUserData (StoredUserData $storage)
 
- Static Public Member Functions inherited from SimpleORMap
static tableScheme ($db_table)
 
static expireTableScheme ()
 
static exists ($id)
 
static countBySql ($sql= '1', $params=[])
 
static create ($data)
 
static buildExisting ($data)
 
static import ($data)
 
static findBySQL ($sql, $params=[])
 
static findOneBySQL ($where, $params=[])
 
static findThru ($foreign_key_value, $options)
 
static findEachBySQL ($callable, $sql, $params=[])
 
static findMany ($pks=[], $order= '', $order_params=[])
 
static findEachMany ($callable, $pks=[], $order= '', $order_params=[])
 
static findAndMapBySQL ($callable, $where, $params=[])
 
static findAndMapMany ($callable, $pks=[], $order= '', $order_params=[])
 
static deleteBySQL ($where, $params=[])
 
static toObject ($id_or_object)
 
static __callStatic ($name, $arguments)
 

Static Protected Member Functions

static configure ($config=[])
 
static checkRelated (CourseEvent $event, $user_id)
 
- Static Protected Member Functions inherited from CourseDate
static configure ($config=[])
 
- Static Protected Member Functions inherited from SimpleORMap
static db_table ()
 
static db_fields ()
 
static pk ()
 
static default_values ()
 
static serialized_fields ()
 
static alias_fields ()
 
static i18n_fields ()
 
static additional_fields ()
 
static has_many ()
 
static has_one ()
 
static belongs_to ()
 
static has_and_belongs_to_many ()
 
static registered_callbacks ()
 
static known_slots ()
 
static notification_map ()
 
static getter_setter_map ()
 
static configure ($config=[])
 
static config ($key)
 
static registerCallback ($types, $cb)
 
static unregisterCallback ($types, $cb)
 

Additional Inherited Members

- Data Fields inherited from CourseDate
const FORMAT_DEFAULT = 'default'
 
const FORMAT_VERBOSE = 'verbose'
 
- Data Fields inherited from SimpleORMap
const ID_SEPARATOR = '_'
 
- Data Fields inherited from Event
const PERMISSION_FORBIDDEN = 0
 
const PERMISSION_CONFIDENTIAL = 1
 
const PERMISSION_READABLE = 2
 
const PERMISSION_DELETABLE = 3
 
const PERMISSION_WRITABLE = 4
 
const PERMISSION_OWN = 5
 
- Static Public Attributes inherited from SimpleORMap
static $schemes = null
 
- Protected Member Functions inherited from CourseDate
 cbStudipLog ($type)
 
- Protected Member Functions inherited from SimpleORMap
 _getId ($field)
 
 _setId ($field, $value)
 
 _getAdditionalValueFromRelation ($field)
 
 _setAdditionalValueFromRelation ($field, $value)
 
 _getAdditionalValue ($field)
 
 _setAdditionalValue ($field, $value)
 
 parseRelationOptions ($type, $name, $options)
 
 storeRelations ($only_these=null)
 
 deleteRelations ()
 
 initializeContent ()
 
 applyCallbacks ($type)
 
 cbAutoIncrementColumn ($type)
 
 cbAutoKeyCreation ()
 
 cbNotificationMapper ($cb_type)
 
 cbAfterInitialize ($cb_type)
 
 setSerializedValue ($field, $value)
 
 setI18nValue ($field, $value)
 
- Protected Attributes inherited from SimpleORMap
 $content = []
 
 $content_db = []
 
 $is_new = true
 
 $is_deleted = false
 
 $relations = []
 
 $additional_data = []
 
- Static Protected Attributes inherited from SimpleORMap
static $config = []
 
static $reserved_slots = ['value','newid','iterator','tablemetadata', 'relationvalue','wherequery','relationoptions','data','new','id']
 
static $performs_batch_operation = false
 

Constructor & Destructor Documentation

__construct (   $id = null)

Member Function Documentation

static checkRelated ( CourseEvent  $event,
  $user_id 
)
staticprotected

Checks if given user is the responsible lecturer or is member of a related group

object $perm The globa perm object.

Parameters
CourseEvent$eventThe course event to check against.
string$user_idThe id of the user.
Returns
boolean
static configure (   $config = [])
staticprotected
getAccessibility ( )

Returns the accessibility of this event. The value is not influenced by the permission of the actual user.

According to RFC5545 the accessibility (property CLASS) is represented by the 3 state PUBLIC, PRIVATE and CONFIDENTIAL

TODO check this statement: An course event is always CONFIDENTIAL

Returns
string The accessibility as string.

Implements Event.

getAuthor ( )

Returns the author of this event as user object.

Returns
User|null User object.

Implements Event.

getCategory ( )

Returns the index of the category. If the user has no permission, 255 is returned.

TODO remove? use getStudipCategory instead?

See Also
config/config.inc.php $TERMIN_TYP
Returns
int The index of the category

Implements Event.

getChangeDate ( )

Returns the unix timestamp of the last change.

public

Implements Event.

getDescription ( )

Returns the description of the topic. If the user has no permission or the event has no topic or the topics have no descritopn an empty string is returned.

Returns
String the description

Implements Event.

getDuration ( )

Returns the duration of this event in seconds.

Returns
int the duration of this event in seconds

Implements Event.

getEditor ( )

Course events have no editor so always null is returned.

Returns
null

Implements Event.

getEditorId ( )

Returns the user id of the last editor. Since course events have no editor null is returned.

Returns
null|int Returns always null.

Implements Event.

getEnd ( )

Returns the endtime of this event.

Returns
int The endtime of this event as a unix timestamp.

Implements Event.

static getEventsByInterval (   $user_id,
DateTime  $start,
dateTime  $end 
)
static

Returns all CourseEvents in the given time range for the given range_id.

Parameters
string$user_idId of Stud.IP object from type user, course, inst
DateTime$startThe start date time.
DateTime$endThe end date time.
Returns
SimpleORMapCollection Collection of found CourseEvents.
getImportDate ( )

Returns the date time the event was imported. Since course events are not imported normaly, returns the date time of creation.

Returns
int Date time of import as unix timestamp:

Implements Event.

getLocation ( )

Returns the location. Without permission or the location is not set an empty string is returned.

See Also
ClendarDate::getRoomName()
Returns
string The location

Implements Event.

getPermission (   $user_id = null)

Implements Event.

getProperties ( )

Returns all properties of this event. The name of the properties correspond to the properties of the iCalendar calendar data exchange format. There are a few properties with the suffix STUDIP_ which have no eqivalent in the iCalendar format.

DTSTART: The start date-time as unix timestamp. DTEND: The end date-time as unix timestamp. SUMMARY: The short description (title) that will be displayed in the views. DESCRIPTION: The long description. UID: The global unique id of this event. CLASS: CATEGORIES: A comma separated list of categories. PRIORITY: The priority. LOCATION: The location. EXDATE: A comma separated list of unix timestamps. CREATED: The creation date-time as unix timestamp. LAST-MODIFIED: The date-time of last modification as unix timestamp. DTSTAMP: The cration date-time of this instance of the event as unix timestamp. RRULE: All data for the recurrence rule for this event as array. EVENT_TYPE:

Returns
array The properties of this event.

Implements Event.

getProperty (   $name)

Returns the value of property with given name.

Parameters
type$nameSee CalendarEvent::getProperties() for accepted values.
Returns
mixed The value of the property.
Exceptions
InvalidArgumentException

Implements Event.

getRecurrence (   $index = null)

Returns an array that represents the recurrence rule for this event. If an index is given, returns only this field of the rule.

Returns
array|string The array with th recurrence rule or only one field.

Implements Event.

getRelatedGroups ( )

Returns all related groups.

TODO remove, use direct access to field CourseDate::statusgruppen.

Returns
SimpleORMapCollection The collection of statusgruppen.
getSeminarId ( )

Returns the id of the related course

Returns
string The id of the related course.
getSemName ( )

Returns the name of the related course.

Returns
string The name of the related course.
getStart ( )

Returns the starttime as unix timestamp of this event.

Returns
int The starttime of this event as a unix timestamp.

Implements Event.

getStudipCategory ( )

Returns the Stud.IP build in category as integer value. If the user has no permission, 255 is returned.

config.inc.php $PERS_TERMIN

Returns
int the categories
getTitle ( )

Returns the title of this event. The title of a course event is the name of the course or if a topic is assigned, the title of this topic. If the user has not the permission Event::PERMISSION_READABLE, the title is "Keine Berechtigung.".

Returns
string

Implements Event.

getType ( )

TODO Wird das noch benötigt?

Implements Event.

getUid ( )

Returns the global unique id of this event.

Returns
string The global unique id.

Implements Event.

havePermission (   $permission,
  $user_id = null 
)

Implements Event.

isDayEvent ( )

Returns whether the event is a all day event.

Returns

Implements Event.

setEnd (   $timestamp)

Sets the end date time by given unix timestamp.

Parameters
string$timestampUnix timestamp.
setPermissionUser (   $user_id)
setStart (   $timestamp)

Sets the start date time with given unix timestamp.

Parameters
string$timestampUnix timestamp.
toStringAccessibility ( )

Course events have no accessibility settings so returns always the an empty string.

Returns
string The accessibility as string.

Implements Event.

toStringCategories (   $as_array = false)

Returns the name of the category.

Returns
string the name of the category
toStringPriority ( )

Course events have no priority so returns always an empty string.

Returns
string The priority as a string.

Implements Event.

toStringRecurrence (   $only_type = false)

Returns a string representation of the recurrence rule. Since course events have no recurence defined it returns an empty string.

Parameters
bool$only_typeIf true returns only the type of recurrence.
Returns
string The recurrence rule - human readable

Implements Event.


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