CourseDate Class Reference

Inheritance diagram for CourseDate:

Public Member Functions
	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 ()

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

Data Fields
const	FORMAT_DEFAULT = 'default'
const	FORMAT_VERBOSE = 'verbose'
Data Fields inherited from SimpleORMap
const	ID_SEPARATOR = '_'

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)
	cbNotificationMapper ($cb_type)
	cbAfterInitialize ($cb_type)
	setSerializedValue ($field, $value)
	setI18nValue ($field, $value)

Static Protected Member Functions
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
Static Public Attributes inherited from SimpleORMap
static	$schemes = null
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

__toString

(

)

Returns

string A string representation of the course date.

addTopic

(

$topic

)

Adds a topic to this date.

Parameters

mixed

$topic

Topic definition (might be an id, an array or an object)

Returns

int|false number addition of all return values, false if none was called

cancelDate

(

)

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

Returns

Object CourseExDate

cbStudipLog (   $type )

protected

Parameters

$type

string type of callback

static configure (   $config = [] )

staticprotected

Configures this model.

Parameters

Array

$config

Configuration array

delete

(

)

deletes this object and expires the cache

See Also

SimpleORMap::delete()

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

$storage

object to store data into

Implements PrivacyObject.

static findByIssue_id (   $issue_id )

static

Returns course dates by issue id.

Parameters

String

$issue_id

Id of the issue

Returns

array with the associated dates

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_id	Id of the course
String	$order_by	Optional order definition

Returns

array with the associated dates

static findBySeminar_id (   $seminar_id )

static

Returns course dates by course id

Parameters

String

$seminar_id

Id of the course

Returns

array with the associated dates

static findByStatusgruppe_id (   $group_id )

static

Returns course dates by issue id.

Parameters

String

$issue_id

Id of the issue

Returns

array with the associated dates

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.

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

getDeletionWarnings

(

)

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

Returns

array of warnings

getFullname

(

$format = 'default'

)

Returns the full qualified name of this date.

Parameters

String

$format

Optional format type (only 'default', 'include-room' and 'verbose' are supported by now)

Returns

String containing the full name of this date.

getRoom

(

)

Returns the assigned room for this date as an object.

Returns

Room Either the object or null if no room is assigned

getRoomName

(

)

Returns the name of the assigned room for this date.

Returns

String containing the room name

getTypeName

(

)

Returns the name of the type of this date.

Parameters

String

containing the type name

removeTopic

(

$topic

)

Removes a topic from this date.

Parameters

mixed

$topic

Topic definition (might be an id, an array or an object)

Returns

number addition of all return values, false if none was called

store

(

)

saves this object and expires the cache

See Also

SimpleORMap::store()

Field Documentation

const FORMAT_DEFAULT = 'default'

const FORMAT_VERBOSE = 'verbose'

---

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

• lib/models/CourseDate.class.php