Inheritance diagram for ConsultationSlot:

Public Member Functions
	isOccupied ($user_id=null)

	isLocked ()

	createEvent (User $user)

	updateEvents ()

	userMayCreateBookingForSlot (\User $user=null)

	__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	countByRange (Range $range, $expired=false)

static	findByRange (Range $range, $order= '', $expired=false)

static	findOccupiedSlotsByUserAndRange ($user_id, Range $range)

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)

Protected Member Functions
	createEventId (User $user)

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

__toString ( )

Returns: string A string representation of the consultation slot.

static configure ( $config = [] )

staticprotected

Configures the model.

Parameters

array $config Configuration

static countByRange	(	Range	$range,
			$expired = `false`
	)

static

Counts all slots of the given range.

Parameters

Range	$range	Range
bool	$expired

Returns: int

createEvent ( User $user )

Creates a Stud.IP calendar event relating to the slot.

Parameters

User $user User object to create the event for

Returns: EventData Created event

createEventId ( User $user )

protected

Returns a unique event id.

Parameters

User $user [description]

Returns: string unique event id

static findByRange	(	Range	$range,
			$order = `''`,
			$expired = `false`
	)

static

Finds slots of the given teacher.

Parameters

Range	$range	Range
string	$order	Desired order of items
bool	$expired	Show expired items?

Returns: array

static findOccupiedSlotsByUserAndRange	(		$user_id,
		Range	$range
	)

static

Find all occupied slots for a given user and teacher combination.

Parameters

string	$user_id	Id of the user
Range	$range	Range

Returns: array

isLocked ( )

Returns whether the slot is locked for bookings.

Returns: bool

isOccupied ( $user_id = null )

Returns whether this slot is occupied (by a given user).

Parameters

mixed $user_id Id of the user (optional)

Returns: boolean indicating whether the slot is occupied (by the given user)

updateEvents ( )

Updates the teacher event that belongs to the slot. This will either be set to be unoccupied, occupied by only one user or by a group of user.

userMayCreateBookingForSlot ( \User $user = null )

Returns whether the given user may create a booking for this slot.

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

lib/models/ConsultationSlot.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Additional Inherited Members

Member Function Documentation