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

Inheritance diagram for ilDclSelectionFieldModel:

Collaboration diagram for ilDclSelectionFieldModel:

Public Member Functions
	getValidFieldProperties ()
	Returns all valid properties for a field-type. More...

	getRecordQueryFilterObject ( $filter_value="", ?ilDclBaseFieldModel $sort_field=null)
	Returns a query-object for building the record-loader-sql-query. More...

	isMulti ()

	checkFieldCreationInput (ilPropertyFormGUI $form)
	Checks input of specific fields befor saving. More...

	storePropertiesFromForm (ilPropertyFormGUI $form)
	called when saving the 'edit field' form More...

	fillPropertiesForm (ilPropertyFormGUI &$form)

	setProperty (string $key, $value)

	reorderExistingValues ()
	sorts record field values by the new order More...

	getProperty (string $key)

	getRecordQuerySortObject (string $direction="asc", bool $sort_by_status=false)
	Returns a query-object for building the record-loader-sql-query. More...

	cloneProperties (ilDclBaseFieldModel $originalField)

	doDelete ()
	Remove field and properties. More...

	isConfirmationRequired (ilPropertyFormGUI $form)
	called by ilDclFieldEditGUI when updating field properties if you overwrite this method, remember to also overwrite getConfirmationGUI More...

	getConfirmationGUI (ilPropertyFormGUI $form)
	called by ilDclFieldEditGUI if isConfirmationRequired returns true More...

Public Member Functions inherited from ilDclBaseFieldModel
	__construct (int $a_id=0)

	setId ($a_id)
	Set field id. More...

	getId ()
	Get field id. More...

	setTableId (int $a_id)
	Set table id. More...

	getTableId ()
	Get table id. More...

	setTitle (string $a_title)
	Set title. More...

	getTitle ()
	Get title. More...

	setDescription (string $a_desc)
	Set description. More...

	getDescription ()
	Get description. More...

	setDatatypeId (int $a_id)
	Set datatype id. More...

	getDatatypeId ()
	Get datatype_id. More...

	isUnique ()

	setUnique (?bool $unique)

	getDatatype ()

	getDatatypeTitle ()

	getPresentationTitle ()

	getPresentationDescription ()

	getStorageLocation ()
	Get storage location for the model. More...

	getExportable ()

	toArray ()

	isStandardField ()

	doRead ()

	buildFromDBRecord (array $rec)
	Builds model from db record. More...

	doCreate ()

	doUpdate ()

	updateProperties ()
	Update properties of this field in Database. More...

	doDelete ()
	Remove field and properties. More...

	getViewSettings ()

	getViewSetting (int $tableview_id)

	getOrder ()

	setOrder (string $order)

	hasProperty (string $key)
	Checks if a certain property for a field is set. More...

	getProperty (string $key)
	Returns a certain property of a field. More...

	getPropertyInstance (string $key)
	Return ActiveRecord of property. More...

	setProperty (string $key, $value)
	Set a property for a field (does not save) More...

	getValidFieldProperties ()
	Returns all valid properties for a field-type. More...

	checkValidityFromForm (ilPropertyFormGUI &$form, ?int $record_id=null)

	checkValidity ($value, ?int $record_id=null)
	Check if input is valid. More...

	cloneStructure (int $original_id)

	afterClone (array $records)

	cloneProperties (ilDclBaseFieldModel $originalField)

	setExportable (bool $exportable)

	allowFilterInListView ()

	getRecordQuerySortObject (string $direction="asc", bool $sort_by_status=false)
	Returns a query-object for building the record-loader-sql-query. More...

	getRecordQueryFilterObject ( $filter_value="", ?ilDclBaseFieldModel $sort_field=null)
	Returns a query-object for building the record-loader-sql-query. More...

	getSortField ()
	Returns the sort-field id. More...

	hasNumericSorting ()
	Set to true, when the sorting should be handled numerical. More...

	checkFieldCreationInput (ilPropertyFormGUI $form)
	Checks input of specific fields befor saving. More...

	getStorageLocationOverride ()

	setStorageLocationOverride (?int $storage_location_override)

	fillHeaderExcel (ilExcel $worksheet, int &$row, int &$col)

	checkTitlesForImport (array &$titles, array &$import_fields)

	storePropertiesFromForm (ilPropertyFormGUI $form)
	called when saving the 'edit field' form More...

	fillPropertiesForm (ilPropertyFormGUI &$form)
	called to fill the 'edit field' form More...

	isConfirmationRequired (ilPropertyFormGUI $form)
	called by ilDclFieldEditGUI when updating field properties if you overwrite this method, remember to also overwrite getConfirmationGUI More...

	getConfirmationGUI (ilPropertyFormGUI $form)
	called by ilDclFieldEditGUI if isConfirmationRequired returns true More...

