ilDclFieldFactory Class Reference

Class ilDclFieldFactory This Class handles the creation of all field-classes. More...

Collaboration diagram for ilDclFieldFactory:

Static Public Member Functions
static	getRecordFieldInstance (ilDclBaseFieldModel $field, ilDclBaseRecordModel $record)
	Creates a RecordField instance and loads the field and record representation. More...
static	getFieldClass ($datatype, $class_pattern)
	Concatenates Classname from datatype and pattern. More...
static	getFieldClassFile ($datatype, $class_pattern)
	Get Filename from datatype and pattern. More...
static	getFieldRepresentationInstance (ilDclBaseFieldModel $field)
	Returns FieldRepresentation from BaseFieldModel. More...
static	getRecordRepresentationInstance (ilDclBaseRecordFieldModel $record_field)
	Get RecordRepresentation from RecordFieldModel. More...
static	getFieldModelInstance ($field_id, $datatype=null)
	Get FieldModel from field-id and datatype. More...
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 fieldModel with the necessary class. More...
static	getFieldTypeByInstance (ilDclBaseFieldModel $field)
static	getClassByInstance (ilDclBaseFieldModel $field, $class_pattern)
static	getClassPathByInstance (ilDclBaseFieldModel $field, $class_pattern)
static	parseDatatypeTitle ($title)
	Parse string to FieldClass format Replaces _ with camelcase-notation. More...
static	getRecordModelInstance ($record_id)
	Creates a RecordModel instance. More...
static	getPluginNameFromFieldModel (ilDclBaseFieldModel $object)
	Get plugin-name from FieldModel. More...

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

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

Detailed Description

Class ilDclFieldFactory This Class handles the creation of all field-classes.

Author

Michael Herren mh@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Version

1.0.0

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

Member Function Documentation

getClassByInstance()

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

static

Parameters

ilDclBaseFieldModel	$field
	$class_pattern

Returns

string

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

    {
        $fieldtype = self::getFieldTypeByInstance($field);

        return self::getFieldClass($fieldtype, $class_pattern);
    }

getClassPathByInstance()

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

static

Parameters

ilDclBaseFieldModel	$field
	$class_pattern

Returns

string

Exceptions

ilDclException

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

References ilDclFieldTypePlugin\COMPONENT_NAME, ilDclBaseFieldModel\getDatatype(), ilDclBaseFieldModel\getId(), ilPlugin\getPluginObject(), ilDclBaseFieldModel\getProperty(), ilDclBaseFieldModel\getTitle(), ilDclBaseFieldModel\hasProperty(), IL_COMP_MODULE, ilDclDatatype\INPUTFORMAT_PLUGIN, ilDclBaseFieldModel\PROP_PLUGIN_HOOK_NAME, and ilDclFieldTypePlugin\SLOT_ID.

    {
        $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 ($datatype->getId() == ilDclDatatype::INPUTFORMAT_PLUGIN) {
            if ($field->hasProperty(ilDclBaseFieldModel::PROP_PLUGIN_HOOK_NAME)) {
                $plugin_data
                    = ilPlugin::getPluginObject(IL_COMP_MODULE, ilDclFieldTypePlugin::COMPONENT_NAME, ilDclFieldTypePlugin::SLOT_ID, $field->getProperty(ilDclBaseFieldModel::PROP_PLUGIN_HOOK_NAME));
                if ($plugin_data == null) {
                    throw new ilDclException(
                        "Something went wrong by initializing the FieldHook-Plugin '"
                        . $field->getProperty(ilDclBaseFieldModel::PROP_PLUGIN_HOOK_NAME) . "' on Component '"
                        . ilDclFieldTypePlugin::COMPONENT_NAME . "' with slot '" . ilDclFieldTypePlugin::SLOT_ID . "' on field: "
                        . $field->getTitle()
                    );
                }

                $class_path = $plugin_data->getDirectory() . "/classes/";
            } else {
                $class_path = sprintf(self::$field_base_path_patter, ucfirst(self::parseDatatypeTitle($datatype->getTitle())));
            }
        } 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;
    }

