Stud.IP  trunk Revision
Modulteil Class Reference
Inheritance diagram for Modulteil:
Inheritance graph
Collaboration diagram for Modulteil:
Collaboration graph

Public Member Functions

 __construct ($id=null)
 
 getDisplayName ($options=self::DISPLAY_DEFAULT)
 
 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 ($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 getClassDisplayName ($long=false)
 
static findByModul ($modul_id)
 
static findByLvgruppe ($lvgruppe_id)
 
- 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)

constructor, give primary key of record as param to fetch corresponding record from db if available, if not preset primary key with given value. Give null to create new record

Parameters
mixed$idprimary key of table

Reimplemented from SimpleORMap.

Member Function Documentation

◆ assignLanguagesOfInstruction()

assignLanguagesOfInstruction (   $languages)

Assignes languages of instruction to this part-module.

Parameters
type$languagesAn array of language keys defined in mvv_config.php.
Here is the call graph for this function:

◆ configure()

static configure (   $config = [])
staticprotected

set configuration data from subclass

Parameters
array$configconfiguration data
Returns
void

Reimplemented from SimpleORMap.

◆ copy()

copy (   $deep = false,
  $with_assignments = false 
)

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

Returns
\Modulteil
Here is the call graph for this function:

◆ findByLvgruppe()

static findByLvgruppe (   $lvgruppe_id)
static

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

Parameters
type$lvgruppe_idThe id of a LV-Gruppe.
Returns
SimpleORMapCollection A collection of Modulteile.
Here is the caller graph for this function:

◆ findByModul()

static findByModul (   $modul_id)
static

Retrieves all Modulteile of the given Modul.

Parameters
type$modul_idThe id of a Modul.
Returns
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.

Parameters
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.
Returns
array An array of course data.

◆ 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

◆ getDefaultLanguage()

getDefaultLanguage ( )

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

See also
mvv_config.php for defined languages.
Returns
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.

Parameters
string$languageThe id of the language
boolIf true returns always a new descriptor
Returns
object The Deskriptor.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ getDisplayName()

getDisplayName (   $options = self::DISPLAY_DEFAULT)

Returns the name of the object to display in a specific context. The default is the value from the db fields "name" or "bezeichnung" or an empty string if no such fields exist. This method is overwritten by most of the mvv objects to display more complex names glued together from fields of related objects.

Parameters
mixed$optionsAn optional parameter to set display options.
Returns
string The name for

Reimplemented from ModuleManagementModel.

Here is the call graph for this function:

◆ getParents()

getParents (   $mode = null)
See also
MvvTreeItem::getParents()
Here is the call graph for this function:

◆ getResponsibleInstitutes()

getResponsibleInstitutes ( )

Reimplemented from ModuleManagementModel.

Here is the call graph for this function:

◆ getStatus()

getStatus ( )

Inherits the status of the parent module.

Returns
string The status (see mvv_config.php)

Reimplemented from ModuleManagementModel.

Here is the call graph for this function:

◆ 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:

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