ilDclFieldFactory Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilDclFieldFactory:

Static Public Member Functions
static	getRecordFieldInstance (object $field, object $record)
	Creates a RecordField instance and loads the field and record representation. More...
static	getFieldClass (string $datatype, string $class_pattern)
	Concatenates Classname from datatype and pattern. More...
static	getFieldClassFile (string $datatype, string $class_pattern)
static	getFieldRepresentationInstance (ilDclBaseFieldModel $field)
static	getRecordRepresentationInstance (ilDclBaseRecordFieldModel $record_field)
	Get RecordRepresentation from RecordFieldModel. More...
static	getFieldModelInstance (int $field_id, ?int $datatype=null)
	Get FieldModel from field-id and datatype. More...
static	getFieldModelInstanceByClass (ilDclBaseFieldModel $field, ?int $field_id=null)
	Gets the correct instance of a fieldModel class Checks if a field is a plugin a replaces the fieldModel with the necessary class. More...
static	getFieldTypeByInstance (ilDclBaseFieldModel $field)
static	getClassByInstance (ilDclBaseFieldModel $field, string $class_pattern)
static	getClassPathByInstance (ilDclBaseFieldModel $field, string $class_pattern)
static	parseDatatypeTitle (string $title)
	Parse string to FieldClass format Replaces _ with camelcase-notation. More...
static	getRecordModelInstance (?int $record_id)
static	getPluginNameFromFieldModel (ilDclBaseFieldModel $object)

Static Public Attributes
static string	$field_base_path_patter = "./Modules/DataCollection/classes/Fields/%s/"
static string	$default_prefix = "ilDcl"
static string	$record_field_class_patter = "%sRecordFieldModel"
static string	$field_class_patter = "%sFieldModel"
static string	$record_representation_class_pattern = "%sRecordRepresentation"
static string	$field_representation_class_pattern = "%sFieldRepresentation"

Static Protected Attributes
static array	$record_field_cache = array()
static array	$field_class_cache = array()
static array	$field_representation_cache = array()
static array	$record_representation_cache = array()
static array	$field_model_cache = array()
static array	$field_type_cache = array()
static array	$class_path_cache = array()

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

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

Member Function Documentation

getClassByInstance()

static ilDclFieldFactory::getClassByInstance ( ilDclBaseFieldModel  $field, string  $class_pattern  )

static

Definition at line 238 of file class.ilDclFieldFactory.php.

                                                                                                : string
    {
        $fieldtype = self::getFieldTypeByInstance($field);
 
        return self::getFieldClass($fieldtype, $class_pattern);
    }

Referenced by getFieldRepresentationInstance(), and getRecordFieldInstance().

Here is the caller graph for this function:

getClassPathByInstance()

static ilDclFieldFactory::getClassPathByInstance ( ilDclBaseFieldModel  $field, string  $class_pattern  )

static

Exceptions

ilDclException

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

                                                                                                    : string
    {
        global $DIC;
        $datatype = $field->getDatatype();
 
        if ($field->getId() != null && !empty(self::$class_path_cache[$field->getId()][$class_pattern])) {
            return self::$class_path_cache[$field->getId()][$class_pattern];
        }
 
        if (ilDclFieldTypePlugin::isPluginDatatype($datatype->getTitle())) {
            $plugin_id = ilDclFieldTypePlugin::getPluginId($datatype->getTitle());
            if ($DIC["component.repository"]->hasActivatedPlugin($plugin_id)) {
                $class_path = $DIC["component.repository"]->getPluginById($plugin_id)->getPath() . '/classes/';
            } else {
                return '';
            }
        } else {
            $class_path = sprintf(
                self::$field_base_path_patter,
                ucfirst(self::parseDatatypeTitle($datatype->getTitle()))
            );
        }
 
        $return = $class_path . self::getFieldClassFile(self::getFieldTypeByInstance($field), $class_pattern);
 
        if ($field->getId() != null) {
            self::$class_path_cache[$field->getId()][$class_pattern] = $return;
        }
 
        return $return;
    }

References $DIC, ilDclBaseFieldModel\getDatatype(), ilDclBaseFieldModel\getId(), ilDclFieldTypePlugin\getPluginId(), and ilDclFieldTypePlugin\isPluginDatatype().

