StudiengangTeil Class Reference

Inheritance diagram for StudiengangTeil:

Public Member Functions
	__construct ($id=null)
	assignFach ($fach_id)
	getDisplayName ()
	getTrailParentId ()
	getTrailParent ()
	getChildren ()
	getParents ($mode=null)
	validate ()
	getResponsibleInstitutes ()
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	getEnriched ($stgteil_id)
static	getAllEnriched ($sortby='fach_name', $order='ASC', $filter=null, $row_count=null, $offset=null)
static	getCount ($filter=null)
static	findByStudiengang ($studiengang_id, $sort='stgteil_position, stgteil_chdate', $order='ASC')
static	findByFach ($fach_id, $filter=null, $sort='chdate', $order='DESC')
static	findByFachbereich ($fachbereich_id, $filter=null, $sort='chdate', $order='DESC')
static	getAssignedFachbereiche ($sortby='name', $order='ASC', $filter=null)
static	findByStudiengangStgteilBez ($studiengang_id, $stgteil_bez_id)
static	findBySearchTerm ($term, $filter=null)
static	getClassDisplayName ($long=false)
static	getCountAssignedFaecher ($filter=null)
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

assignFach()

assignFach

(

$fach_id

)

Assignes a Fach to this Studiengangteil. Returns true only if the given fach id is valid.

Parameters

String

Id of the Fach to assign.

Returns

boolean True if the fach was successfully assigned.

configure()

static configure (   $config = [] )

staticprotected

findByFach()

static findByFach (   $fach_id,   $filter = null,   $sort = 'chdate',   $order = 'DESC'  )

static

Retrieves all Studiengangteile by Fach. Optionally filtered by given filter parameter.

Parameters

string	$fach_id	The id of a Fach.
array	$filter	Key-value pairs of filed names and values to filter the result set.
string	$sort	Field names to order by.
string	$order	ASC or DESC direction of order.

Returns

SimpleORMapCollection A collection of Studiengangteile.

findByFachbereich()

static findByFachbereich (   $fachbereich_id,   $filter = null,   $sort = 'chdate',   $order = 'DESC'  )

static

Retrieves all Studiengangteile by given Fachbereich. The Fachbereich is the responsible institute of a Fach. The Fach is assigned to Studiengangteile.

Parameters

string	$fachbereich_id	The id of an institute.
array	$filter	Key-value pairs of filed names and values to filter the result set.
string	$sort	Field names to order by.
string	$order	ASC or DESC direction of order.

Returns

SimpleORMapCollection A collection of Studiengangteile.

findBySearchTerm()

static findBySearchTerm (   $term,   $filter = null  )

static

Returns the number of Studiengangteile 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 Studiengangteile.

findByStudiengang()

static findByStudiengang (   $studiengang_id,   $sort = 'stgteil_position, stgteil_chdate'  ,   $order = 'ASC'  )

static

Retrieves all Studienganteile assigned to the given Studiengang.

Parameters

string	$studiengang_id	The id of a Studiengang.
string	$sort	Field names to order by.
string	$order	ASC or DESC direction of order.

Returns

SimpleORMapCollection A collection of Studiengangteile.

findByStudiengangStgteilBez()

static findByStudiengangStgteilBez (   $studiengang_id,   $stgteil_bez_id  )

static

Retrieves all Studiengangteile by Studiengang and Studiengangteil- Bezeichnung in the case of Mehrfach-Studiengaenge.

Parameters

string	$studiengang_id	The id of a Studiengang.
string	$stgteil_bez_id	The id of a Studiengangteil-Bezeichnung.

Returns

SimpleORMapCollection A collection of Studiengangteile.

getAllEnriched()

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

static

Returns all or a specified (by row count and offset) number of Studiengangteile 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 names 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 Studiengangteile.

getAssignedFachbereiche()

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

static

Returns an array of all Fachbereiche assigned through Fächer to Studiengangteile.

Parameters

string	$sortby	Field names 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.

Returns

SimpleORMapCollection A collection of Studiengangteile.

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 Studienagngteile 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 Studiengangteile

getCountAssignedFaecher()

static getCountAssignedFaecher (   $filter = null )

static

Returns the number of Faecher which are assigned to Studiengangteile.

Returns

int the number of assigned Faecher

getDisplayName()

getDisplayName

(

)

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

Returns

string

Implements MvvTreeItem.

getEnriched()

static getEnriched (   $stgteil_id )

static

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

Parameters

string

$stgteil_id

The id of the Studiengangteil.

Returns

StudiengangTeil The Studiengangteil with additional data or a new StudiengangTeil.

getParents()

getParents

(

$mode = null

)

See also

MvvTreeItem::getParents()

Implements MvvTreeItem.

getResponsibleInstitutes()

getResponsibleInstitutes

(

)

getTrailParent()

getTrailParent

(

)

See also

MvvTreeItem::getTrailParent()

Implements MvvTreeItem.

getTrailParentId()

getTrailParentId

(

)

See also

MvvTreeItem::getTrailParentId()

Implements MvvTreeItem.

validate()

validate

(

)

---

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

• lib/models/StudiengangTeil.php