Here is the call graph for this function:

getFieldClass()

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

static

Concatenates Classname from datatype and pattern.

Parameters

$datatype
$class_pattern

Returns

string

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

    {
        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;
    }

getFieldClassFile()

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

static

Get Filename from datatype and pattern.

Parameters

$datatype
$class_pattern

Returns

string

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

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

getFieldModelInstance()

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

static

Get FieldModel from field-id and datatype.

Parameters

	$field_id
null	$datatype

Returns

mixed

Exceptions

ilDclException

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

References $base.

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

    {
        $base = new ilDclBaseFieldModel($field_id);
        if ($datatype != null) {
            $base->setDatatypeId($datatype);
        }

        $ilDclBaseFieldModel = self::getFieldModelInstanceByClass($base, $field_id);

        return $ilDclBaseFieldModel;
    }

Here is the caller graph for this function:

getFieldModelInstanceByClass()

static ilDclFieldFactory::getFieldModelInstanceByClass ( ilDclBaseFieldModel  $field,   $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.

Parameters

ilDclBaseFieldModel	$field
null	$field_id

Returns

ilDclBaseFieldModel

Exceptions

ilDclException

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

References ilDclBaseFieldModel\getId().

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

    {
        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)) {
            require_once($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);
        }

        if ($field->getId() != null) {
            self::$field_model_cache[$field->getId()] = $instance;
        }

        return $instance;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getFieldRepresentationInstance()

static ilDclFieldFactory::getFieldRepresentationInstance ( ilDclBaseFieldModel  $field )

static

Returns FieldRepresentation from BaseFieldModel.

Parameters

ilDclBaseFieldModel

$field

Returns

ilDclBaseFieldRepresentation

Exceptions

ilDclException

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