Referenced by getFieldRepresentationInstance(), and getRecordFieldInstance().

Here is the call graph for this function:

Here is the caller graph for this function:

getFieldClass()

static ilDclFieldFactory::getFieldClass ( string  $datatype, string  $class_pattern  )

static

Concatenates Classname from datatype and pattern.

Definition at line 68 of file class.ilDclFieldFactory.php.

                                                                                 : string
    {
        if (!empty(self::$field_class_cache[$datatype . $class_pattern])) {
            return self::$field_class_cache[$datatype . $class_pattern];
        }
 
        $fieldtype = $datatype;
 
        $class = sprintf($class_pattern, $fieldtype);
        self::$field_class_cache[$datatype . $class_pattern] = $class;
 
        return $class;
    }

Referenced by getFieldClassFile().

Here is the caller graph for this function:

getFieldClassFile()

static ilDclFieldFactory::getFieldClassFile ( string  $datatype, string  $class_pattern  )

static

Definition at line 82 of file class.ilDclFieldFactory.php.

                                                                                     : string
    {
        return "class." . self::getFieldClass($datatype, $class_pattern) . ".php";
    }

References getFieldClass().

Here is the call graph for this function:

getFieldModelInstance()

static ilDclFieldFactory::getFieldModelInstance ( int  $field_id, ?int  $datatype = null  )

static

Get FieldModel from field-id and datatype.

Exceptions

ilDclException

Definition at line 160 of file class.ilDclFieldFactory.php.

                                                                                      : ilDclBaseFieldModel
    {
        $base = new ilDclBaseFieldModel($field_id);
        if ($datatype != null) {
            $base->setDatatypeId($datatype);
        }
 
        $ilDclBaseFieldModel = self::getFieldModelInstanceByClass($base, $field_id);
 
        return $ilDclBaseFieldModel;
    }

References $base.

Referenced by ilDclFieldEditGUI\__construct(), and ilDclCache\getFieldCache().

Here is the caller graph for this function:

getFieldModelInstanceByClass()

static ilDclFieldFactory::getFieldModelInstanceByClass ( ilDclBaseFieldModel  $field, ?int  $field_id = null  )

static

Gets the correct instance of a fieldModel class Checks if a field is a plugin a replaces the fieldModel with the necessary class.

Exceptions

ilDclException

Definition at line 179 of file class.ilDclFieldFactory.php.

     : ilDclBaseFieldModel {
        if ($field->getId() != null && !empty(self::$field_model_cache[$field->getId()])) {
            return self::$field_model_cache[$field->getId()];
        }
 
        $path_type = self::getClassPathByInstance($field, self::$field_class_patter);
 
        if (file_exists($path_type)) {
            $class = self::getClassByInstance($field, self::$field_class_patter);
        } else {
            $class = self::getFieldClass(self::$default_prefix . "Base", self::$field_class_patter);
        }
 
        if ($field_id) {
            $instance = new $class($field_id);
        } else {
            $instance = new $class();
        }
 
        if ($instance == null) {
            throw new ilDclException("Could not create FieldModel of " . $class);
        }
        $instance->setDatatypeId($field->getDatatypeId());
 
        if ($field->getId() != null) {
            self::$field_model_cache[$field->getId()] = $instance;
        }
 
        return $instance;
    }

References ilDclBaseFieldModel\getId().

Referenced by ilDclCache\buildFieldFromRecord(), ilDclFieldEditGUI\checkInput(), and ilDclFieldEditGUI\initForm().

Here is the call graph for this function:

Here is the caller graph for this function:

getFieldRepresentationInstance()

static ilDclFieldFactory::getFieldRepresentationInstance ( ilDclBaseFieldModel  $field )

static

Definition at line 89 of file class.ilDclFieldFactory.php.

                                                                                     : ilDclBaseFieldRepresentation
    {
        // when the datatype overview is generated no field-models are available, so an empty instance is used => no caching there
        if ($field->getId() != null && !empty(self::$field_representation_cache[$field->getId()])) {
            return self::$field_representation_cache[$field->getId()];
        }
 
        $class_path = self::getClassPathByInstance($field, self::$field_representation_class_pattern);
 
        $instance = null;
        if (file_exists($class_path)) {
            $class = self::getClassByInstance($field, self::$field_representation_class_pattern);
            $instance = new $class($field);
        } else {
            throw new ilDclException("Path for FieldRepresentation with file " . $class_path . " does not exists!");
        }
 
        if ($instance == null) {
            throw new ilDclException("Could not create FieldRepresentation of " . $class . " with file " . $class_path);
        }
 
        if ($field->getId() != null) {
            self::$field_representation_cache[$field->getId()] = $instance;
        }
 
        return $instance;
    }