Data Fields
const	SELECTION_TYPE_SINGLE = 'selection_type_single'

const	SELECTION_TYPE_MULTI = 'selection_type_multi'

const	SELECTION_TYPE_COMBOBOX = 'selection_type_combobox'

const	PROP_SELECTION_TYPE = ''

const	PROP_SELECTION_OPTIONS = ''

Data Fields inherited from ilDclBaseFieldModel
const	PROP_LENGTH = "lenght"
	General properties. More...

const	PROP_REGEX = "regex"

const	PROP_REFERENCE = "table_id"

const	PROP_URL = "url"

const	PROP_TEXTAREA = "text_area"

const	PROP_REFERENCE_LINK = "reference_link"

const	PROP_WIDTH = "width"

const	PROP_HEIGHT = "height"

const	PROP_LEARNING_PROGRESS = "learning_progress"

const	PROP_ILIAS_REFERENCE_LINK = "ILIAS_reference_link"

const	PROP_N_REFERENCE = "multiple_selection"

const	PROP_FORMULA_EXPRESSION = "expression"

const	PROP_DISPLAY_COPY_LINK_ACTION_MENU = "display_action_menu"

const	PROP_LINK_DETAIL_PAGE_TEXT = "link_detail_page_text"

const	PROP_LINK_DETAIL_PAGE_MOB = "link_detail_page_mob"

const	PROP_SUPPORTED_FILE_TYPES = "supported_file_types"

const	PROP_PLUGIN_HOOK_NAME = "plugin_hook_name"

const	EDIT_VIEW = 2

const	EXPORTABLE_VIEW = 4

Protected Member Functions
	multiPropertyChanged (bool $is_multi_now)
	changes the values of all record fields, since the property "multi" has changed More...

Protected Member Functions inherited from ilDclBaseFieldModel
	loadDatatype ()
	Load datatype for model. More...

	loadTableFieldSetting ()
	loadTableFieldSetting More...

	addToTableViews ()
	create ilDclTableViewFieldSettings for this field in each tableview More...

	updateTableFieldSetting ()
	update exportable and fieldorder More...

	loadProperties ()
	Get all properties of a field. More...

	normalizeValue ($value)

Additional Inherited Members
Static Public Member Functions inherited from ilDclBaseFieldModel
static	_getTitleInvalidChars (bool $a_as_regex=true)
	All valid chars for filed titles. More...

static	_getFieldIdByTitle (string $title, int $table_id)

Protected Attributes inherited from ilDclBaseFieldModel
string	$id = ""

int	$table_id = 0

string	$title = ""

string	$description = ""

int	$datatypeId = 0

int	$order = null

bool	$unique = false

array	$property = []

bool	$exportable = false

ilDclDatatype	$datatype = null

int	$storage_location_override = null
	With this property the datatype-storage-location can be overwritten. More...

ilDBInterface	$db

ilLanguage	$lng

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.ilDclSelectionFieldModel.php.

Member Function Documentation

◆ checkFieldCreationInput()

ilDclSelectionFieldModel::checkFieldCreationInput ( ilPropertyFormGUI $form )

Checks input of specific fields befor saving.

Parameters

ilPropertyFormGUI $form

Returns: bool if checkInput was successful