References ilDclBaseFieldModel\getId().

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

    {
        // 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)) {
            require_once($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;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getFieldTypeByInstance()

static ilDclFieldFactory::getFieldTypeByInstance ( ilDclBaseFieldModel  $field )

static

Parameters

ilDclBaseFieldModel

$field

Returns

string

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

References ilDclFieldTypePlugin\COMPONENT_NAME, ilDclBaseFieldModel\getDatatype(), ilDclBaseFieldModel\getId(), ilPlugin\getPluginObject(), ilDclBaseFieldModel\getProperty(), ilDclBaseFieldModel\hasProperty(), IL_COMP_MODULE, ilDclDatatype\INPUTFORMAT_PLUGIN, ilDclBaseFieldModel\PROP_PLUGIN_HOOK_NAME, and ilDclFieldTypePlugin\SLOT_ID.

    {
        $datatype = $field->getDatatype();

        if (!empty(self::$field_type_cache[$datatype->getId()])) {
            if ($datatype->getId() == ilDclDatatype::INPUTFORMAT_PLUGIN) {
                if (!empty(self::$field_type_cache[$datatype->getId()][$field->getId()])) {
                    return self::$field_type_cache[$datatype->getId()][$field->getId()];
                }
            } else {
                return self::$field_type_cache[$datatype->getId()];
            }
        }

        if ($datatype->getId() == ilDclDatatype::INPUTFORMAT_PLUGIN) {
            if ($field->hasProperty(ilDclBaseFieldModel::PROP_PLUGIN_HOOK_NAME)) {
                $plugin_data
                    = ilPlugin::getPluginObject(IL_COMP_MODULE, ilDclFieldTypePlugin::COMPONENT_NAME, ilDclFieldTypePlugin::SLOT_ID, $field->getProperty(ilDclBaseFieldModel::PROP_PLUGIN_HOOK_NAME));
                $fieldtype = $plugin_data->getPluginClassPrefix() . ucfirst($plugin_data->getPluginName());
            } else {
                $fieldtype = self::$default_prefix . ucfirst(self::parseDatatypeTitle($datatype->getTitle()));
            }
            self::$field_type_cache[$datatype->getId()][$field->getId()] = $fieldtype;
        } else {
            $fieldtype = self::$default_prefix . ucfirst(self::parseDatatypeTitle($datatype->getTitle()));
            self::$field_type_cache[$datatype->getId()] = $fieldtype;
        }

        return $fieldtype;
    }

Here is the call graph for this function:

getPluginNameFromFieldModel()

static ilDclFieldFactory::getPluginNameFromFieldModel ( ilDclBaseFieldModel  $object )

static

Get plugin-name from FieldModel.

Parameters

ilDclBaseFieldModel

$object

Returns

string

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

Referenced by ilDclBaseFieldRepresentation\addFieldCreationForm().

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

        return $class_name;
    }

Here is the caller graph for this function:

getRecordFieldInstance()

static ilDclFieldFactory::getRecordFieldInstance ( ilDclBaseFieldModel  $field, ilDclBaseRecordModel  $record  )

static

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

Parameters

ilDclBaseFieldModel	$field
ilDclBaseRecordModel	$record

Returns

mixed

Exceptions

ilDclException

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

References $path, ilDclBaseFieldModel\getId(), and ilDclBaseRecordModel\getId().

Referenced by ilDclCache\getRecordFieldCache().

    {
        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)) {
            require_once($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;
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getRecordModelInstance()

static ilDclFieldFactory::getRecordModelInstance (   $record_id )

static

Creates a RecordModel instance.

Parameters

$record_id

Returns

ilDclBaseRecordModel

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

Referenced by ilDclCache\getRecordCache().

    {
        return new ilDclBaseRecordModel($record_id);
    }

Here is the caller graph for this function:

getRecordRepresentationInstance()

static ilDclFieldFactory::getRecordRepresentationInstance ( ilDclBaseRecordFieldModel  $record_field )

static

Get RecordRepresentation from RecordFieldModel.

Parameters

ilDclBaseRecordFieldModel

$record_field

Returns

ilDclBaseRecordRepresentation

Exceptions

ilDclException

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

References ilDclBaseRecordFieldModel\getField(), and ilDclBaseRecordFieldModel\getId().

Referenced by ilDclRecordEditGUI\cancelSave(), and ilDclCache\getRecordRepresentation().

    {
        // 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)) {
            require_once($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;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

parseDatatypeTitle()

static ilDclFieldFactory::parseDatatypeTitle (   $title )

static

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

Parameters

$title

Returns

string

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

References $title.

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

        $parts = array_map($func, $parts);
        $title = implode("", $parts);

        return $title;
    }

Field Documentation

$class_path_cache

ilDclFieldFactory::$class_path_cache = array()

staticprotected

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

$default_prefix

ilDclFieldFactory::$default_prefix = "ilDcl"

static

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

$field_base_path_patter

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

static

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

$field_class_cache

ilDclFieldFactory::$field_class_cache = array()

staticprotected

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

$field_class_patter

ilDclFieldFactory::$field_class_patter = "%sFieldModel"

static

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

$field_model_cache

ilDclFieldFactory::$field_model_cache = array()

staticprotected

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

$field_representation_cache

ilDclFieldFactory::$field_representation_cache = array()

staticprotected

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

$field_representation_class_pattern

ilDclFieldFactory::$field_representation_class_pattern = "%sFieldRepresentation"

static

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

$field_type_cache

ilDclFieldFactory::$field_type_cache = array()

staticprotected

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

$record_class_patter

ilDclFieldFactory::$record_class_patter = "%sRecordModel"

static

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

$record_field_cache

ilDclFieldFactory::$record_field_cache = array()

staticprotected

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

$record_field_class_patter

ilDclFieldFactory::$record_field_class_patter = "%sRecordFieldModel"

static

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

$record_representation_cache

ilDclFieldFactory::$record_representation_cache = array()

staticprotected

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

$record_representation_class_pattern

ilDclFieldFactory::$record_representation_class_pattern = "%sRecordRepresentation"

static

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

---

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

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