MvvFile Class Reference

Inheritance diagram for MvvFile:

Public Member Functions
	getDisplayName ()
	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 ()
	getAvailableTranslations (string $original_language)
	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 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, $file_ids=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	setContentLanguage ($language)
static	getLanguage ()
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	setMariadbDefaultColumnFix (bool $state=true)

Protected Member Functions
	logChanges ($action=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)

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	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 = '_'
Static Public Attributes inherited from SimpleORMap
static	$schemes = null
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 = []
string	$i18n_class = I18NString::class
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
static	$mariadb_column_default_fix = false

Member Function Documentation

addToRange()

addToRange	(		$range_id,
			$range_type
	)

Adds this mvvfile to given range.

Parameters

string

$range_id

Id of the mvv object.

configure()

static configure (   $config = [] )

staticprotected

Parameters

array

$config

countRelations()

countRelations

(

)

Returns the number of assignments to other MVV objects.

Returns

int Number of assignments.

findByObject()

static findByObject ( SimpleORMap  $object )

static

Finds all documents related to the given object.

Parameters

string

$object

A MVV object

Returns

array Array of documents.

findByRange_id()

static findByRange_id (   $range_id )

static

findBySearchTerm()

static findBySearchTerm (   $term,   $filter = null  )

static

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

Parameters

type	$term	The search term.
type	$filter	Optional filter parameters.

Returns

array An array of Dokument ids.

getAllAssignedInstitutes()

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	$sortby	DB field to sort by.
string	$order	ASC or DESC
array	$filter	Array of filter.

Returns

array Array of found Fachbereiche.

getAllEnriched()

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	$sortby	Field name to order by.
string	$order	ASC or DESC direction of order.
array	$filter	Key-value pairs of filed names and values to filter the result set.
int	$row_count	The max number of objects to return.
int	$offset	The first object to return in a result set.

Returns

object A SimpleORMapCollection of Dokument objects.

getAllRelations()

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_ids

Ids of the documents.

Returns

array References ordered by object types.

getCount()

static getCount (   $filter = null )

static

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

Parameters

array

$filter

Array of filter parameters

See also

ModuleManagementModel::getFilterSql()

Returns

int The number of Documents.

getDisplayName()

getDisplayName

(

)

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

Returns

string The name.

getFilenames()

getFilenames

(

)

Returns the filenames of related filerefs.

Returns

string available filenames.

getFiletypes()

getFiletypes

(

)

Returns the filetypes of related filerefs.

Returns

string available filetypes.

getIdsFiltered()

static getIdsFiltered (   $filter,   $file_ids = 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	$filter	An array with keys (table_name.column_name) and values (skalar or array) used in where clause.
boolean	$file_ids	Return the file ids instead of the range ids.

Returns

array An array with range_ids of assigned files.

getMaxSortingPos()

static getMaxSortingPos (   $range_id )

static

Returns the highest current sorting position.

Parameters

sting

$range_id

Id of the mvv object.

Returns

int Number of the highest current sorting position.

getPositionInRange()

getPositionInRange

(

$range_id

)

Returns the position in given range.

Returns

int position.

getQuickSearch()

static getQuickSearch (   $exclude = array() )

static

Returns a ready to use quick search widget.

Parameters

array

$exclude

Ids of documents excluded from search.

Returns

array Array with quick search id and quick search html.

getRangesArray()

getRangesArray

(

)

Returns the ids of related ranges.

Returns

array Ids of related ranges.

getRangeType()

getRangeType

(

)

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

Returns

string type of range

getRelations()

getRelations

(

)

Returns all relations of this document grouped by object types.

Returns

Array Relations ordered by object types

logChanges()

logChanges (   $action = null )

protected

removeFromRange()

removeFromRange

(

$range_id

)

Removes this mvvfile from given range.

Parameters

sting

$range_id

Id of the mvv object.

validate()

validate

(

)

---

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

• lib/models/MvvFile.php