Inheritance diagram for SeminarCycleDate:

Public Member Functions
	getIsVisible ()

	toString ($format='short')

	getAllDates ()

	delete ()

	setSingleDateType ($type)

	store ()

	generateNewDates ()

	calculateTurnusDates ($dates, $turnus_offset)

	getOpenRequestsForDates ( $include_metadate=false, $order='mkdate DESC')

	countOpenRequestsForDates ($include_metadate=false)

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

Static Public Member Functions
static	findBySeminar ($seminar_id)

static	findByTermin ($termin_id)

static	removeOutRangedSingleDates ($start, $end, $seminar_id)

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	build ($data, $is_new=true)

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 (string $name, array $arguments)

Protected Member Functions
	getTimeFraction ($field)

	setTimeFraction ($field, $value)

	setSws ($value)

	buildOpenRequestsForDatesQuery ( $include_metadate=false, $order='')

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
Data Fields inherited from SimpleORMap
const	ID_SEPARATOR = '_'

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

◆ buildOpenRequestsForDatesQuery()

buildOpenRequestsForDatesQuery	(	$include_metadate = `false`,
		$order = `''`
	)

protected

This is a helper method for getRoomRequestsForDates and countRoomRequestsForDates which helps at building the SQL query and parameters.

Returns

array An associative array with two indexes:

sql: The SQL query
sql_params: The parameters for the SQL query as associative array.

◆ calculateTurnusDates()

calculateTurnusDates	(	$dates,
		$turnus_offset
	)

Calculate turnus for singledate entries

Parameters

array	$dates
int	$turnus_offset	correction for turnus calculation if first date is not within semester

Returns: array

◆ configure()

static configure ( $config = [] )

staticprotected

Configures this model.

Parameters

Array $config Configuration array

◆ countOpenRequestsForDates()

countOpenRequestsForDates ( $include_metadate = false )

Returns the amount of open room requests that are associated with this metadate. The amount of requests is determined by counting requests that are directly associated to this metadate and the requests that are associated with the dates of this metadate. If the optional parameter $include_metadate is set to false, the requests associated with this metadate are not included in the result.

Parameters

bool $include_metadate Whether to include requests associated with this metadate (true) or not (false). The default is false.

Returns: int The amount of requests for this metadate.

◆ delete()

delete ( )

Deletes the cycle.

Returns: int number of affected rows

◆ findBySeminar()

static findBySeminar ( $seminar_id )

static

returns array of instances of SeminarCycleDates of the given seminar_id

Parameters

string seminar_id: selected seminar to search for SeminarCycleDates

Returns: array of instances of SeminarCycleDates of the given seminar_id or an empty array

◆ findByTermin()

static findByTermin ( $termin_id )

static

return instance of SeminarCycleDates of given termin_id

Parameters

string termin_id: selected seminar to search for SeminarCycleDates

Returns: array

◆ generateNewDates()

generateNewDates ( )

Generate any currently missing single dates for this cycle.

◆ getAllDates()

getAllDates ( )

returns an sorted array with all dates and exdates for the cycledate entry

Returns: array of instances of dates or exdates

◆ getIsVisible()

getIsVisible ( )

Check if there is a least one not cancelled date for this cycle data

Returns: bool true, if there is at least one not cancelled date

◆ getOpenRequestsForDates()

getOpenRequestsForDates	(	$include_metadate = `false`,
		$order = `'mkdate DESC'`
	)

Returns the open room requests that are associated with this metadate. If the optional parameter $include_metadate is set to false, the requests associated with this metadate are not included in the result.

Parameters

bool $include_metadate Whether to include requests associated with this metadate (true) or not (false). The default is false.

Returns: ResourceRequest[] The requests for this metadate.

◆ getTimeFraction()

getTimeFraction ( $field )

protected

Returns the time fraction for a given field.

Parameters

String $field Time fraction field

Returns: int the time fraction

◆ removeOutRangedSingleDates()

static removeOutRangedSingleDates	(	$start,
		$end,
		$seminar_id
	)

static

removes all singleDates which are NOT between $start and $end

Parameters

int	timestamp for start
int	timestamp for end
string	seminar_id

◆ setSingleDateType()

setSingleDateType ( $type )

Set date-type for all dates

Parameters

$type

Returns: int

◆ setSws()

setSws ( $value )

protected

SWS needs special setter to always store a decimal

Parameters

number $value

◆ setTimeFraction()

setTimeFraction	(	$field,
		$value
	)

protected

Sets the time fraction for a given field.

Parameters

String	$field	Time fraction field
mixed	$value	Time fraction value as string or int

Returns: String containing the time fraction

◆ store()

store ( )

Stores this cycle.

Returns: int number of changed rows

◆ toString()

toString ( $format = 'short' )

returns a string for a date like '3. 9:00s - 10:45' (short and long) or '3. 9:00s - 10:45, , ab der 7. Semesterwoche, (Vorlesung)' with the week of the semester

Parameters

format string: "short"|"long"|"full"

Returns: formatted string

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

lib/models/SeminarCycleDate.class.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Additional Inherited Members

Member Function Documentation

◆ buildOpenRequestsForDatesQuery()

◆ calculateTurnusDates()

◆ configure()

◆ countOpenRequestsForDates()

◆ delete()

◆ findBySeminar()

◆ findByTermin()

◆ generateNewDates()

◆ getAllDates()

◆ getIsVisible()

◆ getOpenRequestsForDates()

◆ getTimeFraction()

◆ removeOutRangedSingleDates()

◆ setSingleDateType()

◆ setSws()

◆ setTimeFraction()

◆ store()

◆ toString()