Stud.IP  4.0
 All Data Structures Namespaces Files Functions Variables Groups
Studiengang Class Reference
Inheritance diagram for Studiengang:
ModuleManagementModelTreeItem ModuleManagementModel MvvTreeItem SimpleORMap ModuleManagementInterface

Public Member Functions

 __construct ($id=null)
 
 getDisplayName ($options=self::DISPLAY_DEFAULT)
 
 getRelatedModules ($only_public=true, $modul_ids=null)
 
 getStartSem ()
 
 getEndSem ()
 
 getResponsibleInstitutes ()
 
 isActive ()
 
 getVariant ()
 
 getTrailParentId ()
 
 getTrailParent ()
 
 getChildren ()
 
 getParents ($mode=null)
 
 hasChildren ()
 
 assignLanguagesOfInstruction ($languages)
 
 assignStudycourseTypes ($types)
 
 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 ($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 ()
 
- Public Member Functions inherited from MvvTreeItem
 getId ()
 
 getDisplayName ()
 

Static Public Member Functions

static findByAbschluss ($abschluss_id)
 
static findByFachAbschluss ($fach_id, $abschluss_id, $filter=null)
 
static findByFachbereich ($fachbereich_id)
 
static findByAbschlussKategorie ($kategorie_id)
 
static findByAbschlussKategorieFachbereich ($kategorie_id, $fachbereich_id)
 
static findByStgTeil ($stgteil_id)
 
static findByModule ($modul_ids, $only_public=true)
 
static toArrayFachbereichAbschlussKategorie ($fachbereich_id, $kategorie_id)
 
static getAllEnriched ($sortby= 'name', $order= 'ASC', $filter=null, $row_count=null, $offset=null)
 
static getCount ($filter=null)
 
static getEnriched ($studiengang_id)
 
static getAllAssignedInstitutes ($filter=null)
 
static findBySearchTerm ($term, $filter=null)
 
static findByIds ($studiengang_ids, $filter=null)
 
static findStatusByIds ($studiengang_ids=[])
 
static findByFilter ($filter)
 
static getClassDisplayName ($long=false)
 
- 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 () = 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 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 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 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
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 = '_'
 
- 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)
 
 cbAutoIncrementColumn ($type)
 
 cbAutoKeyCreation ()
 
 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 (   $id = null)

Member Function Documentation

assignLanguagesOfInstruction (   $languages)

Assignes languages of instruction to this study course.

Parameters
array$languagesAn array of language keys defined in mvv_config.php.
assignStudycourseTypes (   $types)

Assigns studycourse types to this study course.

Parameters
array$typesAn array of names of study course types.
static configure (   $config = [])
staticprotected
static findByAbschluss (   $abschluss_id)
static

Retrieves all Studiengaenge by given Abschluss.

Parameters
string$abschluss_idThe id of an Abschluss.
Returns
SimpleORMapCollection A collection of Studiengaenge.
static findByAbschlussKategorie (   $kategorie_id)
static

Retrieves all Studiengänge ba given Abschluss-Kategorie.

Parameters
string$kategorie_idThe id of an Abschluss-Kategorie.
Returns
SimpleORMapCollection A collection of Studiengaenge.
static findByAbschlussKategorieFachbereich (   $kategorie_id,
  $fachbereich_id 
)
static

Retrieves all Studiengange by a given combination of Abschluss-Kategorie and Fachbereich. The Fachbereich is an institute assigned to the fach of a Studiengangteil which is assigned to Studiengaenge.

Parameters
string$kategorie_idThe id of an Abschluss-Kategorie.
string$fachbereich_idThe id of an institute.
Returns
SimpleORMapCollection A collection of Studiengaenge.
static findByFachAbschluss (   $fach_id,
  $abschluss_id,
  $filter = null 
)
static

Retrieves all Studiengaenge by a given combination of Fach/Abschluss.

Parameters
string$fach_idThe id of a Fach.
string$abschluss_idThe id of an Abschluss.
array$filterKey-value pairs of names and values to filter the result set.
Returns
SimpleORMapCollection A collection of Studiengaenge.
static findByFachbereich (   $fachbereich_id)
static

Retrieves all Studiengaenge by given Fachbereich. The Fachbereich is an institute assigned to the fach of a Studiengangteil which is assigned to Studiengaenge.

Parameters
string$fachbereich_idThe id of an institute.
Returns
SimpleORMapCollection A collection of Studiengaenge.
static findByFilter (   $filter)
static

Returns an array with ids of all Studiengaenge found by the given filter. If no filter is set an empty array will be returned.

