Inheritance diagram for Fach:

Collaboration diagram for Fach:

Public Member Functions
	__construct ($id=null)

	assignFachbereiche ($fachbereiche)

	getFachbereiche ()

	getAbschluesse ()

	getTrailParentId ()

	getTrailParent ()

	getChildren ()

	hasChildren ()

	getParents ($mode=null)

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

	validate ()

	getResponsibleInstitutes ()

	countUser ()

	countUserByDegree ($degree_id)

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 ($options=self::DISPLAY_DEFAULT)

	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)

	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	getAllEnriched ($sortby='name', $order='ASC', $row_count=null, $offset=null, $filter=null)

static	getCount ($filter=null)

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

static	findByStudiengangTeil ($stgteil_id)

static	findByStudiengang ($studiengang_id)

static	findByAbschluss ($abschluss_id)

static	findByFachbereich ($fachbereich_id, $has_stgteile=false)

static	findPublicByModule ($modul_ids)

static	findBySearchTermStgteile ($term)

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

static	getAssignedFachbereiche ($order='ASC')

static	getAllAssignedInstitutes ($studiengang_ids=[])

static	findUsedFachbereiche ($kategorie_id=null, $abschluss_id=null)

static	getAllFachbereiche ($sortby='name', $order='ASC', $filter=null)

static	toArrayByFachbereichStgteil ($fachbereich_id, $stgteil_id)

static	getClassDisplayName ($long=false)

static	exportUserData (StoredUserData $storage)

Static Public Member Functions inherited from ModuleManagementModelTreeItem
static	getPathes ($trails, $delimiter=' Â· ', $display_options=self::DISPLAY_DEFAULT)

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

static	getLocaleOrdinalNumberSuffix ($num)

static	getPublicStatus ($class_name=null)

Static Public Member Functions inherited from SimpleORMap
static	tableScheme ($db_table)

static	expireTableScheme ()

static	find ($id)

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 ($name, $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	checkSortFields ($sort, $standard_field=null, $additional_fields=[])

static	createSortStatement ($sort, $order='ASC', $standard_field=null, $additional_fields=[])

Static Protected Member Functions inherited from SimpleORMap
static	configure ($config=[])

static	config ($key)

Additional Inherited Members
Data Fields inherited from ModuleManagementModel
const	DISPLAY_DEFAULT = 1

const	DISPLAY_SEMESTER = 2

const	DISPLAY_CODE = 4

const	DISPLAY_FACULTY = 8

const	DISPLAY_FACH = 16

const	DISPLAY_STGTEIL = 32

const	DISPLAY_ABSCHLUSS = 64

const	DISPLAY_KATEGORIE = 128

	$object_real_name = ''

Data Fields inherited from SimpleORMap
const	ID_SEPARATOR = '_'

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)

	registerCallback ($types, $cb)

	unregisterCallback ($types, $cb)

	cbAutoIncrementColumn ($type)

	cbAutoKeyCreation ()

	cbNotificationMapper ($cb_type)

	cbAfterInitialize ($cb_type)

	setSerializedValue ($field, $value)

	setI18nValue ($field, $value)

	cbI18N ($type)

Protected Attributes inherited from ModuleManagementModel
	$is_dirty = false

Protected Attributes inherited from SimpleORMap
	$content = []

	$content_db = []

	$is_new = true

	$is_deleted = false

	$db_table = ''

	$db_fields = null

	$pk = null

	$default_values = []

	$serialized_fields = []

	$alias_fields = []

	$i18n_fields = []

	$additional_fields = []

	$relations = []

	$has_many = []

	$has_one = []

	$belongs_to = []

	$has_and_belongs_to_many = []

	$registered_callbacks = []

	$known_slots = []

	$notification_map = []

	$additional_data = []

	$getter_setter_map = []

Static Protected Attributes inherited from ModuleManagementModelTreeItem
static	$object_filter = []

Static Protected Attributes inherited from ModuleManagementModel
static	$filter_params = []

static	$perm_object = null

Static Protected Attributes inherited from SimpleORMap
static	$config = []

static	$reserved_slots = ['value','newid','iterator','tablemetadata', 'relationvalue','wherequery','relationoptions','data','new','id']

Constructor & Destructor Documentation

◆ __construct()

__construct ( $id = null )

Parameters

string $id primary key of table

Reimplemented from SimpleORMap.

Member Function Documentation

◆ assignFachbereiche()

assignFachbereiche ( $fachbereiche )

Assignes fachbereiche to this fach. Returns true only if all given fachbereich ids are valid.

Parameters

string[]|object[] Array of $fachbereich_ids or fachbereich objects.

