Studiengang Class Reference

Inheritance diagram for Studiengang:

Public Member Functions
	__construct ($id=null)
	getDisplayName ()
	getRelatedModules ($only_public=true, $modul_ids=null)
	getStartSem ()
	getEndSem ()
	getResponsibleInstitutes ()
	isActive ()
	getVariant ()
	getTrailParentId ()
	getTrailParent ()
	getChildren ()
	getParents ($mode=null)
	hasChildren ()
	assignLanguagesOfInstruction ($languages)
	assignStudycourseTypes ($types)
	validate ()
Public Member Functions inherited from ModuleManagementModelTreeItem
	getTrailParentId ()
	getTrails ($types=null, $mode=null, $path=null, $in_recursion=false)
	isAssignable ()
	hasChildren ()
Public Member Functions inherited from ModuleManagementModel
	verifyPermission ($user_id=null)
	store ()
	validate ()
	delete ()
	setNewId ()
	getDisplayName ()
	getAvailableTranslations ()
	getStatus ()
	hasPublicStatus ($filter=null)
	getResponsibleInstitutes ()
	getVariant ()
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 ()
Public Member Functions inherited from MvvTreeItem
	getId ()

Static Public Member Functions
static	findByAbschluss ($abschluss_id)
static	findByFachAbschluss ($fach_id, $abschluss_id, $filter=null)
static	findByFachbereich ($fachbereich_id)
static	findByAbschlussKategorie ($kategorie_id)
static	findByAbschlussKategorieFachbereich ($kategorie_id, $fachbereich_id)
static	findByStgTeil ($stgteil_id)
static	findByModule ($modul_ids, $only_public=true)
static	toArrayFachbereichAbschlussKategorie ($fachbereich_id, $kategorie_id)
static	getAllEnriched ($sortby='name', $order='ASC', $filter=null, $row_count=null, $offset=null)
static	getCount ($filter=null)
static	getEnriched ($studiengang_id)
static	getAllAssignedInstitutes ($filter=null)
static	findBySearchTerm ($term, $filter=null)
static	findByIds ($studiengang_ids, $filter=null)
static	findStatusByIds ($studiengang_ids=[])
static	findByFilter ($filter)
static	getClassDisplayName ($long=false)
Static Public Member Functions inherited from ModuleManagementModelTreeItem
static	getPathes ($trails, $delimiter=' · ')
static	filterTrails ($trails, $filter_objects)
static	setObjectFilter ($class_name, $filter_func)
Static Public Member Functions inherited from ModuleManagementModel
static	findBySearchTerm ($search_term, $filter=null)
static	getAll ()
static	get ($id=null)
static	getEnriched ($id)
static	getEnrichedByQuery ($query=null, $params=[], $row_count=null, $offset=null)
static	getClassDisplayName ($long=false)
static	getFilterSql ($filter, $where=false, $or_sql=null)
static	getContentArray (SimpleORMap $sorm, $to_utf8=true)
static	getCount ($filter=null)
static	getCountBySql ($sql, $filter=null)
static	setLanguage ($language)
static	setContentLanguage ($language)
static	getLanguage () = htmlReady($modul['name'])
static	getLocaleOrdinalNumberSuffix ($num)
static	getPublicStatus ($class_name=null)
static	findCached ($id, $index=null)
static	clearCache ($index=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 ModuleManagementModelTreeItem
static	sortTrails ($trail_a, $trail_b)
Static Protected Member Functions inherited from ModuleManagementModel
static	configure ($config=[])
static	checkSortFields ($sort, $standard_field=null, $additional_fields=[])
static	createSortStatement ($sort, $order='ASC', $standard_field=null, $additional_fields=[])
static	fromCache ($index, $id, Callable $finder)
static	formatDisplayName (string $template, array $placeholders, array $replacements)
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 ModuleManagementModel
	$object_real_name = ''
Data Fields inherited from SimpleORMap
const	ID_SEPARATOR = '_'
Data Fields inherited from MvvTreeItem
const	TRAIL_SHOW_INCOMPLETE = 1
Static Public Attributes inherited from ModuleManagementModelTreeItem
static	$TRAIL_DEFAULT
Static Public Attributes inherited from SimpleORMap
static	$schemes = null
Protected Member Functions inherited from ModuleManagementModel
	logChanges ($action=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 ModuleManagementModel
	$is_dirty = false
Protected Attributes inherited from SimpleORMap
	$content = []
	$content_db = []
	$is_new = true
	$is_deleted = false
	$relations = []
	$additional_data = []
Static Protected Attributes inherited from ModuleManagementModelTreeItem
static	$object_filter = []
Static Protected Attributes inherited from ModuleManagementModel
static	$filter_params = []
static	$perm_object = null
static	$object_cache = []
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

Constructor & Destructor Documentation

__construct()

__construct

(

$id = null

)

Implements ModuleManagementInterface.

Member Function Documentation

assignLanguagesOfInstruction()

assignLanguagesOfInstruction

(

$languages

)

Assignes languages of instruction to this study course.

Parameters

array

$languages

An array of language keys defined in mvv_config.php.

assignStudycourseTypes()

assignStudycourseTypes

(

$types

)

Assigns studycourse types to this study course.

Parameters

array

$types

An array of names of study course types.

configure()

static configure (   $config = [] )

staticprotected

findByAbschluss()

static findByAbschluss (   $abschluss_id )

static

Retrieves all Studiengaenge by given Abschluss.

Parameters

string

$abschluss_id

The id of an Abschluss.

Returns

SimpleORMapCollection A collection of Studiengaenge.

findByAbschlussKategorie()

static findByAbschlussKategorie (   $kategorie_id )

static

Retrieves all Studiengänge ba given Abschluss-Kategorie.

Parameters

string

$kategorie_id

The id of an Abschluss-Kategorie.

Returns

SimpleORMapCollection A collection of Studiengaenge.

findByAbschlussKategorieFachbereich()

static findByAbschlussKategorieFachbereich (   $kategorie_id,   $fachbereich_id  )

static

Retrieves all Studiengange by a given combination of Abschluss-Kategorie and Fachbereich. The Fachbereich is an institute assigned to the fach of a Studiengangteil which is assigned to Studiengaenge.

Parameters

string	$kategorie_id	The id of an Abschluss-Kategorie.
string	$fachbereich_id	The id of an institute.

Returns

SimpleORMapCollection A collection of Studiengaenge.

findByFachAbschluss()

static findByFachAbschluss (   $fach_id,   $abschluss_id,   $filter = null  )

static

Retrieves all Studiengaenge by a given combination of Fach/Abschluss.

Parameters

string	$fach_id	The id of a Fach.
string	$abschluss_id	The id of an Abschluss.
array	$filter	Key-value pairs of names and values to filter the result set.

Returns

SimpleORMapCollection A collection of Studiengaenge.

findByFachbereich()

static findByFachbereich (   $fachbereich_id )

static

Retrieves all Studiengaenge by given Fachbereich. The Fachbereich is an institute assigned to the fach of a Studiengangteil which is assigned to Studiengaenge.

Parameters

string

$fachbereich_id

The id of an institute.

Returns

SimpleORMapCollection A collection of Studiengaenge.

findByFilter()

static findByFilter (   $filter )

static

Returns an array with ids of all Studiengaenge found by the given filter. If no filter is set an empty array will be returned.

See also

ModuleManagementModel::getFilterSql()

Parameters

array

$filter

Key-value pairs of filed names and values to filter the result set.

Returns

array An array of Studiengang ids.

findByIds()

static findByIds (   $studiengang_ids,   $filter = null  )

static

Retrieves all Studiengaenge by given ids optionally filtered.

See also

ModuleManagementModel::getFilterSql()

Parameters

array	$studiengang_ids	An array of Studiengang ids.
array	$filter	Key-value pairs of filed names and values to filter the result set.

Returns

SimpleORMapCollection A collection of Studiengaenge.

findByModule()

static findByModule (   $modul_ids,   $only_public = true  )

static

Retrieves all Studiengaenge the given Module are assigned to. The assignment is done via Studiengangabschnitte, Studiengangteil- Versionen and Studiengangteil. Optionallay restricted to public visible Studiengaenge.

Parameters

array	$modul_ids	An array of Modul ids.
boolean	$only_public	If true retrieve only public visible ones.

Returns

SimpleORMapCollection A collection of Studiengaenge.

findBySearchTerm()

static findBySearchTerm (   $term,   $filter = null  )

static

See also

ModuleManagementModel::findBySearchTerm()

findByStgTeil()

static findByStgTeil (   $stgteil_id )

static

Retrieves all Studiengaenge the given Studiengangteil is assigned to.

Parameters

string

$stgteil_id

The id of a Studiengangteil.

Returns

SimpleORMapCollection A collection of Studiengangteile.

findStatusByIds()

static findStatusByIds (   $studiengang_ids = [] )

static

Returns an array with all types of status found by given studiengang ids as key and the number of associated Studiengaenge as value.

Parameters

array

$studiengang_ids

Returns

array

getAllAssignedInstitutes()

static getAllAssignedInstitutes (   $filter = null )

static

Returns all institutes assigned to studiengaenge.

See also

ModuleManagementModel::getFilterSql()

Parameters

array

$filter

Key-value pairs of filed names and values to filter the result set.

Returns

SimpleORMapCollection A collection of institutes.

getAllEnriched()

static getAllEnriched (   $sortby = 'name',   $order = 'ASC',   $filter = null,   $row_count = null,   $offset = null  )

static

Returns all or a specified (by row count and offset) number of Studiengaenge sorted and filtered by given parameters and enriched with some additional fields. This function is mainly used in the list view.

Parameters

string	$sortby	Field name to order by.
string	$order	ASC or DESC direction of order.
array	$filter	Key-value pairs of filed names and values to filter the result set.
int	$row_count	The max number of objects to return.
int	$offset	The first object to return in a result set.

Returns

SimpleORMapCollection A collection of Studiengaenge.

getChildren()

getChildren

(

)

See also

MvvTreeItem::getChildren()

Implements MvvTreeItem.

getClassDisplayName()

static getClassDisplayName (   $long = false )

static

See also

ModuleManagementModel::getClassDisplayName

getCount()

static getCount (   $filter = null )

static

Returns the number of Studiengaenge optional filtered by $filter.

See also

ModuleManagementModel::getFilterSql()

Parameters

array

$filter

Key-value pairs of filed names and values to filter the result set.

Returns

int The number of Studiengaenge

getDisplayName()

getDisplayName

(

)

Returns the name of the object to displa in the trail.

Returns

string

Implements MvvTreeItem.

getEndSem()

getEndSem

(

)

Returns the last semester this studiengang is active.

Returns

object semester

getEnriched()

static getEnriched (   $studiengang_id )

static

Retrieves the Studiengang and all related data and some additional fields.

Parameters

string

$studiengang_id

The id of the studiengang.

Returns

object The Studiengang with additional data or a new Studiengang.

getParents()

getParents

(

$mode = null

)

See also

MvvTreeItem::getParents()

Implements MvvTreeItem.

getRelatedModules()

getRelatedModules	(		$only_public = true,
			$modul_ids = null
	)

Returns an array with Modul ids from modules related to this Studiengang. The relation is done via Studiengangteile, Studiengangteil-Versionen and Studiengangteil-Abschnitte. Optionally restricted to only public visible modules and filtered by an array of Modul ids.

Parameters

boolean	$only_public	If true only public visible modules will be retrieved.
array	$modul_ids	An array of module ids. Only the intersection of these modules and the found modules will be returned.

Returns

array An array of Modul ids.

getResponsibleInstitutes()

getResponsibleInstitutes

(

)

See also

ModuleManagementModel::getResponsibleInstitutes()

getStartSem()

getStartSem

(

)

Returns the first semester this studiengang is active.

Returns

object semester

getTrailParent()

getTrailParent

(

)

See also

MvvTreeItem::getTrailParent()

Implements MvvTreeItem.

getTrailParentId()

getTrailParentId

(

)

See also

MvvTreeItem::getTrailParentId()

Implements MvvTreeItem.

getVariant()

getVariant

(

)

hasChildren()

hasChildren

(

)

See also

MvvTreeItem::hasChildren()

Implements MvvTreeItem.

isActive()

isActive

(

)

Returns whether this studiengang is active.

Returns

boolean true if active

toArrayFachbereichAbschlussKategorie()

static toArrayFachbereichAbschlussKategorie (   $fachbereich_id,   $kategorie_id  )

static

Returns an array with all studiengaenge filtered by Fachbereich and Abschluss-Kategorie. The associated array contains only the name and the id of the Studiengang with the id as key. The content is utf8 encoded.

Parameters

string	$fachbereich_id	The id of the Fachbereich
string	$kategorie_id	The id of the Abschluss-Kategorie

Returns

array The array with studiengaenge. Empty if no Studiengang was found.

validate()

validate

(

)

---

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

• lib/models/Studiengang.php