Stud.IP  5.4
Modulteil Class Reference
Inheritance diagram for Modulteil:
ModuleManagementModelTreeItem ModuleManagementModel MvvTreeItem SimpleORMap ModuleManagementInterface

Public Member Functions

 __construct ($id=null)
 getDisplayName ()
 getDefaultLanguage ()
 getDeskriptor ($language=null, $force_new=false)
 copy ($deep=false, $with_assignments=false)
 getTrailParentId ()
 getTrailParent ()
 getChildren ()
 hasChildren ()
 getParents ($mode=null)
 assignLanguagesOfInstruction ($languages)
 getStatus ()
 getResponsibleInstitutes ()
 getAssignedCoursesBySemester ($semester_id, $only_visible=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 ()
 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 getClassDisplayName ($long=false)
static findByModul ($modul_id)
static findByLvgruppe ($lvgruppe_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
- Static Public Attributes inherited from ModuleManagementModelTreeItem
- 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)

Member Function Documentation

◆ assignLanguagesOfInstruction()

assignLanguagesOfInstruction (   $languages)

Assignes languages of instruction to this part-module.

type$languagesAn array of language keys defined in mvv_config.php.

◆ configure()

static configure (   $config = [])

◆ copy()

copy (   $deep = false,
  $with_assignments = false 

Returns a copy of this object. If $deep is true, copy the connection to the Lvgruppen also.


◆ findByLvgruppe()

static findByLvgruppe (   $lvgruppe_id)

Retrieves all Modulteile the given LV-Gruppe is assigned to.

string$lvgruppe_idThe id of a LV-Gruppe.
SimpleORMapCollection A collection of Modulteile.

◆ findByModul()

static findByModul (   $modul_id)

Retrieves all Modulteile of the given Modul.

string$modul_idThe id of a Modul.
SimpleORMapCollection A collection of Modulteile.

◆ getAssignedCoursesBySemester()

getAssignedCoursesBySemester (   $semester_id,
  $only_visible = true 

Retrieves all courses this Modulteil is assigned by its LV-Gruppen. Filtered by a given semester considering the global visibility or the the visibility for a given user.

string$semester_idThe id of a semester.
mixed$only_visibleBoolean 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.
array An array of course data.

◆ getChildren()

getChildren ( )

◆ getClassDisplayName()

static getClassDisplayName (   $long = false)

◆ getDefaultLanguage()

getDefaultLanguage ( )

Returns the default language (of the descriptor) for this Modulteil

See also
mvv_config.php for defined languages.
string The key of the default language.

◆ getDeskriptor()

getDeskriptor (   $language = null,
  $force_new = false 

Returns the Deskriptor in the given language. A Modul has always a Deskriptor in the default language. If the given language is unknown, the method returns the deskriptor in the default language.

string$languageThe id of the language
boolIf true returns always a new descriptor
object The Deskriptor.

◆ getDisplayName()

getDisplayName ( )

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


Implements MvvTreeItem.

◆ getParents()

getParents (   $mode = null)

◆ getResponsibleInstitutes()

getResponsibleInstitutes ( )

◆ getStatus()

getStatus ( )

Inherits the status of the parent module.

string The status (see mvv_config.php)

◆ getTrailParent()

getTrailParent ( )

◆ getTrailParentId()

getTrailParentId ( )

◆ hasChildren()

hasChildren ( )

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