Stud.IP  4.2 Revision
CourseDate Class Reference
Inheritance diagram for CourseDate:
Inheritance graph
Collaboration diagram for CourseDate:
Collaboration graph

Public Member Functions

 __construct ($id=null)
 
 addTopic ($topic)
 
 removeTopic ($topic)
 
 getRoomName ()
 
 getRoom ()
 
 getTypeName ()
 
 getFullname ($format='default')
 
 toString ()
 
 cancelDate ()
 
 store ()
 
 delete ()
 
 getDeletionWarnings ()
 
 getAccessibleFolderFiles ($user_or_id)
 
- 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 ()
 

Static Public Member Functions

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 find ($id)
 
static exists ($id)
 
static countBySql ($sql=1, $params=array())
 
static create ($data)
 
static build ($data, $is_new=true)
 
static buildExisting ($data)
 
static import ($data)
 
static findBySQL ($sql, $params=array())
 
static findOneBySQL ($where, $params=array())
 
static findThru ($foreign_key_value, $options)
 
static findEachBySQL ($callable, $sql, $params=array())
 
static findMany ($pks=array(), $order='', $order_params=array())
 
static findEachMany ($callable, $pks=array(), $order='', $order_params=array())
 
static findAndMapBySQL ($callable, $where, $params=array())
 
static findAndMapMany ($callable, $pks=array(), $order='', $order_params=array())
 
static deleteBySQL ($where, $params=array())
 
static toObject ($id_or_object)
 
static __callStatic ($name, $arguments)
 

Data Fields

const FORMAT_DEFAULT = 'default'
 
const FORMAT_VERBOSE = 'verbose'
 

Protected Member Functions

 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)
 
 registerCallback ($types, $cb)
 
 unregisterCallback ($types, $cb)
 
 cbAutoIncrementColumn ($type)
 
 cbAutoKeyCreation ()
 
 cbNotificationMapper ($cb_type)
 
 cbAfterInitialize ($cb_type)
 
 setSerializedValue ($field, $value)
 
 setI18nValue ($field, $value)
 
 cbI18N ($type)
 

Static Protected Member Functions

static configure ($config=[])
 
- Static Protected Member Functions inherited from SimpleORMap
static configure ($config=array())
 
static config ($key)
 

Additional Inherited Members

- Static Public Attributes inherited from SimpleORMap
static $schemes = null
 
- Protected Attributes inherited from SimpleORMap
 $content = array()
 
 $content_db = array()
 
 $is_new = true
 
 $is_deleted = false
 
 $db_table = ''
 
 $db_fields = null
 
 $pk = null
 
 $default_values = array()
 
 $serialized_fields = array()
 
 $alias_fields = array()
 
 $i18n_fields = array()
 
 $additional_fields = array()
 
 $relations = array()
 
 $has_many = array()
 
 $has_one = array()
 
 $belongs_to = array()
 
 $has_and_belongs_to_many = array()
 
 $registered_callbacks = array()
 
 $known_slots = array()
 
 $notification_map = array()
 
 $additional_data = array()
 
 $getter_setter_map = array()
 
- Static Protected Attributes inherited from SimpleORMap
static $config = array()
 
static $reserved_slots = array('value','newid','iterator','tablemetadata', 'relationvalue','wherequery','relationoptions','data','new','id')
 

Constructor & Destructor Documentation

◆ __construct()

__construct (   $id = null)
Here is the call graph for this function:

Member Function Documentation

◆ addTopic()

addTopic (   $topic)

Adds a topic to this date.

Parameters
mixed$topicTopic definition (might be an id, an array or an object)
Returns
number addition of all return values, false if none was called
Here is the call graph for this function:

◆ cancelDate()

cancelDate ( )

Converts a CourseDate Entry to a CourseExDate Entry returns instance of the new CourseExDate or NULL

Returns
Object CourseExDate
Here is the call graph for this function:

◆ cbStudipLog()

