ILIAS  release_5-2 Revision v5.2.25-18-g3f80b828510
ilDclCache Class Reference

Class ilDclCache. More...

+ Collaboration diagram for ilDclCache:

Static Public Member Functions

static setCloneOf ($old, $new, $type)
 
static getCloneOf ($id, $type)
 
static getTableCache ($table_id=0)
 
static getFieldCache ($field_id=0)
 
static getRecordCache ($record_id=0)
 
static getRecordFieldCache ($record, $field)
 
static getFieldRepresentation (ilDclBaseFieldModel $field)
 
static getRecordRepresentation (ilDclBaseRecordFieldModel $record_field)
 Returns a record representation. More...
 
static getFieldProperties ($field_id)
 Cache Field properties. More...
 
static preloadFieldProperties (array $fields)
 Preloads field properties. More...
 
static getDatatype ($datatyp_id)
 Get cached datatypes. More...
 
static buildFieldFromRecord ($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 $tables_cache
 
static $fields_cache
 
static $records_cache
 
static $record_field_cache
 
static $field_representation_cache
 
static $record_representation_cache
 
static $field_properties_cache
 
static $datatype_cache
 
static $clone_mapping
 

Detailed Description

Member Function Documentation

◆ buildFieldFromRecord()

static ilDclCache::buildFieldFromRecord (   $rec)
static
Parameters
$rec
Returns
ilDclBaseFieldModel

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

298 {
300 if (isset($fields_cache[$rec["id"]])) {
301 return $fields_cache[$rec["id"]];
302 }
304 $field->setId($rec["id"]);
305 $field->setTableId($rec["table_id"]);
306 $field->setTitle($rec["title"]);
307 $field->setDescription($rec["description"]);
308 $field->setDatatypeId($rec["datatype_id"]);
309 $field->setRequired($rec["required"]);
310 $field->setUnique($rec["is_unique"]);
311 $field->setLocked($rec["is_locked"]);
312 $fields_cache[$rec["id"]] = $field;
313
314 return $field;
315 }
Class ilDclBaseFieldModel.
static $fields_cache
static getFieldModelInstanceByClass(ilDclBaseFieldModel $field, $field_id=null)
Gets the correct instance of a fieldModel class Checks if a field is a plugin a replaces the fieldMod...

References $fields_cache, and ilDclFieldFactory\getFieldModelInstanceByClass().

+ Here is the call graph for this function:

◆ getCloneOf()

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

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

94 {
95 $type_cache = self::$clone_mapping[$type];
96 if (!is_array($type_cache)) {
97 return false;
98 }
99
100 if (isset($type_cache[$id])) {
101 $clone_id = $type_cache[$id];
102 } else {
103 foreach ($type_cache as $key => $mapping) {
104 if ($mapping == $id) {
105 $clone_id = $key;
106 }
107 }
108 }
109
110 if (!$clone_id) {
111 return false;
112 }
113
114
115 switch ($type) {
117 return new ilObjDataCollection($clone_id);
118 case self::TYPE_FIELD:
119 return self::getFieldCache($clone_id);
120 case self::TYPE_TABLE:
121 return self::getTableCache($clone_id);
123 return self::getRecordCache($clone_id);
124 }
125 }
static getTableCache($table_id=0)
static getRecordCache($record_id=0)
const TYPE_DATACOLLECTION
static getFieldCache($field_id=0)
Class ilObjDataCollection.

References getFieldCache(), getRecordCache(), getTableCache(), TYPE_DATACOLLECTION, TYPE_FIELD, TYPE_RECORD, and TYPE_TABLE.

Referenced by ilDclFileuploadRecordFieldModel\afterClone(), ilDclMobRecordFieldModel\afterClone(), and ilDclReferenceRecordFieldModel\afterClone().

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

◆ getDatatype()

static ilDclCache::getDatatype (   $datatyp_id)
static

Get cached datatypes.

Parameters
$datatyp_id
Returns
mixed
Exceptions
ilDclException

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

281 {
282 if(self::$datatype_cache == NULL) {
283 self::$datatype_cache = ilDclDatatype::getAllDatatype();
284 }
285
286 if(!isset(self::$datatype_cache[$datatyp_id])) {
287 return new ilDclDatatype();
288 }
289 return self::$datatype_cache[$datatyp_id];
290 }
Class ilDclDatatype.
static getAllDatatype()
Get all possible Datatypes.

References ilDclDatatype\getAllDatatype().

Referenced by ilDclBaseFieldModel\loadDatatype().

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

◆ getFieldCache()

◆ getFieldProperties()

static ilDclCache::getFieldProperties (   $field_id)
static

Cache Field properties.

Parameters
$field_id
Returns
ilDclFieldProperty

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

234 {
235 if(!isset(self::$field_properties_cache[$field_id])) {
236 self::$field_properties_cache[$field_id] = array();
237 $result = ilDclFieldProperty::where(array('field_id'=>$field_id))->get();
238 foreach($result as $prop) {
239 self::$field_properties_cache[$field_id][$prop->getName()] = $prop;
240 }
241 }
242 return self::$field_properties_cache[$field_id];
243 }
$result
static where($where, $operator=null)

References $result, and ActiveRecord\where().

Referenced by ilDclBaseFieldModel\loadProperties().

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

◆ getFieldRepresentation()

static ilDclCache::getFieldRepresentation ( ilDclBaseFieldModel  $field)
static
Parameters
ilDclBaseFieldModel$field
Returns
ilDclBaseFieldRepresentation
Exceptions
ilDclException

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

201 {
202 if(!isset(self::$field_representation_cache[$field->getId()])) {
203 self::$field_representation_cache[$field->getId()] = ilDclFieldFactory::getFieldRepresentationInstance($field);
204 }
205 return self::$field_representation_cache[$field->getId()];
206 }
static getFieldRepresentationInstance(ilDclBaseFieldModel $field)
Returns FieldRepresentation from BaseFieldModel.

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

Referenced by ilDclRecordListTableGUI\initFilter(), ilDclRecordListTableGUI\initFilterFromTableView(), ilDclRecordEditGUI\initForm(), and ilDclBaseRecordModel\passThroughFilter().

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

◆ getRecordCache()

static ilDclCache::getRecordCache (   $record_id = 0)
static

◆ getRecordFieldCache()

static ilDclCache::getRecordFieldCache (   $record,
  $field 
)
static
Parameters
$fieldilDclBaseFieldModel
$recordilDclBaseRecordModel
Returns
ilDclBaseRecordFieldModel

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

181 {
182 $fid = $field->getId();
183 $rid = $record->getId();
184 if (!isset(self::$record_field_cache[$rid])) {
185 self::$record_field_cache[$rid] = array();
186 self::$record_field_cache[$rid][$fid] = ilDclFieldFactory::getRecordFieldInstance($field, $record);
187 } elseif (!isset(self::$record_field_cache[$rid][$fid])) {
188 self::$record_field_cache[$rid][$fid] = ilDclFieldFactory::getRecordFieldInstance($field, $record);
189 }
190
191 return self::$record_field_cache[$rid][$fid];
192 }
static getRecordFieldInstance(ilDclBaseFieldModel $field, ilDclBaseRecordModel $record)
Creates a RecordField instance and loads the field and record representation.

References ilDclFieldFactory\getRecordFieldInstance().

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

+ 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.

Parameters
ilDclBaseRecordFieldModel$record_field
Returns
ilDclBaseRecordRepresentation
Exceptions
ilDclException

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

216 {
217 if($record_field == null) {
218 throw new ilDclException("Cannot get Representation of null object!");
219 }
220
221 if(!isset(self::$record_representation_cache[$record_field->getId()])) {
222 self::$record_representation_cache[$record_field->getId()] = ilDclFieldFactory::getRecordRepresentationInstance($record_field);
223 }
224 return self::$record_representation_cache[$record_field->getId()];
225 }
Class ilDclException.
static getRecordRepresentationInstance(ilDclBaseRecordFieldModel $record_field)
Get RecordRepresentation from RecordFieldModel.

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

Referenced by ilDclRecordEditGUI\confirmDelete().

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

◆ getTableCache()

static ilDclCache::getTableCache (   $table_id = 0)
static
Parameters
int$table_id
Returns
ilDclTable

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

132 {
133 if ($table_id == 0) {
134 return new ilDclTable();
135 }
137 if (!isset($tables_cache[$table_id])) {
138 $tables_cache[$table_id] = new ilDclTable($table_id);
139 }
140
141 return $tables_cache[$table_id];
142 }
static $tables_cache
Class ilDclBaseFieldModel.

References $tables_cache.

Referenced by ilDclIliasReferenceRecordFieldModel\__construct(), ilDclRatingRecordFieldModel\__construct(), ilDclReferenceRecordFieldModel\__construct(), ilDclFieldListTableGUI\__construct(), ilDclFieldEditGUI\__construct(), ilDclFieldListGUI\__construct(), ilDclTableEditGUI\__construct(), ilDclTableViewGUI\__construct(), ilDclRecordListGUI\__construct(), ilDclReferenceFieldRepresentation\addFilterInputFieldToTable(), ilDclStandardField\allowFilterInListView(), ilDclFormulaFieldRepresentation\buildFieldCreationInput(), ilDclBaseFieldModel\checkValidity(), ilDclDatetimeFieldModel\checkValidity(), ilDclFileuploadFieldModel\checkValidity(), ilDclTextFieldModel\checkValidity(), ilDclTextFieldModel\checkValidityOfURLField(), ilDclTableListGUI\confirmDeleteTables(), ilDclTableView\createDefaultSettings(), ilDclFieldListGUI\deleteFields(), ilDclTableListGUI\deleteTables(), ilObjDataCollection\doCreate(), ilDclBaseRecordModel\doDelete(), ilDclTableEditGUI\edit(), ilObjDataCollectionGUI\emptyInfo(), ilDclDetailedViewDefinition\getAvailablePlaceholders(), getCloneOf(), ilDclReferenceFieldRepresentation\getInputField(), ilDclRecordEditGUI\getRecord(), ilDclReferenceRecordFieldModel\getReferenceFromValue(), ilDclTableView\getTable(), ilObjDataCollection\getTableById(), ilObjDataCollection\getTables(), ilObjDataCollectionAccess\hasAccessToField(), ilObjDataCollectionAccess\hasAccessToFields(), ilObjDataCollectionAccess\hasAccessToTable(), ilObjDataCollectionAccess\hasPermissionToAddRecord(), ilDclBaseRecordModel\loadTable(), ilDclDetailedViewGUI\renderRecord(), ilObjDataCollection\reorderTables(), ilDclTableEditGUI\save(), ilDclFieldListGUI\save(), and ilDclTableListGUI\save().

+ Here is the caller graph for this function:

◆ initCloneMapping()

static ilDclCache::initCloneMapping ( )
staticprotected

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

84 {
85 self::$clone_mapping = array(
86 self::TYPE_DATACOLLECTION => array(),
87 self::TYPE_TABLE => array(),
88 self::TYPE_FIELD => array(),
89 self::TYPE_RECORD => array(),
90 self::TYPE_TABLEVIEW => array(),
91 );
92 }

Referenced by setCloneOf().

+ Here is the caller graph for this function:

◆ preloadFieldProperties()

static ilDclCache::preloadFieldProperties ( array  $fields)
static

Preloads field properties.

Parameters
ilDclBaseFieldModel[]$fields

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

250 {
251 foreach($fields as $field_key => $field) {
252 if(isset(self::$field_properties_cache[$field->getId()])) {
253 unset($fields[$field_key]);
254 }
255 }
256
257 if(count($fields) > 0) {
258 $field_ids = array();
259 foreach ($fields as $field) {
260 $field_ids[] = $field->getId();
261 }
262 $result = ilDclFieldProperty::where(array('field_id'=>$field_ids), 'IN')->get();
263 foreach($result as $prop) {
264 if(!isset(self::$field_properties_cache[$prop->getFieldId()])) {
265 self::$field_properties_cache[$prop->getFieldId()] = array();
266 }
267 self::$field_properties_cache[$prop->getFieldId()][$prop->getName()] = $prop;
268 }
269 }
270 }

References $result, and ActiveRecord\where().

+ Here is the call graph for this function:

◆ resetCache()

static ilDclCache::resetCache ( )
static

Resets all the cache fields.

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

321 {
322 self::$fields_cache = array();
323 self::$record_field_cache = array();
324 self::$records_cache = array();
325 }

Referenced by ilDclContentExporter\export().

+ Here is the caller graph for this function:

◆ setCloneOf()

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

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

77 {
78 if (!self::$clone_mapping) {
80 }
81 self::$clone_mapping[$type][$old] = $new;
82 }
static initCloneMapping()
$old

References $new, $old, and initCloneMapping().

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

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

Field Documentation

◆ $clone_mapping

ilDclCache::$clone_mapping
staticprotected

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

◆ $datatype_cache

ilDclCache::$datatype_cache
staticprotected

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

◆ $field_properties_cache

ilDclCache::$field_properties_cache
staticprotected

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

◆ $field_representation_cache

ilDclCache::$field_representation_cache
staticprotected

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

◆ $fields_cache

ilDclCache::$fields_cache
staticprotected

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

Referenced by buildFieldFromRecord(), and getFieldCache().

◆ $record_field_cache

ilDclCache::$record_field_cache
staticprotected

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

◆ $record_representation_cache

ilDclCache::$record_representation_cache
staticprotected

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

◆ $records_cache

ilDclCache::$records_cache
staticprotected

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

Referenced by getRecordCache().

◆ $tables_cache

ilDclCache::$tables_cache
staticprotected

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

Referenced by getTableCache().

◆ TYPE_DATACOLLECTION

const ilDclCache::TYPE_DATACOLLECTION = 'dcl'

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

Referenced by ilObjDataCollection\cloneStructure(), and getCloneOf().

◆ TYPE_FIELD

◆ TYPE_RECORD

◆ TYPE_TABLE

const ilDclCache::TYPE_TABLE = 'table'

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

Referenced by ilDclTable\cloneStructure(), and getCloneOf().

◆ TYPE_TABLEVIEW

const ilDclCache::TYPE_TABLEVIEW = 'tableview'

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

Referenced by ilDclTableView\cloneStructure().


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