Reimplemented from ilDclBaseFieldModel.

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

                                                                    : bool
    {
        $options_post_var = "prop_" . static::PROP_SELECTION_OPTIONS;
        foreach ($form->getInput($options_post_var) as $value) {
            if ($value["selection_value"] == "") {
                $inputObj = $form->getItemByPostVar($options_post_var);
                $inputObj->setAlert($this->lng->txt("msg_input_is_required"));
                return false;
            }
        }
 
        return parent::checkFieldCreationInput($form);
    }

References ilPropertyFormGUI\getInput(), ilPropertyFormGUI\getItemByPostVar(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ cloneProperties()

ilDclSelectionFieldModel::cloneProperties ( ilDclBaseFieldModel $originalField )

Reimplemented from ilDclBaseFieldModel.

Definition at line 288 of file class.ilDclSelectionFieldModel.php.

                                                                       : void
    {
        parent::cloneProperties($originalField);
        $options = ilDclSelectionOption::getAllForField($originalField->getId());
        foreach ($options as $opt) {
            $new_opt = new ilDclSelectionOption();
            $new_opt->cloneOption($opt);
            $new_opt->setFieldId($this->getId());
            $new_opt->store();
        }
    }

References ilDclSelectionOption\getAllForField(), ilDclBaseFieldModel\getId(), and ILIAS\Survey\Mode\getId().

Here is the call graph for this function:

◆ doDelete()

ilDclSelectionFieldModel::doDelete ( )

Remove field and properties.

Reimplemented from ilDclBaseFieldModel.

Definition at line 300 of file class.ilDclSelectionFieldModel.php.

                              : void
    {
        foreach (ilDclSelectionOption::getAllForField($this->getId()) as $option) {
            $option->delete();
        }
        parent::doDelete();
    }

References ilDclSelectionOption\getAllForField(), and ILIAS\Survey\Mode\getId().

Here is the call graph for this function:

◆ fillPropertiesForm()

ilDclSelectionFieldModel::fillPropertiesForm ( ilPropertyFormGUI & $form )

Parameters

ilPropertyFormGUI $form

Returns: bool

Reimplemented from ilDclBaseFieldModel.

Definition at line 133 of file class.ilDclSelectionFieldModel.php.

                                                                : bool
    {
        $values = [
            'table_id' => $this->getTableId(),
            'field_id' => $this->getId(),
            'title' => $this->getTitle(),
            'datatype' => $this->getDatatypeId(),
            'description' => $this->getDescription(),
            'unique' => $this->isUnique(),
        ];
 
        $properties = $this->getValidFieldProperties();
        foreach ($properties as $prop) {
            if ($prop == static::PROP_SELECTION_OPTIONS) {
                $options = ilDclSelectionOption::getAllForField($this->getId());
                $prop_values = [];
                foreach ($options as $option) {
                    // the 'selection_value' is for a correct input
                    $prop_values[$option->getOptId()] = ['selection_value' => $option->getValue()];
                }
 
                $values['prop_' . $prop] = $prop_values;
            } else {
                $values['prop_' . $prop] = $this->getProperty($prop);
            }
        }
 
        $form->setValuesByArray($values);
 
        return true;
    }

References ilDclSelectionOption\getAllForField(), ILIAS\Survey\Mode\getId(), and ilPropertyFormGUI\setValuesByArray().

Here is the call graph for this function:

◆ getConfirmationGUI()

ilDclSelectionFieldModel::getConfirmationGUI ( ilPropertyFormGUI $form )

called by ilDclFieldEditGUI if isConfirmationRequired returns true

Reimplemented from ilDclBaseFieldModel.

Definition at line 315 of file class.ilDclSelectionFieldModel.php.

                                                               : ilConfirmationGUI
    {
        global $DIC;
        $representation = ilDclFieldFactory::getFieldRepresentationInstance($this);
        $prop_selection_options = $representation->getPropertyInputFieldId(static::PROP_SELECTION_OPTIONS);
        $prop_selection_type = $representation->getPropertyInputFieldId(static::PROP_SELECTION_TYPE);
 
        $ilConfirmationGUI = parent::getConfirmationGUI($form);
        $ilConfirmationGUI->setHeaderText($DIC->language()->txt('dcl_msg_mc_to_sc_confirmation'));
        $ilConfirmationGUI->addHiddenItem($prop_selection_type, $form->getInput($prop_selection_type));
        foreach ($form->getInput($prop_selection_options) as $key => $option) {
            $ilConfirmationGUI->addHiddenItem(
                $prop_selection_options . "[$key][selection_value]",
                $option['selection_value']
            );
        }
 
        return $ilConfirmationGUI;
    }

References $DIC, ILIAS\LTI\ToolProvider\$key, ilDclFieldFactory\getFieldRepresentationInstance(), and ilPropertyFormGUI\getInput().

Here is the call graph for this function:

◆ getProperty()

ilDclSelectionFieldModel::getProperty ( string $key )

Parameters

$key

Returns: ilDclSelectionOption[]|ilDclFieldProperty|null

Reimplemented from ilDclBaseFieldModel.

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

    {
        switch ($key) {
            case static::PROP_SELECTION_OPTIONS:
                return ilDclSelectionOption::getAllForField($this->getId());
            default:
                return parent::getProperty($key);
        }
    }

References ILIAS\LTI\ToolProvider\$key, ilDclSelectionOption\getAllForField(), and ILIAS\Survey\Mode\getId().

Here is the call graph for this function:

◆ getRecordQueryFilterObject()

ilDclSelectionFieldModel::getRecordQueryFilterObject	(		$filter_value = `""`,
		?ilDclBaseFieldModel	$sort_field = `null`
	)

Returns a query-object for building the record-loader-sql-query.

Parameters

string | int $filter_value

Reimplemented from ilDclBaseFieldModel.

Definition at line 37 of file class.ilDclSelectionFieldModel.php.

     : ?ilDclRecordQueryObject {
        global $DIC;
        $ilDB = $DIC['ilDB'];
 
        $join_str
            = " LEFT JOIN il_dcl_record_field AS filter_record_field_{$this->getId()} ON (filter_record_field_{$this->getId()}.record_id = record.id AND filter_record_field_{$this->getId()}.field_id = "
            . $ilDB->quote($this->getId(), 'integer') . ") ";
 
        $join_str .= " LEFT JOIN il_dcl_stloc{$this->getStorageLocation()}_value AS filter_stloc_{$this->getId()} ON (filter_stloc_{$this->getId()}.record_field_id = filter_record_field_{$this->getId()}.id";
 
        $where_str = " AND ";
        if ($filter_value == 'none') {
            $where_str .= "("
                . "filter_stloc_{$this->getId()}.value IS NULL "
                . " OR filter_stloc_{$this->getId()}.value = " . $ilDB->quote("", 'text')
                . " OR filter_stloc_{$this->getId()}.value = " . $ilDB->quote("[]", 'text')
                . ") ";
        } else {
            if ($this->isMulti()) {
                $where_str .= " (" .
                    "filter_stloc_{$this->getId()}.value = " . $ilDB->quote("[$filter_value]", 'text') . " OR " .
                    "filter_stloc_{$this->getId()}.value LIKE " . $ilDB->quote("%\"$filter_value\"%", 'text') . " OR " .
                    "filter_stloc_{$this->getId()}.value LIKE " . $ilDB->quote("%,$filter_value,%", 'text') . " OR " .
                    "filter_stloc_{$this->getId()}.value LIKE " . $ilDB->quote("%[$filter_value,%", 'text') . " OR " .
                    "filter_stloc_{$this->getId()}.value LIKE " . $ilDB->quote("%,$filter_value]%", 'text') .
                    ") ";
            } else {
                $where_str .= "filter_stloc_{$this->getId()}.value = "
                    . $ilDB->quote($filter_value, 'integer');
            }
        }
 
        $join_str .= ") ";
 
        $sql_obj = new ilDclRecordQueryObject();
        $sql_obj->setJoinStatement($join_str);
        $sql_obj->setWhereStatement($where_str);
 
        return $sql_obj;
    }

References $ilDB.

◆ getRecordQuerySortObject()

ilDclSelectionFieldModel::getRecordQuerySortObject	(	string	$direction = `"asc"`,
		bool	$sort_by_status = `false`
	)

Returns a query-object for building the record-loader-sql-query.

Parameters

bool $sort_by_status The specific sort object is a status field

Reimplemented from ilDclBaseFieldModel.

Definition at line 260 of file class.ilDclSelectionFieldModel.php.

     : ?ilDclRecordQueryObject {
        global $DIC;
        $ilDB = $DIC['ilDB'];
 
        if ($this->isMulti()) {
            return null;
        }
 
        $sql_obj = new ilDclRecordQueryObject();
 
        $select_str = "sel_opts_{$this->getId()}.value AS field_{$this->getId()}";
        $join_str
            = "LEFT JOIN il_dcl_record_field AS sort_record_field_{$this->getId()} ON (sort_record_field_{$this->getId()}.record_id = record.id AND sort_record_field_{$this->getId()}.field_id = "
            . $ilDB->quote($this->getId(), 'integer') . ") ";
        $join_str .= "LEFT JOIN il_dcl_stloc{$this->getStorageLocation()}_value AS sort_stloc_{$this->getId()} ON (sort_stloc_{$this->getId()}.record_field_id = sort_record_field_{$this->getId()}.id) ";
        $join_str .= "LEFT JOIN il_dcl_sel_opts as sel_opts_{$this->getId()} ON (sel_opts_{$this->getId()}.opt_id = sort_stloc_{$this->getId()}.value AND sel_opts_{$this->getId()}.field_id = "
            . $ilDB->quote($this->getId(), 'integer') . ") ";
 
        $sql_obj->setSelectStatement($select_str);
        $sql_obj->setJoinStatement($join_str);
        $sql_obj->setOrderStatement("field_{$this->getId()} {$direction} , ID ASC");
 
        return $sql_obj;
    }

◆ getValidFieldProperties()

ilDclSelectionFieldModel::getValidFieldProperties ( )

Returns all valid properties for a field-type.

Reimplemented from ilDclBaseFieldModel.

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

                                             : array
    {
        return [static::PROP_SELECTION_OPTIONS, static::PROP_SELECTION_TYPE];
    }

◆ isConfirmationRequired()

ilDclSelectionFieldModel::isConfirmationRequired ( ilPropertyFormGUI $form )

called by ilDclFieldEditGUI when updating field properties if you overwrite this method, remember to also overwrite getConfirmationGUI

Reimplemented from ilDclBaseFieldModel.

Definition at line 308 of file class.ilDclSelectionFieldModel.php.

                                                                   : bool
    {
        $will_be_multi = ($form->getInput('prop_' . static::PROP_SELECTION_TYPE) == self::SELECTION_TYPE_MULTI);
 
        return $this->isMulti() && !$will_be_multi;
    }

References ilPropertyFormGUI\getInput().

Here is the call graph for this function:

◆ isMulti()

ilDclSelectionFieldModel::isMulti ( )

Definition at line 81 of file class.ilDclSelectionFieldModel.php.

                             : bool
    {
        return ($this->getProperty(static::PROP_SELECTION_TYPE) == self::SELECTION_TYPE_MULTI);
    }

◆ multiPropertyChanged()

ilDclSelectionFieldModel::multiPropertyChanged ( bool $is_multi_now )

protected

changes the values of all record fields, since the property "multi" has changed

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

                                                               : void
    {
        foreach (ilDclCache::getTableCache($this->getTableId())->getRecords() as $record) {
            $record_field = $record->getRecordField($this->getId());
            $record_field_value = $record_field->getValue();
 
            if ($record_field_value && !is_array($record_field_value) && $is_multi_now) {
                $record_field->setValue([$record_field_value]);
                $record_field->doUpdate();
            } else {
                if (is_array($record_field_value) && !$is_multi_now) {
                    $record_field->setValue(array_shift($record_field_value));
                    $record_field->doUpdate();
                }
            }
        }
    }

References ILIAS\Survey\Mode\getId(), and ilDclCache\getTableCache().

Here is the call graph for this function:

◆ reorderExistingValues()

ilDclSelectionFieldModel::reorderExistingValues ( )

sorts record field values by the new order

Definition at line 203 of file class.ilDclSelectionFieldModel.php.

                                           : void
    {
        $options = ilDclSelectionOption::getAllForField($this->getId());
        // loop each record(-field)
        foreach (ilDclCache::getTableCache($this->getTableId())->getRecords() as $record) {
            $record_field = $record->getRecordField($this->getId());
            $record_field_value = $record_field->getValue();
 
            if (is_array($record_field_value) && count($record_field_value) > 1) {
                $sorted_array = [];
                // $options has the right order, so loop those
                foreach ($options as $option) {
                    if (in_array($option->getOptId(), $record_field_value)) {
                        $sorted_array[] = $option->getOptId();
                    }
                }
                $record_field->setValue($sorted_array);
                $record_field->doUpdate();
            }
        }
    }

References ilDclSelectionOption\getAllForField(), ILIAS\Survey\Mode\getId(), and ilDclCache\getTableCache().

Here is the call graph for this function:

◆ setProperty()

ilDclSelectionFieldModel::setProperty	(	string	$key,
			$value
	)

Parameters

array $value

Reimplemented from ilDclBaseFieldModel.

Definition at line 168 of file class.ilDclSelectionFieldModel.php.

                                                    : ?ilDclFieldProperty
    {
        $is_update = $this->getProperty($key);
        switch ($key) {
            case static::PROP_SELECTION_OPTIONS:
 
                ilDclSelectionOption::flushOptions($this->getId());
                $sorting = 1;
                foreach ($value as $id => $val) {
                    ilDclSelectionOption::storeOption($this->getId(), $id, $sorting, $val);
                    $sorting++;
                }
                // if the field is not being created reorder the options in the existing record fields
                if ($is_update) {
                    $this->reorderExistingValues();
                }
                break;
            case static::PROP_SELECTION_TYPE:
                $will_be_multi = ($value == self::SELECTION_TYPE_MULTI);
                // if the "Multi" property has changed, adjust the record field values
                if ($is_update && ($this->isMulti() && !$will_be_multi || !$this->isMulti() && $will_be_multi)) {
                    $this->multiPropertyChanged($will_be_multi);
                }
                parent::setProperty($key, $value)->store();
                break;
            default:
                parent::setProperty($key, $value)->store();
        }
 
        return null;
    }

References $id, ILIAS\LTI\ToolProvider\$key, ilDclSelectionOption\flushOptions(), and ILIAS\Survey\Mode\getId().

Here is the call graph for this function:

◆ storePropertiesFromForm()

ilDclSelectionFieldModel::storePropertiesFromForm ( ilPropertyFormGUI $form )

called when saving the 'edit field' form

Exceptions

ilDclException

Reimplemented from ilDclBaseFieldModel.

Definition at line 104 of file class.ilDclSelectionFieldModel.php.

                                                                    : void
    {
        $representation = ilDclFieldFactory::getFieldRepresentationInstance($this);
 
        $field_props = $this->getValidFieldProperties();
        foreach ($field_props as $property) {
            $value = $form->getInput($representation->getPropertyInputFieldId($property));
 
            // break down the multidimensional array from the multi input
            // e.g.: { [0] => { [0] => 'x' }, [1] => { [1] => 'y' } }    TO    { [0] => 'x', [1] => 'y' }
            if (is_array($value)) {
                foreach ($value as $k => $v) {
                    if (is_array($v)) {
                        $value[$k] = array_shift($v);
                    }
                }
            }
 
            // save non empty values and set them to null, when they already exist. Do not override plugin-hook when already set.
            if (!empty($value) || ($this->getPropertyInstance($property) != null && $property != self::PROP_PLUGIN_HOOK_NAME)) {
                $this->setProperty($property, $value);
            }
        }
    }