Stud.IP  5.4
 All Data Structures Namespaces Files Functions Variables Groups
Public Member Functions | Static Public Member Functions | Static Protected Member Functions
CourseMarkedEvent Class Reference
Inheritance diagram for CourseMarkedEvent:
CourseEvent CourseDate Event SimpleORMap PrivacyObject

Public Member Functions

 getPermission ($user_id=null)
 
 getTitle ()
 
 getCategory ()
 
 getDescription ()
 
- Public Member Functions inherited from CourseEvent
 __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)
 
 isRelation ($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 CourseEvent
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 Protected Member Functions inherited from CourseEvent
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)
 
 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
 

Member Function Documentation

static configure (   $config = [])
staticprotected
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.

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.

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

Returns all CourseMarkedEvents 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 CourseMarkedEvents.
getPermission (   $user_id = null)

Implements Event.

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.

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