Collaboration diagram for ilDclCache:

Static Public Member Functions
static	setCloneOf (int $old, int $new, string $type)

static	getCloneOf (int $id, string $type)

static	getTableCache (int $table_id=null)

static	getFieldCache (int $field_id=0)

static	getRecordCache (?int $record_id)

static	getRecordFieldCache (object $record, object $field)

static	getFieldRepresentation (ilDclBaseFieldModel $field)

static	getRecordRepresentation (ilDclBaseRecordFieldModel $record_field)
	Returns a record representation. More...

static	getFieldProperties (string $field_id)
	Cache Field properties. More...

static	preloadFieldProperties (array $fields)
	Preloads field properties. More...

static	getDatatype (int $datatyp_id)
	Get cached datatypes. More...

static	buildFieldFromRecord (array $rec)

static	resetCache ()
	Resets all the cache fields. More...

Data Fields
const	TYPE_DATACOLLECTION = 'dcl'

const	TYPE_TABLE = 'table'

const	TYPE_FIELD = 'field'

const	TYPE_RECORD = 'record'

const	TYPE_TABLEVIEW = 'tableview'

Static Protected Member Functions
static	initCloneMapping ()

Static Protected Attributes
static array	$tables_cache = []

static array	$fields_cache = []

static array	$records_cache = []

static array	$record_field_cache = []

static array	$field_representation_cache = []

static array	$record_representation_cache = []

static array	$field_properties_cache = []

static array	$datatype_cache = []

static array	$clone_mapping = []

Detailed Description

Definition at line 21 of file class.ilDclCache.php.

Member Function Documentation

◆ buildFieldFromRecord()

static ilDclCache::buildFieldFromRecord ( array $rec )

static

Definition at line 272 of file class.ilDclCache.php.

References ilDclFieldFactory\getFieldModelInstanceByClass().

