Lvgruppe Class Reference

Inheritance diagram for Lvgruppe:

Public Member Functions
	__construct ($id=null)
	addSeminar ($seminar_id)
	removeSeminar ($seminar_id)
	getTrailParentId ()
	getTrailParent ()
	getChildren ()
	hasChildren ()
	isAssignable ()
	getParents ($mode=null)
	getAssignedCoursesBySemester ($semester_id, $only_visible=true)
	getAllAssignedCourses ($only_visible=false, $semester_id=null)
	getArchivedCourses ()
	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 ()
	getDisplayName ()

Static Public Member Functions
static	getClassDisplayName ($long=false)
static	getAllEnriched ($sortby='name', $order='ASC', $filter=null, $row_count=null, $offset=null, $semester_id=null)
static	getCount ($filter=null)
static	findBySearchTerm ($term, $filter=null)
static	findByModulteil ($modulteil_id)
static	findBySeminar ($seminar_id)
static	getAllAssignedInstitutes ($sortby='name', $order='ASC', $filter=null, $row_count=null, $offset=null)
static	setLvgruppen ($seminar_id, $lvgruppen_ids)
static	getDefaultName ($modulteil_id)
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

addSeminar()

addSeminar

(

$seminar_id

)

Assigns the given seminar to this lvgruppe.

Parameters

string

$seminar_id

Returns

int|boolean

configure()

static configure (   $config = [] )

staticprotected

findByModulteil()

static findByModulteil (   $modulteil_id )

static

Retrieves all LV-Gruppen related to the Modulteil with given id.

Parameters

string

$modulteil_id

The id of a Modulteil.

Returns

SimpleORMapCollection A SimpleORMapCollection of LV-Gruppen.

findBySearchTerm()

static findBySearchTerm (   $term,   $filter = null  )

static

Retrieves all LV-Gruppen by given search term. The term is compared with the name of the LV-Gruppe, the code and the name of related modules

Parameters

string	$term	The search term.
array | string	$filter	An array with filter options or a where part.

Returns

SimpleORMapCollection A SimpleORMapCollection of LV-Gruppen.

findBySeminar()

static findBySeminar (   $seminar_id )

static

Retrieves all LV-Gruppen related to the course with given id.

Parameters

string

$seminar_id

The id of a course.

Returns

SimpleORMapCollection A SimpleORMapCollection of LV-Gruppen.

getAllAssignedCourses()

getAllAssignedCourses	(		$only_visible = false,
			$semester_id = null
	)

Returns all courses assigned to this LV-Gruppe grouped by semesters.

Parameters

bool	$only_visible	Return only visible courses.
string	$semester_id	Return only this semester.

Returns

Course[] All assigned courses grouped by semesters.

getAllAssignedInstitutes()

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

static

Returns all institutes assigned to Module.

Parameters

string	$sortby	DB field to sort by.
string	$order	ASC or DESC
array	$filter	Array of filter.

Returns

array Array of found Fachbereiche.

getAllEnriched()

static getAllEnriched (   $sortby = 'name',   $order = 'ASC',   $filter = null,   $row_count = null,   $offset = null,   $semester_id = 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.
	string	An id of a semester to restrict the result to groups assigned to courses span the semesters time range.

Returns

object A SimpleORMapCollection of Abschluss objects.

getArchivedCourses()

getArchivedCourses

(

)

Returns all archived courses previously assigned to this LV-Gruppe.

Returns

array All archived courses.

getAssignedCoursesBySemester()

getAssignedCoursesBySemester	(		$semester_id,
			$only_visible = true
	)

Retrieves courses this LV-Gruppe is assigned to. Filtered by a given semester considering the global visibility or the the visibility for a given user.

Parameters

string	$semester_id	The id of a semester.
mixed	$only_visible	Boolean true retrieves only visible courses, false retrieves all courses. If $only_visible is an user id it depends on the users status which courses will be retrieved.

Returns

array An array of course data.

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 LV-Gruppen optionally reduced by filter criteria.

Parameters

array	$filter	Key-value pairs of filed names and values to filter the result.
	string	An id of a semester to restrict the result to groups assigned to courses span the semesters time range.

Returns

type

getDefaultName()

static getDefaultName (   $modulteil_id )

static

Returns a default name for a new LV-Gruppe derived from a given modulteil.

Parameters

string

$modulteil_id

The id of a Modulteil.

Returns

string The default name.

getParents()

getParents

(

$mode = null

)

See also

MvvTreeItem::getParents()

Implements MvvTreeItem.

getTrailParent()

getTrailParent

(

)

See also

MvvTreeItem::getTrailParent()

Implements MvvTreeItem.

getTrailParentId()

getTrailParentId

(

)

See also

MvvTreeItem::getTrailParentId()

Implements MvvTreeItem.

hasChildren()

hasChildren

(

)

See also

MvvTreeItem::hasChildren()

Implements MvvTreeItem.

isAssignable()

isAssignable

(

)

See also

MvvTreeItem::isAssignable()

Implements MvvTreeItem.

removeSeminar()

removeSeminar

(

$seminar_id

)

Removes the seminar from this Lvgruppe.

Parameters

type

$seminar_id

Returns

boolean Always true...

setLvgruppen()

static setLvgruppen (   $seminar_id,   $lvgruppen_ids  )

static

Assigns the given course to the given LvGruppen.

Parameters

string

$seminar_id

Array of ids

Returns

int The number of assigned LvGruppen.

validate()

validate

(

)

---

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

• lib/models/Lvgruppe.php