Abschluss Class Reference

Inheritance diagram for Abschluss:

Public Member Functions
	__construct ($id=null)
	assignKategorie ($kategorie_id, $position=null)
	getFaecher ()
	getAssignedInstitutes ()
	getStudiengaenge ()
	getDisplayName ()
	getTrailParentId ()
	getTrailParent ()
	getChildren ()
	hasChildren ()
	getParents ($mode=null)
	validate ()
	countUser ()
	countUserByStudycourse ($studycourse_id)
	store ($validate=true)
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 (string $original_language)
	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	getAllEnriched ($sortby='name', $order='ASC', $row_count=null, $offset=null, $filter=null)
static	getCount ($filter=null)
static	findByFach ($fach_id)
static	findUsed ()
static	findByStudiengaenge ($studiengang_ids=[])
static	findByFachbereich ($fachbereich_id)
static	findByModul ($modul_id)
static	getClassDisplayName ($long=false)
static	exportUserData (StoredUserData $storage)
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	setContentLanguage ($language)
static	getLanguage ()
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	setMariadbDefaultColumnFix (bool $state=true)

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 = []
string	$i18n_class = I18NString::class
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
static	$mariadb_column_default_fix = false

Constructor & Destructor Documentation

__construct()

__construct

(

$id = null

)

Implements ModuleManagementInterface.

Member Function Documentation

assignKategorie()

assignKategorie	(		$kategorie_id,
			$position = null
	)

Assigns an Abschluss-Kategorie to this Abschluss.

Parameters

string	$kategorie_id	The id of the Abschluss-Kategorie
	int	Position of this Abschluss in the given Kategorie.

Returns

object|null The assigned Kategorie. Null if assigned Abschluss-Kategorie is unknown

configure()

static configure (   $config = [] )

staticprotected

countUser()

countUser

(

)

countUserByStudycourse()

countUserByStudycourse

(

$studycourse_id

)

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.

findByFach()

static findByFach (   $fach_id )

static

Returns all Abschluesse assigned to a given Fach.

Parameters

string

$fach_id

The id of the fach.

Returns

array An array of abschluss objects.

findByFachbereich()

static findByFachbereich (   $fachbereich_id )

static

Returns all Abschluesse assigned to the given Fachbereich.

Parameters

string

$fachbereich_id

The id of a Fachbereich.

Returns

array An array of Abschluesse.

findByModul()

static findByModul (   $modul_id )

static

Returns all Abschluesse assigned to the given module.

Parameters

string

$modul_id

The id of a module.

Returns

array An array of Abschluesse.

findByStudiengaenge()

static findByStudiengaenge (   $studiengang_ids = [] )

static

Returns all Abschluesse assigned to the given Studiengaenge.

Parameters

string | array

$studiengang_ids

One or more ids (as array) of Studiengaenge.

Returns

array An array of Abschluesse with number of assigned Studiengaenge.

findUsed()

static findUsed ( )

static

Returns all Abschluesse assigned to Studiengaenge.

Returns

array An array of Abschluesse.

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.
int	$row_count	The max number of objects to return.
int	$offset	The first object to return in a result set.
array	$filter	Key-value pairs of filed names and values to filter the result set.

Returns

object A SimpleORMapCollection of Abschluss objects.

getAssignedInstitutes()

getAssignedInstitutes

(

)

Returns all assigned institutes of this Abschluss.

Returns

array An array of institutes.

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 Abschlüsse 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 Abschluesse

getDisplayName()

getDisplayName

(

)

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

Returns

string

Implements MvvTreeItem.

getFaecher()

getFaecher

(

)

Returns all Faecher this Abschluss is assigned to.

Returns

array All Faecher this Abschluss is assigned to.

getParents()

getParents

(

$mode = null

)

See also

MvvTreeItem::getParents()

Implements MvvTreeItem.

getStudiengaenge()

getStudiengaenge

(

)

Returns all Studiengaenge assigned to this Abschluss.

Returns

object A SimpleORMapCollection of Studiengaenge.

getTrailParent()

getTrailParent

(

)

See also

MvvTreeItem::getTrailParent()

Implements MvvTreeItem.

getTrailParentId()

getTrailParentId

(

)

See also

MvvTreeItem::getTrailParentId()

Implements MvvTreeItem.

hasChildren()

hasChildren

(

)

See also

MvvTreeItem::hasChildren()

Implements MvvTreeItem.

store()

store

(

$validate = true

)

validate()

validate

(

)

---

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

• lib/models/Abschluss.php