Returns: boolean True if fachbereiche was successfully assigned.

Here is the call graph for this function:

◆ configure()

static configure ( $config = [] )

staticprotected

set configuration data from subclass

Parameters

array $config configuration data

Returns: void

Reimplemented from SimpleORMap.

◆ countUser()

countUser ( )

The number of users this Fach was selected by.

Returns: int The number of users.

Here is the call graph for this function:

◆ countUserByDegree()

countUserByDegree ( $degree_id )

The number of users this Fach was selected by. Filtered by given degree (Abschluss).

Returns: int The number of users.

Here is the call graph for this function:

◆ 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

Here is the call graph for this function:

◆ findByAbschluss()

static findByAbschluss ( $abschluss_id )

static

Retrieves all Faecher implicitly assigned to the given Abschluss.

Parameters

string $abschluss_id The id of the Abschluss.

Returns: object Collection of Faecher assigned to the given Abschluss.

Here is the caller graph for this function:

◆ findByFachbereich()

static findByFachbereich	(	$fachbereich_id,
		$has_stgteile = `false`
	)

static

Retrieves all Faecher the giveb Fachbereich is assigned to. If the 2nd parameter is true, only Faecher assigned to Studiengangteile will be returned.

Parameters

string $abschluss_id The id of the Abschluss.

Returns: object Collection of Faecher assigned to the given Abschluss.

Here is the caller graph for this function:

◆ findByIdsStgteile()

static findByIdsStgteile	(	$stgteil_ids,
		$sortby = `'name'`,
		$order = `'ASC'`,
		$row_count = `null`,
		$offset = `null`,
		$filter = `null`
	)

static

Returns all Faecher which are assigned to the given Studiengangteile. Sorted and filtered by optional parameters.

Parameters

	array	Array of Studiengangteil ids.