Referenced by ilDclTable\loadCustomFields().

                                                            : ilDclBaseFieldModel
     {
         $fields_cache = &self::$fields_cache;
         if (isset($fields_cache[$rec["id"]])) {
             return $fields_cache[$rec["id"]];
         }
         $field = ilDclFieldFactory::getFieldModelInstanceByClass(new ilDclBaseFieldModel($rec['id']));
         $field->setId($rec["id"]);
         $field->setTableId($rec["table_id"]);
         if (null !== $rec["title"]) {
             $field->setTitle($rec["title"]);
         }
         if (null !== $rec["description"]) {
             $field->setDescription($rec["description"]);
         }
         $field->setDatatypeId($rec["datatype_id"]);
         $field->setUnique((bool) $rec["is_unique"]);
         $fields_cache[$rec["id"]] = $field;
 
         return $field;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCloneOf()

static ilDclCache::getCloneOf	(	int	$id,
		string	$type
	)

static

Definition at line 94 of file class.ilDclCache.php.

References $id, and ILIAS\LTI\ToolProvider\$key.

Referenced by ilDclReferenceRecordFieldModel\afterClone(), ilDclMobRecordFieldModel\afterClone(), ilDclFileRecordFieldModel\afterClone(), ilDclReferenceRecordFieldModel\getCloneRecordId(), ilDclReferenceFieldModel\getFieldRef(), and ilDclCopyFieldModel\getValidFieldProperties().

                                                             : ?object
     {
         $type_cache = self::$clone_mapping[$type];
         $clone_id = null;
 
         if (!is_array($type_cache)) {
             return null;
         }
 
         if (isset($type_cache[$id])) {
             $clone_id = $type_cache[$id];
         } else {
             foreach ($type_cache as $key => $mapping) {
                 if ($mapping == $id) {
                     $clone_id = $key;
                 }
             }
         }
 
         if (!$clone_id) {
             return null;
         }
 
         switch ($type) {
             case self::TYPE_DATACOLLECTION:
                 return new ilObjDataCollection($clone_id);
             case self::TYPE_FIELD:
                 return self::getFieldCache($clone_id);
             case self::TYPE_TABLE:
                 return self::getTableCache($clone_id);
             case self::TYPE_RECORD:
                 return self::getRecordCache($clone_id);
         }
 
         return null;
     }

Here is the caller graph for this function:

◆ getDatatype()

static ilDclCache::getDatatype ( int $datatyp_id )

static

Get cached datatypes.

Exceptions

ilDclException

Definition at line 255 of file class.ilDclCache.php.

References ilDclDatatype\getAllDatatype(), and ilDclFieldTypePlugin\ID_BUFFER.

Referenced by ilDclDefaultValueFactory\create(), ilDclTableViewBaseDefaultValue\findAll(), and ilDclBaseFieldModel\loadDatatype().

                                                        : ilDclDatatype
     {
         if (self::$datatype_cache == null) {
             self::$datatype_cache = ilDclDatatype::getAllDatatype();
         }
 
         if (!isset(self::$datatype_cache[$datatyp_id])) {
             $unknown = new ilDclDatatype();
             if ($datatyp_id > ilDclFieldTypePlugin::ID_BUFFER) {
                 $unknown->setTitle('unknown_plugin');
             }
             return $unknown;
         }
 
         return self::$datatype_cache[$datatyp_id];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFieldCache()

static ilDclCache::getFieldCache ( int $field_id = 0 )

static

Definition at line 144 of file class.ilDclCache.php.

References ilDclFieldFactory\getFieldModelInstance().

Referenced by ilDclFieldEditGUI\__construct(), ilDclReferenceFieldRepresentation\addFilterInputFieldToTable(), ilDclBaseFieldModel\cloneStructure(), ilDclTable\deleteField(), ilDclFieldListGUI\deleteFields(), ilDataCollectionDataSet\getDependencies(), ilDclTableViewFieldSetting\getFieldObject(), ilDclReferenceFieldModel\getFieldRef(), ilDclReferenceFieldRepresentation\getInputField(), ilDclCopyFieldRepresentation\getInputField(), ilDclReferenceFieldModel\getRecordQuerySortObject(), ilDclReferenceRecordFieldModel\getReferenceFromValue(), and ilDataCollectionDataSet\getXmlNamespace().

                                                            : ilDclBaseFieldModel
     {
         $fields_cache = &self::$fields_cache;
         if (!isset($fields_cache[$field_id])) {
             $fields_cache[$field_id] = ilDclFieldFactory::getFieldModelInstance($field_id);
         }
 
         return $fields_cache[$field_id];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFieldProperties()

static ilDclCache::getFieldProperties ( string $field_id )

static

Cache Field properties.

Returns: ilDclFieldProperty[]

Definition at line 211 of file class.ilDclCache.php.

References ActiveRecord\where().

Referenced by ilDclBaseFieldModel\loadProperties().

                                                                : array
     {
         if (!isset(self::$field_properties_cache[$field_id])) {
             self::$field_properties_cache[$field_id] = [];
             $result = ilDclFieldProperty::where(['field_id' => $field_id])->get();
             foreach ($result as $prop) {
                 self::$field_properties_cache[$field_id][$prop->getName()] = $prop;
             }
         }
 
         return self::$field_properties_cache[$field_id];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFieldRepresentation()

static ilDclCache::getFieldRepresentation ( ilDclBaseFieldModel $field )

static

Exceptions

ilDclException

Definition at line 183 of file class.ilDclCache.php.

References ilDclFieldFactory\getFieldRepresentationInstance(), and ilDclBaseFieldModel\getId().

Referenced by ilDclCreateViewTableGUI\getHTML(), ilDclRecordListTableGUI\initFilter(), and ilDclRecordEditGUI\initForm().

                                                                              : ilDclBaseFieldRepresentation
     {
         if (!isset(self::$field_representation_cache[$field->getId()])) {
             self::$field_representation_cache[$field->getId()] = ilDclFieldFactory::getFieldRepresentationInstance($field);
         }
 
         return self::$field_representation_cache[$field->getId()];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRecordCache()

static ilDclCache::getRecordCache ( ?int $record_id )

static

Definition at line 154 of file class.ilDclCache.php.

References ilDclFieldFactory\getRecordModelInstance().

Referenced by ilDclDetailedViewGUI\__construct(), ilDclBaseRecordModel\cloneStructure(), ilDclRecordEditGUI\confirmDelete(), ilDclRecordEditGUI\delete(), ilDclDetailedViewGUI\doExtReplace(), ilDclReferenceRecordFieldModel\getExportValue(), ilDclReferenceRecordRepresentation\getHTML(), ilDclCopyFieldRepresentation\getInputField(), ilDclTable\getPartialRecords(), ilDclRecordEditGUI\getRecord(), ilDclRecordEditGUI\getRecordData(), ilDataCollectionDataSet\getXmlNamespace(), ilDclTable\loadRecords(), ilDclFileFieldRepresentation\requiredWorkaroundForInputField(), ilDclRecordEditGUI\save(), ilDclRecordEditGUI\sendFailure(), ilDclRecordListGUI\sendFile(), and ilDclRecordEditGUI\setFormValues().

                                                           : ilDclBaseRecordModel
     {
         $records_cache = &self::$records_cache;
         if (!$record_id || !isset($records_cache[$record_id])) {
             $records_cache[$record_id] = ilDclFieldFactory::getRecordModelInstance($record_id);
         }
 
         return $records_cache[$record_id];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRecordFieldCache()

static ilDclCache::getRecordFieldCache	(	object	$record,
		object	$field
	)

static

Definition at line 164 of file class.ilDclCache.php.

References ilDclBaseRecordFieldModel\getId(), and ilDclFieldFactory\getRecordFieldInstance().

Referenced by ilDclReferenceRecordFieldModel\afterClone(), ilDclMobRecordFieldModel\afterClone(), ilDclFileRecordFieldModel\afterClone(), ilDclBaseFieldModel\afterClone(), ilDclFormulaRecordQueryObject\applyCustomSorting(), ilDclBaseRecordModel\cloneStructure(), ilDclRecordEditGUI\confirmDelete(), ilDclRecordListTableGUI\getStatus(), ilDclBaseRecordModel\loadRecordFields(), and ilDclRecordListGUI\sendFile().

      : ilDclBaseRecordFieldModel {
         $fid = $field->getId();
         $rid = $record->getId();
         if (!isset(self::$record_field_cache[$rid])) {
             self::$record_field_cache[$rid] = [];
             self::$record_field_cache[$rid][$fid] = ilDclFieldFactory::getRecordFieldInstance($field, $record);
         } elseif (!isset(self::$record_field_cache[$rid][$fid])) {
             self::$record_field_cache[$rid][$fid] = ilDclFieldFactory::getRecordFieldInstance($field, $record);
         }
 
         return self::$record_field_cache[$rid][$fid];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRecordRepresentation()

static ilDclCache::getRecordRepresentation ( ilDclBaseRecordFieldModel $record_field )

static

Returns a record representation.

Exceptions

ilDclException

Definition at line 196 of file class.ilDclCache.php.

References ilDclBaseRecordFieldModel\getId(), and ilDclFieldFactory\getRecordRepresentationInstance().

Referenced by ilDclRecordEditGUI\confirmDelete(), and ilDclRecordListGUI\sendFile().

      : ilDclBaseRecordRepresentation {
 
         if (!isset(self::$record_representation_cache[$record_field->getId()])) {
             self::$record_representation_cache[$record_field->getId()] = ilDclFieldFactory::getRecordRepresentationInstance($record_field);
         }
 
         return self::$record_representation_cache[$record_field->getId()];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTableCache()

static ilDclCache::getTableCache ( int $table_id = null )

static

Definition at line 131 of file class.ilDclCache.php.

Referenced by ilDclIliasReferenceRecordFieldModel\__construct(), ilDclRatingRecordFieldModel\__construct(), ilDclReferenceRecordFieldModel\__construct(), ilDclFieldListTableGUI\__construct(), ilDclFieldListGUI\__construct(), ilDclFieldEditGUI\__construct(), ilDclTableEditGUI\__construct(), ilDclTableViewGUI\__construct(), ilDclRecordListGUI\__construct(), ilDclReferenceFieldRepresentation\addFilterInputFieldToTable(), ilDclStandardField\allowFilterInListView(), ilDclFormulaFieldRepresentation\buildFieldCreationInput(), ilDclBaseFieldModel\checkValidity(), ilDclTableListGUI\confirmDeleteTables(), ilDclTableView\createDefaultSettings(), ilDclFieldListGUI\deleteFields(), ilDclTableListGUI\deleteTables(), ilObjDataCollection\doCreate(), ilDclBaseRecordModel\doDelete(), ilDclTableEditGUI\edit(), ilDclDetailedViewDefinition\getAvailablePlaceholders(), ILIAS\Modules\DataCollection\Fields\Formula\FormulaParser\Substitution\FieldSubstitution\getFieldFromPlaceholder(), ilDclReferenceFieldRepresentation\getInputField(), ilDclCopyFieldRepresentation\getInputField(), ilDclRecordEditGUI\getRecord(), ilDclReferenceRecordFieldModel\getReferenceFromValue(), ilDclTableView\getTable(), ilObjDataCollection\getTableById(), ilObjDataCollectionGUI\getTableViewId(), ilObjDataCollectionAccess\hasAccessToField(), ilObjDataCollectionAccess\hasAccessToFields(), ilObjDataCollectionAccess\hasAccessToTable(), ilObjDataCollectionAccess\hasPermissionToAddRecord(), ilDclBaseRecordModel\loadTable(), ilDclDetailedViewGUI\renderRecord(), ilDclFieldListGUI\save(), ilDclTableListGUI\save(), and ilDclTableEditGUI\save().

                                                               : ilDclTable
     {
         if (is_null($table_id) === true || $table_id === 0) {
             return new ilDclTable();
         }
         $tables_cache = &self::$tables_cache;
         if (!isset($tables_cache[$table_id])) {
             $tables_cache[$table_id] = new ilDclTable($table_id);
         }
 
         return $tables_cache[$table_id];
     }

Here is the caller graph for this function:

◆ initCloneMapping()

static ilDclCache::initCloneMapping ( )

staticprotected

Definition at line 83 of file class.ilDclCache.php.

                                                 : void
     {
         self::$clone_mapping = [
             self::TYPE_DATACOLLECTION => [],
             self::TYPE_TABLE => [],
             self::TYPE_FIELD => [],
             self::TYPE_RECORD => [],
             self::TYPE_TABLEVIEW => [],
         ];
     }

◆ preloadFieldProperties()

static ilDclCache::preloadFieldProperties ( array $fields )

static

Preloads field properties.

Parameters

ilDclBaseFieldModel[] $fields

Definition at line 228 of file class.ilDclCache.php.

References ActiveRecord\where().

Referenced by ilDclTable\loadCustomFields().

                                                                 : void
     {
         foreach ($fields as $field_key => $field) {
             if (isset(self::$field_properties_cache[$field->getId()])) {
                 unset($fields[$field_key]);
             }
         }
 
         if (count($fields) > 0) {
             $field_ids = [];
             foreach ($fields as $field) {
                 $field_ids[] = $field->getId();
             }
             $result = ilDclFieldProperty::where(['field_id' => $field_ids], 'IN')->get();
             foreach ($result as $prop) {
                 if (!isset(self::$field_properties_cache[$prop->getFieldId()])) {
                     self::$field_properties_cache[$prop->getFieldId()] = [];
                 }
                 self::$field_properties_cache[$prop->getFieldId()][$prop->getName()] = $prop;
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resetCache()

static ilDclCache::resetCache ( )

static

Resets all the cache fields.

Definition at line 297 of file class.ilDclCache.php.

Referenced by ilDclContentExporter\export().

                                        : void
     {
         self::$fields_cache = [];
         self::$record_field_cache = [];
         self::$records_cache = [];
     }

Here is the caller graph for this function:

◆ setCloneOf()

static ilDclCache::setCloneOf	(	int	$old,
		int	$new,
		string	$type
	)

static

Definition at line 75 of file class.ilDclCache.php.

Referenced by ilObjDataCollection\cloneStructure(), ilDclTableView\cloneStructure(), ilDclBaseFieldModel\cloneStructure(), ilDclBaseRecordModel\cloneStructure(), and ilDclTable\cloneStructure().

                                                                        : void
     {
         if (!self::$clone_mapping) {
             self::initCloneMapping();
         }
         self::$clone_mapping[$type][$old] = $new;
     }

Here is the caller graph for this function:

Field Documentation

◆ $clone_mapping

array ilDclCache::$clone_mapping = []

staticprotected

Definition at line 73 of file class.ilDclCache.php.

◆ $datatype_cache

array ilDclCache::$datatype_cache = []

staticprotected

Definition at line 60 of file class.ilDclCache.php.

◆ $field_properties_cache

array ilDclCache::$field_properties_cache = []

staticprotected

Definition at line 56 of file class.ilDclCache.php.

◆ $field_representation_cache

array ilDclCache::$field_representation_cache = []

staticprotected

Definition at line 48 of file class.ilDclCache.php.

◆ $fields_cache

array ilDclCache::$fields_cache = []

staticprotected

Definition at line 35 of file class.ilDclCache.php.

◆ $record_field_cache

array ilDclCache::$record_field_cache = []

staticprotected

Definition at line 44 of file class.ilDclCache.php.

◆ $record_representation_cache

array ilDclCache::$record_representation_cache = []

staticprotected

Definition at line 52 of file class.ilDclCache.php.

◆ $records_cache

array ilDclCache::$records_cache = []

staticprotected

Definition at line 39 of file class.ilDclCache.php.

◆ $tables_cache

array ilDclCache::$tables_cache = []

staticprotected

Definition at line 31 of file class.ilDclCache.php.

◆ TYPE_DATACOLLECTION

const ilDclCache::TYPE_DATACOLLECTION = 'dcl'

Definition at line 23 of file class.ilDclCache.php.

Referenced by ilObjDataCollection\cloneStructure().

◆ TYPE_FIELD

const ilDclCache::TYPE_FIELD = 'field'

Definition at line 25 of file class.ilDclCache.php.

Referenced by ilDclReferenceRecordFieldModel\afterClone(), ilDclMobRecordFieldModel\afterClone(), ilDclFileRecordFieldModel\afterClone(), ilDclBaseFieldModel\cloneStructure(), ilDclReferenceFieldModel\getFieldRef(), and ilDclCopyFieldModel\getValidFieldProperties().

◆ TYPE_RECORD

const ilDclCache::TYPE_RECORD = 'record'

Definition at line 26 of file class.ilDclCache.php.

Referenced by ilDclReferenceRecordFieldModel\afterClone(), ilDclMobRecordFieldModel\afterClone(), ilDclFileRecordFieldModel\afterClone(), ilDclBaseRecordModel\cloneStructure(), and ilDclReferenceRecordFieldModel\getCloneRecordId().

◆ TYPE_TABLE

const ilDclCache::TYPE_TABLE = 'table'

Definition at line 24 of file class.ilDclCache.php.

Referenced by ilDclTable\cloneStructure().

◆ TYPE_TABLEVIEW

const ilDclCache::TYPE_TABLEVIEW = 'tableview'

Definition at line 27 of file class.ilDclCache.php.

Referenced by ilDclTableView\cloneStructure().

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

Modules/DataCollection/classes/Helpers/class.ilDclCache.php

Static Public Member Functions

Data Fields

Static Protected Member Functions

Static Protected Attributes

Detailed Description

Member Function Documentation

◆ buildFieldFromRecord()

◆ getCloneOf()

◆ getDatatype()

◆ getFieldCache()

◆ getFieldProperties()

◆ getFieldRepresentation()

◆ getRecordCache()

◆ getRecordFieldCache()

◆ getRecordRepresentation()

◆ getTableCache()

◆ initCloneMapping()

◆ preloadFieldProperties()

◆ resetCache()

◆ setCloneOf()

Field Documentation

◆ $clone_mapping

◆ $datatype_cache

◆ $field_properties_cache

◆ $field_representation_cache

◆ $fields_cache

◆ $record_field_cache

◆ $record_representation_cache

◆ $records_cache

◆ $tables_cache

◆ TYPE_DATACOLLECTION

◆ TYPE_FIELD

◆ TYPE_RECORD

◆ TYPE_TABLE

◆ TYPE_TABLEVIEW