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

Public Member Functions

 getDisplayName ($options=null)
 
 getRangeType ()
 
 countRelations ()
 
 getPositionInRange ($range_id)
 
 getRangesArray ()
 
 getFilenames ()
 
 getFiletypes ()
 
 getRelations ()
 
 addToRange ($range_id, $range_type)
 
 removeFromRange ($range_id)
 
 validate ()
 
- 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 ModuleManagementInterface
 __construct ($id=null)
 

Static Public Member Functions

static findByObject (SimpleORMap $object)
 
static findByRange_id ($range_id)
 
static getAllEnriched ($sortby= 'chdate', $order= 'DESC', $row_count=null, $offset=null, $filter=null)
 
static getAllRelations ($dokument_ids=[])
 
static findBySearchTerm ($term, $filter=null)
 
static getCount ($filter=null)
 
static getQuickSearch ($exclude=array())
 
static getMaxSortingPos ($range_id)
 
static getAllAssignedInstitutes ($sortby= 'name', $order= 'ASC', $filter=null, $row_count=null, $offset=null)
 
static getIdsFiltered ($filter, $refresh=false)
 
- 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 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 = '_'
 
- 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 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
 

Member Function Documentation

addToRange (   $range_id,
  $range_type 
)

Adds this mvvfile to given range.

Parameters
sting$range_idId of the mvv object.
static configure (   $config = [])
staticprotected
Parameters
array$config
countRelations ( )

Returns the number of assignments to other MVV objects.

Returns
int Number of assignments.
static findByObject ( SimpleORMap  $object)
static

Finds all documents related to the given object.

Parameters
string$objectA MVV object
Returns
array Array of documents.
static findByRange_id (   $range_id)
static
static findBySearchTerm (   $term,
  $filter = null 
)
static

Find Documents by given search term. Used as search function in list view.

Parameters
type$termThe search term.
type$filterOptional filter parameters.
Returns
array An array of Dokument ids.
static getAllAssignedInstitutes (   $sortby = 'name',
  $order = 'ASC',
  $filter = null,
  $row_count = null,
  $offset = null 
)
static

Returns all institutes assigned to files. Sorted and filtered by optional parameters.

Parameters
string$sortbyDB field to sort by.
string$orderASC or DESC
array$filterArray of filter.
Returns
array Array of found Fachbereiche.
static getAllEnriched (   $sortby = 'chdate',
  $order = 'DESC',
  $row_count = null,
  $offset = null,
  $filter = null 
)
static

Returns all or a specified (by row count and offset) number of documents 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
object A SimpleORMapCollection of Dokument objects.
static getAllRelations (   $dokument_ids = [])
static

Returns all relations of the documents specified by the given ids. The returned array is ordered by the types of the referenced objects.

Parameters
array$dokument_idsIds of the documents.
Returns
array References ordered by object types.
static getCount (   $filter = null)
static

Returns the number of Documents comply with the given filter parameters.

Parameters
array$filterArray of filter parameters
See Also
ModuleManagementModel::getFilterSql()
Returns
int The number of Documents.
getDisplayName (   $options = null)

Returns the name of the object to display in a specific context..

Returns
string The name for
getFilenames ( )

Returns the filenames of related filerefs.

Returns
string available filenames.
getFiletypes ( )

Returns the filetypes of related filerefs.

Returns
string available filetypes.
static getIdsFiltered (   $filter,
  $refresh = false 
)
static

Returns range_ids (ids of Studiengang/Abschluss-Kategorie) of assigned files.

array $ids The range_ids of assigned files after filtration.

Parameters
array$filterAn array with keys (table_name.column_name) and values (skalar or array) used in where clause.
boolean$refreshRefresh ids if true.
Returns
array An array with range_ids of assigned files.
static getMaxSortingPos (   $range_id)
static

Returns the highest current sorting position.

Parameters
sting$range_idId of the mvv object.
Returns
int Number of the highest current sorting position.
getPositionInRange (   $range_id)

Returns the position in given range.

Returns
int position.
static getQuickSearch (   $exclude = array())
static

Returns a ready to use quick search widget.

Parameters
array$excludeIds of documents excluded from search.
Returns
array Array with quick search id and quick search html.
getRangesArray ( )

Returns the ids of related ranges.

Returns
array Ids of related ranges.
getRangeType ( )

Returns the name of the rangetype this mvvfile is bound to.

Returns
string type of range
getRelations ( )

Returns all relations of this document grouped by object types.

Returns
Array Relations ordered by object types
removeFromRange (   $range_id)

Removes this mvvfile from given range.

Parameters
sting$range_idId of the mvv object.
validate ( )

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