Institute Class Reference

Inheritance diagram for Institute:

Public Member Functions
	isFaculty ()
	getFullName ($format='default')
	describeRange ()
	getRangeType ()
	getRangeId ()
	getConfiguration ()
	isAccessibleToUser ($user_id=null)
	isEditableByUser ($user_id=null)
	getSemClass ()
	setDefaultTools ()
	isToolActive ($name)
	getActivatedTools ()
	__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)
	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	findCurrent ()
static	findByFaculty ($fakultaets_id)
static	getInstitutes ()
static	getMyInstitutes ($user_id=NULL)
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)

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

__toString

(

)

See also

Range::__toString()

Implements Range.

configure()

static configure (   $config = [] )

staticprotected

describeRange()

describeRange

(

)

Returns a descriptive text for the range type.

Returns

string

Implements Range.

findByFaculty()

static findByFaculty (   $fakultaets_id )

static

returns array of instances of Institutes belonging to given faculty

Parameters

string

$fakultaets_id

Returns

array

findCurrent()

static findCurrent ( )

static

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

Returns

Institute object of currently active institute

Since

3.0

getActivatedTools()

getActivatedTools

(

)

returns all activated plugins/modules for this course

Returns

StudipModule[]

getConfiguration()

getConfiguration

(

)

{Returns the configuration object for this range.

Returns

RangeConfig

}

Implements Range.

getFullName()

getFullName

(

$format = 'default'

)

Returns the full name of an institute.

Parameters

string

formatting template name

Returns

string Fullname

Implements Range.

getInstitutes()

static getInstitutes ( )

static

returns an array of all institutes ordered by faculties and name

Returns

array

getMyInstitutes()

static getMyInstitutes (   $user_id = NULL )

static

returns an array of all institutes to which the given user belongs, ordered by faculties and name. The user role for each institute is included

Parameters

string

$user_id

if omitted, the current user is used

Returns

array

getRangeId()

getRangeId

(

)

Returns the id of the current range

Returns

mixed (string|int)

Implements Range.

getRangeType()

getRangeType

(

)

Returns a unique identificator for the range type.

Returns

string

Implements Range.

getSemClass()

getSemClass

(

)

Returns

SemClass

isAccessibleToUser()

isAccessibleToUser

(

$user_id = null

)

Decides whether the user may access the range.

Parameters

string | null

$user_id

Optional id of a user, defaults to current user

Returns

bool

Implements Range.

isEditableByUser()

isEditableByUser

(

$user_id = null

)

Decides whether the user may edit/alter the range.

Parameters

string | null

$user_id

Optional id of a user, defaults to current user

Returns

bool

Implements Range.

isFaculty()

isFaculty

(

)

isToolActive()

isToolActive

(

$name

)

Parameters

$name

string name of tool / plugin

Returns

bool

setDefaultTools()

setDefaultTools

(

)

---

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

• lib/models/Institute.class.php