See Also
ModuleManagementModel::getFilterSql()
Parameters
array$filterKey-value pairs of filed names and values to filter the result set.
Returns
array An array of Studiengang ids.
static findByIds (   $studiengang_ids,
  $filter = null 
)
static

Retrieves all Studiengaenge by given ids optionally filtered.

See Also
ModuleManagementModel::getFilterSql()
Parameters
array$studiengang_idsAn array of Studiengang ids.
array$filterKey-value pairs of filed names and values to filter the result set.
Returns
SimpleORMapCollection A collection of Studiengaenge.
static findByModule (   $modul_ids,
  $only_public = true 
)
static

Retrieves all Studiengaenge the given Module are assigned to. The assignment is done via Studiengangabschnitte, Studiengangteil- Versionen and Studiengangteil. Optionallay restricted to public visible Studiengaenge.

Parameters
array$modul_idsAn array of Modul ids.
boolean$only_publicIf true retrieve only public visible ones.
Returns
SimpleORMapCollection A collection of Studiengaenge.
static findBySearchTerm (   $term,
  $filter = null 
)
static
static findByStgTeil (   $stgteil_id)
static

Retrieves all Studiengaenge the given Studiengangteil is assigned to.

Parameters
string$stgteil_idThe id of a Studiengangteil.
Returns
SimpleORMapCollection A collection of Studiengangteile.
static findStatusByIds (   $studiengang_ids = [])
static

Returns an array with all types of status found by given studiengang ids as key and the number of associated Studiengaenge as value.

Parameters
array$studiengang_ids
Returns
array
static getAllAssignedInstitutes (   $filter = null)
static

Returns all institutes assigned to studiengaenge.

See Also
ModuleManagementModel::getFilterSql()
Parameters
array$filterKey-value pairs of filed names and values to filter the result set.
Returns
SimpleORMapCollection A collection of institutes.
static getAllEnriched (   $sortby = 'name',
  $order = 'ASC',
  $filter = null,
  $row_count = null,
  $offset = null 
)
static

Returns all or a specified (by row count and offset) number of Studiengaenge sorted and filtered by given parameters and enriched with some additional fields. This function is mainly used in the list view.

Parameters
string$sortbyField name to order by.
string$orderASC or DESC direction of order.
array$filterKey-value pairs of filed names and values to filter the result set.
int$row_countThe max number of objects to return.
int$offsetThe first object to return in a result set.
Returns
SimpleORMapCollection A collection of Studiengaenge.
getChildren ( )
static getClassDisplayName (   $long = false)
static
static getCount (   $filter = null)
static

Returns the number of Studiengaenge optional filtered by $filter.

See Also
ModuleManagementModel::getFilterSql()
Parameters
array$filterKey-value pairs of filed names and values to filter the result set.
Returns
int The number of Studiengaenge
getDisplayName (   $options = self::DISPLAY_DEFAULT)
getEndSem ( )

Returns the last semester this studiengang is active.

Returns
object semester
static getEnriched (   $studiengang_id)
static

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

Parameters
string$studiengang_idThe id of the studiengang.
Returns
object The Studiengang with additional data or a new Studiengang.
getParents (   $mode = null)
getRelatedModules (   $only_public = true,
  $modul_ids = null 
)

Returns an array with Modul ids from modules related to this Studiengang. The relation is done via Studiengangteile, Studiengangteil-Versionen and Studiengangteil-Abschnitte. Optionally restricted to only public visible modules and filtered by an array of Modul ids.

Parameters
boolean$only_publicIf true only public visible modules will be retrieved.
array$modul_idsAn array of module ids. Only the intersection of these modules and the found modules will be returned.
Returns
array An array of Modul ids.
getResponsibleInstitutes ( )
getStartSem ( )

Returns the first semester this studiengang is active.

Returns
object semester
getTrailParent ( )
getTrailParentId ( )
getVariant ( )
hasChildren ( )
isActive ( )

Returns whether this studiengang is active.

Returns
boolean true if active
static toArrayFachbereichAbschlussKategorie (   $fachbereich_id,
  $kategorie_id 
)
static

Returns an array with all studiengaenge filtered by Fachbereich and Abschluss-Kategorie. The associated array contains only the name and the id of the Studiengang with the id as key. The content is utf8 encoded.

Parameters
string$fachbereich_idThe id of the Fachbereich
string$kategorie_idThe id of the Abschluss-Kategorie
Returns
array The array with studiengaenge. Empty if no Studiengang was found.
validate ( )

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