Stud.IP  4.1 Revision
StgteilVersion Class Reference
Inheritance diagram for StgteilVersion:
Inheritance graph
Collaboration diagram for StgteilVersion:
Collaboration graph

Public Member Functions

 __construct ($id=null)
 
 getDisplayName ($options=self::DISPLAY_DEFAULT)
 
 getDisplaySemesterValidity ()
 
 copy ()
 
 getTrailParentId ()
 
 getTrailParent ()
 
 getChildren ()
 
 getParents ($mode=null)
 
 hasChildren ()
 
 validate ()
 
 getStatus ()
 
 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 ($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
 getTrailParentId ()
 
 getTrailParent ()
 
 getChildren ()
 
 hasChildren ()
 
 getId ()
 
 getDisplayName ()
 
 isAssignable ()
 
 getParents ($mode)
 
 getTrails ($types=null, $mode=null, $path=null, $in_recursion=false)
 

Static Public Member Functions

static getClassDisplayName ($long=false)
 
static getEnriched ($version_id)
 
static getAllEnriched ($sortby='start', $order='ASC', $filter=null, $row_count=null, $offset=null)
 
static getCount ($filter=null)
 
static findByStgteil ($stgteil_id, $sortby='start', $order='ASC', $filter=null)
 
static findByFilter ($filter)
 
static findByStgteilAbschnitt ($abschnitt_id)
 
static findByFachAbschluss ($fach_id, $abschluss_id, $version_id=null)
 
- 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=array(), $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 getConfigStatus ($type, $class_name=null)
 
static getPublicStatus ($class_name=null)
 
static getVisibleStatus ($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=array())
 
static create ($data)
 
static build ($data, $is_new=true)
 
static buildExisting ($data)
 
static import ($data)
 
static findBySQL ($sql, $params=array())
 
static findByObject (SimpleORMap $object)
 
static findOneBySQL ($where, $params=array())
 
static findThru ($foreign_key_value, $options)
 
static findEachBySQL ($callable, $sql, $params=array())
 
static findMany ($pks=array(), $order='', $order_params=array())
 
static findEachMany ($callable, $pks=array(), $order='', $order_params=array())
 
static findAndMapBySQL ($callable, $where, $params=array())
 
static findAndMapMany ($callable, $pks=array(), $order='', $order_params=array())
 
static deleteBySQL ($where, $params=array())
 
static toObject ($id_or_object)
 
static __callStatic ($name, $arguments)
 

Static Protected Member Functions

static configure ($config=array())
 
- 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=array())
 
static createSortStatement ($sort, $order='ASC', $standard_field=null, $additional_fields=array())
 
static configure ($config=array())
 

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 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)
 
 getTableScheme ()
 
 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 = array()
 
 $content_db = array()
 
 $is_new = true
 
 $is_deleted = false
 
 $db_table = ''
 
 $db_fields = null
 
 $pk = null
 
 $default_values = array()
 
 $serialized_fields = array()
 
 $alias_fields = array()
 
 $i18n_fields = array()
 
 $additional_fields = array()
 
 $relations = array()
 
 $has_many = array()
 
 $has_one = array()
 
 $belongs_to = array()
 
 $has_and_belongs_to_many = array()
 
 $registered_callbacks
 
 $known_slots = array()
 
 $notification_map = array()
 
 $additional_data = array()
 
 $getter_setter_map = array()
 
- Static Protected Attributes inherited from ModuleManagementModelTreeItem
static $object_filter = array()
 
- Static Protected Attributes inherited from ModuleManagementModel
static $filter_params = array()
 
static $perm_object = null
 
- Static Protected Attributes inherited from SimpleORMap
static $config = array()
 
static $reserved_slots = array('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

◆ configure()

static configure (   $config = array())
staticprotected

set configuration data from subclass

Parameters
array$configconfiguration data
Returns
void

Reimplemented from SimpleORMap.

◆ copy()

copy ( )

Makes a deep copy of this version.

Returns
bool|object Returns the new version or false on failure;
Here is the call graph for this function:

◆ findByFachAbschluss()

static findByFachAbschluss (   $fach_id,
  $abschluss_id,
  $version_id = null 
)
static

Returns Versions by given Fach and Abschluss ordered by cp and start semester.

Parameters
string$fach_idId of Fach.
string$abschluss_idId of Abschluss.
string$version_idOnly this version.
Returns
array Array of versions.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ findByFilter()

static findByFilter (   $filter)
static

Returns an array with ids of all Studiengangteil-Versionen found by the given filter.

See also
ModuleManagementModel::getFilterSql()
Parameters
array$filterKey-value pairs of filed names and values to filter the result set.
Returns
type
Here is the call graph for this function:

◆ findByStgteil()

static findByStgteil (   $stgteil_id,
  $sortby = 'start',
  $order = 'ASC',
  $filter = null 
)
static

Retrieves all Studiengangteil-Versionen of the given Studiengangteil. sorted and filtered by given parameters and enriched with some additional fields.

Parameters
string$stgteil_idThe id of a Studiengangteil.
string$sortbyField names to order by.
string$orderASC or DESC direction of order.
array$filterKey-value pairs of filed names and values to filter the result set.
Returns
SimpleORMapCollection A collection of Studiengangteil-Versionen.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ findByStgteilAbschnitt()

static findByStgteilAbschnitt (   $abschnitt_id)
static

Returns Version by Studiengangteilabschnitt.

Parameters
string$abschnitt_id
Returns
null|object
Here is the caller graph for this function:

◆ getAllEnriched()

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

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

Parameters
string$sortbyField names 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 Studiengangteil-Versionen.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ getChildren()

getChildren ( )
See also
MvvTreeItem::getChildren()

Implements MvvTreeItem.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getClassDisplayName()

static getClassDisplayName (   $long = false)
static

◆ getCount()

static getCount (   $filter = null)
static

Returns the number of Studiengangteil-Versionen optional filtered by $filter.

Parameters
array$filterKey-value pairs of filed names and values to filter the result set.
Returns
int The number of Studiengangteil-Versionen.

Reimplemented from ModuleManagementModel.

Here is the call 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:

◆ getDisplaySemesterValidity()

getDisplaySemesterValidity ( )

Returns a string representation of this version's validity by semesters.

Returns
string The string with the validity by semesters.
Here is the call graph for this function:

◆ getEnriched()

static getEnriched (   $version_id)
static

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

Parameters
string$version_idThe id of the Studiengangteil-Version.
Returns
object The Studiengangteil-Version with additional data or a new Studiengangteil-Version.

Reimplemented from ModuleManagementModel.

Here is the call graph for this function:

◆ getParents()

getParents (   $mode = null)
See also
MvvTreeItem::getParents()

Implements MvvTreeItem.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getResponsibleInstitutes()

getResponsibleInstitutes ( )

Returns the responsible institutes. Inherits the responsible institutes from Studiengangteil

Returns
array Array of institute objects.

Reimplemented from ModuleManagementModel.

Here is the call graph for this function:

◆ getStatus()

getStatus ( )
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()

Implements MvvTreeItem.

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:

◆ validate()

validate ( )

Validates the values before store. Throws an InvalidValuesException normally catched by form validation.

Exceptions
InvalidValuesException

Reimplemented from ModuleManagementModel.

Here is the call graph for this function:

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