Course Class Reference

Inheritance diagram for Course:

Collaboration diagram for Course:

Public Member Functions
	getEnd_Time ()
	setEnd_Time ($value)
	getFreeSeats ()
	isWaitlistAvailable ()
	getMembersWithStatus ($status, $as_collection=false)
	countMembersWithStatus ($status)
	getNumParticipants ()
	getNumPrelimParticipants ()
	getNumWaiting ()
	getParticipantStatus ($user_id)
	getSemType ()
	getSemClass ()
	getFullname ($format='default')
	getDatesWithExdates ()
	setStudyAreas ($ids)
	isVisibleForUser ($user_id=null)
	describeRange ()
	getRangeType ()
	getRangeId ()
	userMayAccessRange ($user_id=null)
	userMayEditRange ($user_id=null)
	userMayAdministerRange ($user_id=null)
	getCompletionIcon ()
	getItemName ($long_format=true)
	getItemURL ()
	getItemAvatarURL ()
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 ()
	describeRange ()
	getRangeType ()
	getRangeId ()
	userMayAccessRange ($user_id=null)
	userMayEditRange ($user_id=null)
	userMayAdministerRange ($user_id=null)
	getItemName ($long_format=true)
	getItemURL ()
	getItemAvatarURL ()

Static Public Member Functions
static	findCurrent ()
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)
static	exportUserData (StoredUserData $storage)

Protected Member Functions
	logStore ()
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=array())
Static Protected Member Functions inherited from SimpleORMap
static	configure ($config=array())
static	config ($key)

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

Member Function Documentation

configure()

static configure (   $config = array() )

staticprotected

set configuration data from subclass

Parameters

array

$config

configuration data

Returns

void

Reimplemented from SimpleORMap.

Here is the call graph for this function:

countMembersWithStatus()

countMembersWithStatus

(

$status

)

Retrieves the number of all members of a status

Parameters

String | Array

$status

the status to filter with

Returns

int the number of all those members.

Here is the call graph for this function:

Here is the caller graph for this function:

describeRange()

describeRange

(

)

Returns a descriptive text for the range type.

Returns

string

Implements Range.

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

$storage

object to store data into

Implements PrivacyObject.

Here is the call graph for this function:

findCurrent()

static findCurrent ( )

static

Returns the currently active course or false if none is active.

Returns

Course object of currently active course, null otherwise

Since

3.0

Here is the call graph for this function:

Here is the caller graph for this function:

getCompletionIcon()

getCompletionIcon

(

)

Returns the appropriate icon for the completion status.

Mapping (completion -> icon role):

• 0 => status-red
• 1 => status-yellow
• 2 => status-green

Returns

Icon class

Here is the call graph for this function:

getDatesWithExdates()

getDatesWithExdates

(

)

getEnd_Time()

getEnd_Time

(

)

getFreeSeats()

getFreeSeats

(

)

Here is the call graph for this function:

getFullname()

getFullname

(

$format = 'default'

)

Returns the full name of a course. If the important course numbers (IMPORTANT_SEMNUMBER) is set in global configs it will also display the coursenumber

Parameters

string

formatting template name

Returns

string Fullname

Here is the call graph for this function:

getItemAvatarURL()

getItemAvatarURL

(

)

Returns the URL to the avatar image or icon of the object, if applicable.

Returns

string|null Either the URL to the object's avatar or icon or null, if the object does not have an avatar.

Implements StudipItem.

Here is the call graph for this function:

getItemName()

getItemName

(

$long_format = true

)

Returns a human-readable name of the object.

Parameters

bool

$long_format

If set to true, a long format that has the object type as a prefix (course, room etc.) is returned. Otherwise only the name is returned.

Returns

string A human-readable string of the object's name.

Implements StudipItem.

getItemURL()

getItemURL

(

)

Returns an URL that points to a page describing or displaying the object.

Returns

string|null Either the URL to a descriptive page for the object or null, if the object does not have such an URL.

Implements StudipItem.

Here is the call graph for this function:

getMembersWithStatus()

getMembersWithStatus	(		$status,
			$as_collection = false
	)

Retrieves all members of a status

Parameters

String | Array	$status	the status to filter with
bool	$as_collection	return collection instead of array?

Returns

Array an array of all those members.

Here is the call graph for this function:

getNumParticipants()

getNumParticipants

(

)

Here is the call graph for this function:

Here is the caller graph for this function:

getNumPrelimParticipants()

getNumPrelimParticipants

(

)

Here is the call graph for this function:

Here is the caller graph for this function:

getNumWaiting()

getNumWaiting

(

)

Here is the call graph for this function:

Here is the caller graph for this function:

getParticipantStatus()

getParticipantStatus

(

$user_id

)

getRangeId()

getRangeId

(

)

Returns the id of the current range

Returns

string

Implements Range.

getRangeType()

getRangeType

(

)

Returns a unique identificator for the range type.

Returns

string

Implements Range.

getSemClass()

getSemClass

(

)

Returns the SemClass object that is defined for the course

Returns

SemClass The SemClassObject for the course

Here is the call graph for this function:

getSemType()

getSemType

(

)

Returns the semType object that is defined for the course

Returns

SemType The semTypeObject for the course

Here is the call graph for this function:

Here is the caller graph for this function:

isVisibleForUser()

isVisibleForUser

(

$user_id = null

)

Is the current course visible for the current user?

Parameters

string

$user_id

Returns

bool Visible?

Here is the call graph for this function:

isWaitlistAvailable()

isWaitlistAvailable

(

)

Here is the call graph for this function:

logStore()

logStore ( )

protected

Generates a general log entry if the course were changed.

Here is the call graph for this function:

setEnd_Time()

setEnd_Time

(

$value

)

setStudyAreas()

setStudyAreas

(

$ids

)

Sets this courses study areas to the given values.

Parameters

$ids	the new study areas

Returns

bool Changes successfully saved?

Here is the call graph for this function:

userMayAccessRange()

userMayAccessRange

(

$user_id = null

)

Decides whether the user may access the range.

Parameters

string

$user_id

Optional id of a user, defaults to current user

Returns

bool

Todo:

Check permissions

Implements Range.

userMayAdministerRange()

userMayAdministerRange

(

$user_id = null

)

Decides whether the user may adminisiter the range.

Parameters

string

$user_id

Optional id of a user, defaults to current user

Returns

bool

Todo:

Check permissions

Implements Range.

userMayEditRange()

userMayEditRange

(

$user_id = null

)

Decides whether the user may edit/alter the range.

Parameters

string

$user_id

Optional id of a user, defaults to current user

Returns

bool

Todo:

Check permissions

Implements Range.

---

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

• lib/models/Course.class.php