cbStudipLog (   $type)
protected
Parameters
$typestring type of callback
Here is the call graph for this function:

◆ configure()

static configure (   $config = [])
staticprotected

Configures this model.

Parameters
Array$configConfiguration array

◆ delete()

delete ( )

deletes this object and expires the cache

See also
SimpleORMap::delete()
Here is the call graph for this function:

◆ exportUserData()

static exportUserData ( StoredUserData  $storage)
static

Export available data of a given user into a storage object (an instance of the StoredUserData class) for that user.

Parameters
StoredUserData$storageobject to store data into

Implements PrivacyObject.

Here is the call graph for this function:

◆ findByIssue_id()

static findByIssue_id (   $issue_id)
static

Returns course dates by issue id.

Parameters
String$issue_idId of the issue
Returns
array with the associated dates
Here is the caller graph for this function:

◆ findByRange_id()

static findByRange_id (   $seminar_id,
  $order_by = 'ORDER BY date' 
)
static

Return course dates by range id (which is in many cases the course id)

Parameters
String$seminar_idId of the course
String$order_byOptional order definition
Returns
array with the associated dates
Here is the caller graph for this function:

◆ findBySeminar_id()

static findBySeminar_id (   $seminar_id)
static

Returns course dates by course id

Parameters
String$seminar_idId of the course
Returns
array with the associated dates
Here is the caller graph for this function:

◆ findByStatusgruppe_id()

static findByStatusgruppe_id (   $group_id)
static

Returns course dates by issue id.

Parameters
String$issue_idId of the issue
Returns
array with the associated dates

◆ getAccessibleFolderFiles()

getAccessibleFolderFiles (   $user_or_id)

return all filerefs belonging to this date, permissions fpr given user are checked

Parameters
string | User$user_or_id
Returns
mixed[] A mixed array with FolderType and FileRef objects.
Here is the call graph for this function:

◆ getConsecutiveNumber()

static getConsecutiveNumber (   $date,
  $semester = null 
)
static

return consecutive number for a date in its course, if semester is given only within that time range

Parameters
CourseDate$date
null | Semester$semester
Returns
int|null
Here is the call graph for this function:
Here is the caller graph for this function:

◆ getDeletionWarnings()

getDeletionWarnings ( )

Returns a list of all possible warnings that should be considered when this date is deleted.

Returns
array of warnings
Here is the call graph for this function:

◆ getFullname()

getFullname (   $format = 'default')

Returns the full qualified name of this date.

Parameters
String$formatOptional format type (only 'default' and 'verbose' are supported by now)
Returns
String containing the full name of this date.
Here is the caller graph for this function:

◆ getRoom()

getRoom ( )

Returns the assigned room for this date as an object.

Returns
mixed Either the object or null if no room is assigned
Here is the call graph for this function:
Here is the caller graph for this function:

◆ getRoomName()

getRoomName ( )

Returns the name of the assigned room for this date.

Returns
String containing the room name
Here is the call graph for this function:
Here is the caller graph for this function:

◆ getTypeName()

getTypeName ( )

Returns the name of the type of this date.

Parameters
Stringcontaining the type name
Here is the caller graph for this function:

◆ removeTopic()

removeTopic (   $topic)

Removes a topic from this date.

Parameters
mixed$topicTopic definition (might be an id, an array or an object)
Returns
number addition of all return values, false if none was called
Here is the call graph for this function:

◆ store()

store ( )

saves this object and expires the cache

See also
SimpleORMap::store()
Here is the call graph for this function:

◆ toString()

toString ( )

Returns the full qualified name of this date raumzeit_send_cancel_message needs the toString()-Method in this class

Deprecated:
since version 3.4
Returns
String containing the full name of this date
Here is the call graph for this function:

Field Documentation

◆ FORMAT_DEFAULT

const FORMAT_DEFAULT = 'default'

◆ FORMAT_VERBOSE

const FORMAT_VERBOSE = 'verbose'

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