References getClassByInstance(), getClassPathByInstance(), and ilDclBaseFieldModel\getId().

Referenced by ilDclSelectionFieldModel\getConfirmationGUI(), ilDclCache\getFieldRepresentation(), ilDclTableViewEditFieldsTableGUI\getStandardFilterHTML(), ilDclFieldEditGUI\initForm(), ilDclBaseFieldModel\storePropertiesFromForm(), and ilDclSelectionFieldModel\storePropertiesFromForm().

Here is the call graph for this function:

Here is the caller graph for this function:

getFieldTypeByInstance()

static ilDclFieldFactory::getFieldTypeByInstance ( ilDclBaseFieldModel  $field )

static

Definition at line 215 of file class.ilDclFieldFactory.php.

                                                                             : string
    {
        global $DIC;
        $datatype = $field->getDatatype();
 
        if (!empty(self::$field_type_cache[$datatype->getId()])) {
            return self::$field_type_cache[$datatype->getId()];
        }
 
        if (ilDclFieldTypePlugin::isPluginDatatype($datatype->getTitle())) {
            $plugin_id = ilDclFieldTypePlugin::getPluginId($datatype->getTitle());
            if ($DIC["component.repository"]->hasActivatedPlugin($plugin_id)) {
                $fieldtype = 'il' . $DIC["component.repository"]->getPluginById($plugin_id)->getName();
            } else {
                $fieldtype = '';
            }
        } else {
            $fieldtype = self::$default_prefix . ucfirst(self::parseDatatypeTitle($datatype->getTitle()));
        }
        self::$field_type_cache[$datatype->getId()] = $fieldtype;
        return $fieldtype;
    }

References $DIC, ilDclBaseFieldModel\getDatatype(), ilDclFieldTypePlugin\getPluginId(), and ilDclFieldTypePlugin\isPluginDatatype().

Here is the call graph for this function:

getPluginNameFromFieldModel()

static ilDclFieldFactory::getPluginNameFromFieldModel ( ilDclBaseFieldModel  $object )

static

Definition at line 304 of file class.ilDclFieldFactory.php.

                                                                                   : string
    {
        $class_name = get_class($object);
        $class_name = substr($class_name, 2, -(strlen(self::$field_class_patter) - 2));
 
        return $class_name;
    }

getRecordFieldInstance()

static ilDclFieldFactory::getRecordFieldInstance ( object  $field, object  $record  )

static

Creates a RecordField instance and loads the field and record representation.

Parameters

object | ilDclBaseFieldModel	$field
object | ilDclBaseRecordModel	$record

Exceptions

ilDclException
Exception

Definition at line 36 of file class.ilDclFieldFactory.php.

                                                                                : ilDclBaseRecordFieldModel
    {
        if (!empty(self::$record_field_cache[$field->getId()][$record->getId()])) {
            return self::$record_field_cache[$field->getId()][$record->getId()];
        }
 
        $path = self::getClassPathByInstance($field, self::$record_field_class_patter);
        if (file_exists($path)) {
            $class = self::getClassByInstance($field, self::$record_field_class_patter);
            $instance = new $class($record, $field);
            if ($instance instanceof ilDclBaseRecordFieldModel) {
                if (!$instance->getFieldRepresentation()) {
                    $instance->setFieldRepresentation(self::getFieldRepresentationInstance($field));
                }
 
                if (!$instance->getRecordRepresentation()) {
                    $instance->setRecordRepresentation(self::getRecordRepresentationInstance($instance));
                }
                self::$record_field_cache[$field->getId()][$record->getId()] = $instance;
 
                return $instance;
            }
        }
 
        throw new RuntimeException("file not found " . $path);
    }

References $path, getClassByInstance(), and getClassPathByInstance().

Referenced by ilDclCache\getRecordFieldCache().

Here is the call graph for this function:

