MvvDokument Class Reference

Inheritance diagram for MvvDokument:

Collaboration diagram for MvvDokument:

Public Member Functions
	__construct ($id=null)
	getRelations ()
	getCountRelations ()
	getRelationByObject ($object_id, $object_type)
	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 ()

Static Public Member Functions
static	getClassDisplayName ($long=false)
static	findByObject (SimpleORMap $object)
static	findByObjectType ($object_type)
static	getAllEnriched ($sortby='chdate', $order='DESC', $row_count=null, $offset=null, $filter=null)
static	getCount ($filter=null)
static	findBySearchTerm ($term, $filter=null)
static	getAllRelations ($dokument_ids=[])
static	updateDocuments ($object, $dokument_ids, $annotations=[])
static	unassignAllDocuments ($object)
static	getQuickSearch ($exclude=[])
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 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 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 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

$id

primary key of table

Reimplemented from SimpleORMap.

Member Function Documentation

configure()

static configure (   $config = [] )

staticprotected

set configuration data from subclass

Parameters

array

$config

configuration data

Returns

void

Reimplemented from SimpleORMap.

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.

findByObjectType()

static findByObjectType (   $object_type )

static

Finds all documents related to objects of given type.

Parameters

string

$object_type

The type of the objects.

Returns

array Array of documents.

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.

Reimplemented from ModuleManagementModel.

Here is the call graph for this function:

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.

Here is the call graph for this function:

Here is the caller graph for this function:

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.

Here is the call graph for this function:

getClassDisplayName()

static getClassDisplayName (   $long = false )

static

See also

ModuleManagementModel::getClassDisplayName

Reimplemented from ModuleManagementModel.

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.

Reimplemented from ModuleManagementModel.

Here is the caller graph for this function:

getCountRelations()

getCountRelations

(

)

Returns the number of assignments to other MVV objects.

Returns

int Number of assignments.

Here is the call graph for this function:

getQuickSearch()

static getQuickSearch (   $exclude = [] )

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.

Here is the call graph for this function:

Here is the caller graph for this function:

getRelationByObject()

getRelationByObject	(		$object_id,
			$object_type
	)

Returns all assignemnt to objects for this document.

Parameters

string	$object_id	The id of the object.
string	$object_type	The type (class name by get_class()) of the object.

Returns

array Array of document assignments.

Here is the call graph for this function:

getRelations()

getRelations

(

)

Returns all relations of this document grouped by object types.

Returns

Array Relations ordered by object types

Here is the call graph for this function:

unassignAllDocuments()

static unassignAllDocuments (   $object )

static

Removes all assignments of this Dokument.

Here is the call graph for this function:

updateDocuments()

static updateDocuments (   $object,   $dokument_ids,   $annotations = []  )

static

Updates the assignment of documents to the given object.

Parameters

Object	$object	Assigns the documents to this object.
array	$dokument_ids	Array of document object ids.
array	$annotations	Array of annotations to the assignment.

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

• lib/models/MvvDokument.php