string	$sortby	Column names to sort by.
strind	$order	Direction of sorting ASC\|DESC.
int	$row_count	Number of rows to return.
int	$offset	Offset of first row to return.
array	$filter	Array of filter parameters (name of column as key,

Returns: object Collection of Faecher.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ findBySearchTermStgteile()

static findBySearchTermStgteile ( $term )

static

Retrieves all Faecher by given search term. The term is compared to name of the Fach and the column "zusatz" of the Studiengangteil the Fach ist assigned to.

Parameters

string $term The search term.

Returns: object Collection of Faecher.

Here is the call graph for this function:

◆ findByStudiengang()

static findByStudiengang ( $studiengang_id )

static

Retrieves all Faecher assigned to the given Studiengang.

Parameters

string $studiengang_id The id of the Studiengang.

Returns: object Collection of Faecher assigned to the given Studiengang.

◆ findByStudiengangTeil()

static findByStudiengangTeil ( $stgteil_id )

static

Retrieves the Fach assigned to the given Studiengangteil.

Parameters

string $stgteil_id The id of the Studiengangteil.

Returns: object Fach assigned to the given Studiengangteil contained in a collection.

◆ findPublicByModule()

static findPublicByModule ( $modul_ids )

static

Retrieves all Faecher implicitly assigned by public Studiengangteile to the given modules.

Parameters

array $modul_ids Ids of modules.

Returns: object Collection of Faecher.

Here is the call graph for this function:

◆ findUsedFachbereiche()

static findUsedFachbereiche	(	$kategorie_id = `null`,
		$abschluss_id = `null`
	)

static

Finds all Fachbereiche assigned to Faecher. The result can be filtered by a Abschluss-Kategorie or an Abschluss.

Parameters

string	$kategorie_id	The id of the Abschluss-Kategorie.
string	$abschluss_id	The id of the Abschluss.

Returns: array Found Fachbereiche as array. Empty array if none was found.

Here is the call graph for this function:

◆ getAbschluesse()

getAbschluesse ( )

Returns all Abschluesse this Fach is implicitly assigned to.

Returns: A collection of Faecher.

Here is the call graph for this function:

◆ getAllAssignedInstitutes()

static getAllAssignedInstitutes ( $studiengang_ids = [] )

static

Returns an associative array of institutes (name and id) assigned to studiengaenge. Can be filtered by ids of studiengaenge.

Parameters

array $studiengang_ids Limits the result to these studiengaenge.

Returns: array Associative array (id and name) of institutes.

Here is the call graph for this function:

◆ getAllEnriched()

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

static

Returns all or a specified (by row count and offset) number of Abschluesse 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: object A SimpleORMapCollection of Abschluss objects.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAllEnrichedByStgteile()

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

static

Returns all Faecher which are assigned to Studiengangteile. Sorted and filtered by optional parameters.

Parameters

string	$sortby	Column names to sort by.
strind	$order	Direction of sorting ASC\|DESC.
int	$row_count	Number of rows to return.
int	$offset	Offset of first row to return.
array	$filter	Array of filter parameters (name of column as key,

Returns: object Collection of Faecher.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAllFachbereiche()

static getAllFachbereiche	(	$sortby = `'name'`,
		$order = `'ASC'`,
		$filter = `null`
	)

static

Returns names ans ids of all Fachbereiche (institutes) with number of related Faecher. Sorted and filtered by optional parameters.

Parameters

string	$sortby	Column names to sort by.
strind	$order	Direction of sorting ASC\|DESC.
array	$filter	Array of filter parameters (name of column as key, see ModulManagementModel::getFilterSql()).

Returns: array Associative array of Fachbereiche (id as key).

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAssignedFachbereiche()

static getAssignedFachbereiche ( $order = 'ASC' )

static

Returns an associative array of all Fachbereiche assigned to Faecher.

Parameters

string $order Direction of sorting ASC|DESC.

Returns: array An associative array of Faecher.

Here is the call graph for this function:

◆ getChildren()

getChildren ( )

See also: MvvTreeItem::getChildren()

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getClassDisplayName()

static getClassDisplayName ( $long = false )

static

See also: ModuleManagementModel::getClassDisplayName

Reimplemented from ModuleManagementModel.

◆ getCount()

static getCount ( $filter = null )

static

Returns the number of FÃ¤cher optional filtered by $filter.

Parameters

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

Returns: int The number of FÃ¤cher

Reimplemented from ModuleManagementModel.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFachbereiche()

getFachbereiche ( )

Returns all Fachbereiche assigned to this Fach.

Returns: array All assigned Fachbereiche.

◆ getParents()

getParents ( $mode = null )

See also: MvvTreeItem::getParents()

◆ getRelatedModules()

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

Returns ids of all modules which are related to this Fach. The relation is done by assigning a Fach to a Studiengangteil and the modules to a version of that Studiengangteil.

Parameters

boolean $only_public If true only modules with a public state will be returned.

Returns: array

Here is the call graph for this function:

◆ getResponsibleInstitutes()

getResponsibleInstitutes ( )

Returns all responsible institutes.

Returns: array An array of Fachbereich objects.

Reimplemented from ModuleManagementModel.

◆ getTrailParent()

getTrailParent ( )

See also: MvvTreeItem::getTrailParent()

Here is the call graph for this function:

◆ getTrailParentId()

getTrailParentId ( )

See also: MvvTreeItem::getTrailParentId()

Reimplemented from ModuleManagementModelTreeItem.

Here is the caller graph for this function:

◆ hasChildren()

hasChildren ( )

See also: MvvTreeItem::hasChildren()

Reimplemented from ModuleManagementModelTreeItem.

Here is the call graph for this function:

◆ toArrayByFachbereichStgteil()

static toArrayByFachbereichStgteil	(	$fachbereich_id,
		$stgteil_id
	)

static

Returns an array with all faecher which are used by given Fachbereich and the given Studiengangteil.

Parameters

string	$fachbereich_id	The id of a Fachbereich (institute)
string	$stgteil_id	The id oa a Studiengangteil.

Returns: array Associative array of Faecher with id as key.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ validate()

validate ( )

Validates the values before store. Throws an InvalidValuesException normally catched by form validation.

Exceptions

InvalidValuesException

Reimplemented from ModuleManagementModel.

Here is the call graph for this function:

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

lib/models/Fach.php

Public Member Functions

Static Public Member Functions

Static Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ assignFachbereiche()

◆ configure()

◆ countUser()

◆ countUserByDegree()

◆ exportUserData()

◆ findByAbschluss()

◆ findByFachbereich()

◆ findByIdsStgteile()

◆ findBySearchTermStgteile()

◆ findByStudiengang()

◆ findByStudiengangTeil()

◆ findPublicByModule()

◆ findUsedFachbereiche()

◆ getAbschluesse()

◆ getAllAssignedInstitutes()

◆ getAllEnriched()

◆ getAllEnrichedByStgteile()

◆ getAllFachbereiche()

◆ getAssignedFachbereiche()

◆ getChildren()

◆ getClassDisplayName()

◆ getCount()

◆ getFachbereiche()

◆ getParents()

◆ getRelatedModules()

◆ getResponsibleInstitutes()

◆ getTrailParent()

◆ getTrailParentId()

◆ hasChildren()

◆ toArrayByFachbereichStgteil()

◆ validate()