Here is the caller graph for this function:

getRecordModelInstance()

static ilDclFieldFactory::getRecordModelInstance ( ?int  $record_id )

static

Definition at line 299 of file class.ilDclFieldFactory.php.

                                                                  : ilDclBaseRecordModel
    {
        return new ilDclBaseRecordModel($record_id);
    }

Referenced by ilDclCache\getRecordCache().

Here is the caller graph for this function:

getRecordRepresentationInstance()

static ilDclFieldFactory::getRecordRepresentationInstance ( ilDclBaseRecordFieldModel  $record_field )

static

Get RecordRepresentation from RecordFieldModel.

Exceptions

ilDclException

Definition at line 123 of file class.ilDclFieldFactory.php.

     : ilDclBaseRecordRepresentation {
        // there are some field types which have no recordFieldModel object (e.g rating) => no caching
        if ($record_field->getId() != null && !empty(self::$record_representation_cache[$record_field->getId()])) {
            return self::$record_representation_cache[$record_field->getId()];
        }
 
        $class_path = self::getClassPathByInstance(
            $record_field->getField(),
            self::$record_representation_class_pattern
        );
        $instance = null;
 
        if (file_exists($class_path)) {
            $class = self::getClassByInstance($record_field->getField(), self::$record_representation_class_pattern);
        } else {
            $class = self::getFieldClass(self::$default_prefix . "Base", self::$record_representation_class_pattern);
        }
 
        $instance = new $class($record_field);
 
        if ($instance == null) {
            throw new ilDclException("Could not create RecordRepresentation of " . $class_path . " " . $record_field->getField()->getDatatype()->getTitle());
        }
 
        if ($record_field->getId() != null) {
            self::$record_representation_cache[$record_field->getId()] = $instance;
        }
 
        return $instance;
    }

References ilDclBaseRecordFieldModel\getId().

Here is the call graph for this function:

parseDatatypeTitle()

static ilDclFieldFactory::parseDatatypeTitle ( string  $title )

static

Parse string to FieldClass format Replaces _ with camelcase-notation.

Definition at line 286 of file class.ilDclFieldFactory.php.

                                                            : string
    {
        $parts = explode("_", $title);
        $func = function ($value) {
            return ucfirst($value);
        };
 
        $parts = array_map($func, $parts);
        $title = implode("", $parts);
 
        return $title;
    }

References $parts.

Field Documentation

$class_path_cache

array ilDclFieldFactory::$class_path_cache = array()

staticprotected

Definition at line 245 of file class.ilDclFieldFactory.php.

$default_prefix

string ilDclFieldFactory::$default_prefix = "ilDcl"

static

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

$field_base_path_patter

string ilDclFieldFactory::$field_base_path_patter = "./Modules/DataCollection/classes/Fields/%s/"

static

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

$field_class_cache

array ilDclFieldFactory::$field_class_cache = array()

staticprotected

Definition at line 63 of file class.ilDclFieldFactory.php.

$field_class_patter

string ilDclFieldFactory::$field_class_patter = "%sFieldModel"

static

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

$field_model_cache

array ilDclFieldFactory::$field_model_cache = array()

staticprotected

Definition at line 172 of file class.ilDclFieldFactory.php.

$field_representation_cache

array ilDclFieldFactory::$field_representation_cache = array()

staticprotected

Definition at line 87 of file class.ilDclFieldFactory.php.

$field_representation_class_pattern

string ilDclFieldFactory::$field_representation_class_pattern = "%sFieldRepresentation"

static

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

$field_type_cache

array ilDclFieldFactory::$field_type_cache = array()

staticprotected

Definition at line 213 of file class.ilDclFieldFactory.php.

$record_field_cache

array ilDclFieldFactory::$record_field_cache = array()

staticprotected

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

$record_field_class_patter

string ilDclFieldFactory::$record_field_class_patter = "%sRecordFieldModel"

static

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

$record_representation_cache

array ilDclFieldFactory::$record_representation_cache = array()

staticprotected

Definition at line 117 of file class.ilDclFieldFactory.php.

$record_representation_class_pattern

string ilDclFieldFactory::$record_representation_class_pattern = "%sRecordRepresentation"

static

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

---

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

• Modules/DataCollection/classes/Fields/class.ilDclFieldFactory.php