Class ilDclSelectionFieldModel. More...

Inheritance diagram for ilDclSelectionFieldModel:

Collaboration diagram for ilDclSelectionFieldModel:

Public Member Functions

getValidFieldProperties ()

@inheritDoc More...

getRecordQueryFilterObject ($filter_value="", ilDclBaseFieldModel $sort_field=null)

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

isMulti ()

storePropertiesFromForm (ilPropertyFormGUI $form)

called when saving the 'edit field' form More...

fillPropertiesForm (ilPropertyFormGUI &$form)

setProperty ($key, $value)

reorderExistingValues ()

sorts record field values by the new order More...

getProperty ($key)

getRecordQuerySortObject ($direction="asc", $sort_by_status=false)

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

Parameters

ilPropertyFormGUI $form

Returns: bool

More...

getConfirmationGUI (ilPropertyFormGUI $form)

called by ilDclFieldEditGUI if isConfirmationRequired returns true

Parameters

ilPropertyFormGUI $form

Returns: ilConfirmationGUI

More...

Public Member Functions inherited from ilDclBaseFieldModel

__construct ($a_id=0)

setId ($a_id)

Set field id. More...

getId ()

Get field id. More...

setTableId ($a_id)

Set table id. More...

getTableId ()

Get table id. More...

setTitle ($a_title)

Set title. More...

getTitle ()

Get title. More...

setDescription ($a_desc)

Set description. More...

getDescription ()

Get description. More...

setDatatypeId ($a_id)

Set datatype id. More...

getDatatypeId ()

Get datatype_id. More...

setRequired ($a_required)

Set Required. More...

getRequired ()

Get Required Required. More...

isUnique ()

setUnique ($unique)

getDatatype ()

getDatatypeTitle ()

getStorageLocation ()

Get storage location for the model. More...

getExportable ()

toArray ()

isStandardField ()

doRead ()

Read field. More...

buildFromDBRecord ($rec)

Builds model from db record. More...

doCreate ()

Create new field. More...

doUpdate ()

Update field. More...

updateProperties ()

Update properties of this field in Database. More...

doDelete ()

Remove field and properties. More...

getFieldSettings ()

getOrder ()

setOrder ($order)

hasProperty ($key)

Checks if a certain property for a field is set. More...

getProperty ($key)

Returns a certain property of a field. More...

getPropertyInstance ($key)

Return ActiveRecord of property. More...

setProperty ($key, $value)

Set a property for a field (does not save) More...

getValidFieldProperties ()

Returns all valid properties for a field-type. More...

setLocked ($locked)

getLocked ()

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

checkValidity ($value, $record_id=null)

Check if input is valid. More...

cloneStructure ($original_id)

afterClone ($records)

cloneProperties (ilDclBaseFieldModel $originalField)

setExportable ($exportable)

allowFilterInListView ()

getRecordQuerySortObject ($direction="asc", $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 ($storage_location_override)

fillHeaderExcel (ilExcel $worksheet, &$row, &$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"

const	PROP_SUPPORTED_FILE_TYPES = "supported_file_types"

const	PROP_PLUGIN_HOOK_NAME = "plugin_hook_name"

const	PROP_TEXT_SELECTION_OPTIONS = "text_selection_options"

const	PROP_TEXT_SELECTION_TYPE = "text_selection_type"

const	PROP_DATE_SELECTION_OPTIONS = "date_selection_options"

const	PROP_DATE_SELECTION_TYPE = "date_selection_type"

const	EDIT_VIEW = 2

const	EXPORTABLE_VIEW = 4

Protected Member Functions
	multiPropertyChanged ($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 ($a_as_regex=true)
	All valid chars for filed titles. More...

static	_getFieldIdByTitle ($title, $table_id)

Protected Attributes inherited from ilDclBaseFieldModel
	$id

	$table_id

	$title

	$description

	$datatypeId

	$required

	$order

	$unique

	$locked

	$property = array()

	$exportable

	$datatype

	$storage_location_override = null

Detailed Description

Class ilDclSelectionFieldModel.

Author: Theodor Truffer tt@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

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

Member Function Documentation

◆ cloneProperties()

ilDclSelectionFieldModel::cloneProperties ( ilDclBaseFieldModel $originalField )

Parameters

ilDclBaseFieldModel $originalField

Reimplemented from ilDclBaseFieldModel.

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

    {
        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 PHPMailer\PHPMailer\$options, ilDclSelectionOption\getAllForField(), and ilDclBaseFieldModel\getId().

Here is the call graph for this function:

◆ doDelete()

ilDclSelectionFieldModel::doDelete ( )

Remove field and properties.

Reimplemented from ilDclBaseFieldModel.

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

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

References ilDclSelectionOption\getAllForField(), and ilDclBaseFieldModel\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 106 of file class.ilDclSelectionFieldModel.php.

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

References $form, PHPMailer\PHPMailer\$options, $values, ilDclSelectionOption\getAllForField(), ilDclBaseFieldModel\getDatatypeId(), ilDclBaseFieldModel\getDescription(), ilDclBaseFieldModel\getId(), getProperty(), ilDclBaseFieldModel\getRequired(), ilDclBaseFieldModel\getTableId(), ilDclBaseFieldModel\getTitle(), getValidFieldProperties(), and ilDclBaseFieldModel\isUnique().

Here is the call graph for this function:

◆ getConfirmationGUI()

ilDclSelectionFieldModel::getConfirmationGUI ( ilPropertyFormGUI $form )

called by ilDclFieldEditGUI if isConfirmationRequired returns true

Parameters

ilPropertyFormGUI $form

Returns: ilConfirmationGUI

Reimplemented from ilDclBaseFieldModel.

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

    {
        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, $form, $key, and ilDclFieldFactory\getFieldRepresentationInstance().

Here is the call graph for this function:

◆ getProperty()

ilDclSelectionFieldModel::getProperty ( $key )

Parameters

$key

Returns: ilDclSelectionOption[]|null

Reimplemented from ilDclBaseFieldModel.

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

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

References $key, ilDclSelectionOption\getAllForField(), and ilDclBaseFieldModel\getId().

Referenced by fillPropertiesForm(), isMulti(), and setProperty().

Here is the call graph for this function:

Here is the caller 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 $filter_value

Returns: null|ilDclRecordQueryObject

Reimplemented from ilDclBaseFieldModel.

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

    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
 
        $join_str
            = " INNER 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') . ") ";
 
        if ($this->isMulti()) {
            $join_str .= " INNER 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 AND (" .
                "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 {
            $join_str .= " INNER 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 AND filter_stloc_{$this->getId()}.value = "
                . $ilDB->quote($filter_value, 'integer') . ") ";
        }
 
        $sql_obj = new ilDclRecordQueryObject();
        $sql_obj->setJoinStatement($join_str);
 
        return $sql_obj;
    }

References $DIC, $ilDB, ilDclBaseFieldModel\getId(), and isMulti().

Here is the call graph for this function:

◆ getRecordQuerySortObject()

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

Parameters

string	$direction
bool	$sort_by_status

Returns: ilDclRecordQueryObject

Reimplemented from ilDclBaseFieldModel.

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

    {
        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) ";
        //if ($this->isMulti()) {
        //      $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->'$[0]' AND sel_opts_{$this->getId()}.field_id = " . $ilDB->quote($this->getId(), 'integer') . ") ";
        //} else {
        $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}");
 
        return $sql_obj;
    }

References $DIC, $ilDB, ilDclBaseFieldModel\getId(), and isMulti().

Here is the call graph for this function:

◆ getValidFieldProperties()

ilDclSelectionFieldModel::getValidFieldProperties ( )

@inheritDoc

Reimplemented from ilDclBaseFieldModel.

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

    {
        return array(static::PROP_SELECTION_OPTIONS, static::PROP_SELECTION_TYPE);
    }

Referenced by fillPropertiesForm(), and storePropertiesFromForm().

Here is the caller graph for this function:

◆ isConfirmationRequired()

ilDclSelectionFieldModel::isConfirmationRequired ( ilPropertyFormGUI $form )

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

Parameters

ilPropertyFormGUI $form

Returns: bool

Reimplemented from ilDclBaseFieldModel.

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

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

References $form, isMulti(), and SELECTION_TYPE_MULTI.

Here is the call graph for this function:

◆ isMulti()

ilDclSelectionFieldModel::isMulti ( )

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

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

References getProperty().

Referenced by getRecordQueryFilterObject(), getRecordQuerySortObject(), isConfirmationRequired(), and setProperty().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ multiPropertyChanged()

ilDclSelectionFieldModel::multiPropertyChanged ( $is_multi_now )

protected

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

Parameters

$is_multi_now

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

    {
        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(array($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 ilDclBaseFieldModel\getId(), ilDclCache\getTableCache(), and ilDclBaseFieldModel\getTableId().

Referenced by setProperty().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ reorderExistingValues()

ilDclSelectionFieldModel::reorderExistingValues ( )

sorts record field values by the new order

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

    {
        $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 = 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 PHPMailer\PHPMailer\$options, ilDclSelectionOption\getAllForField(), ilDclBaseFieldModel\getId(), ilDclCache\getTableCache(), and ilDclBaseFieldModel\getTableId().

Referenced by setProperty().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setProperty()

ilDclSelectionFieldModel::setProperty	(	$key,
		$value
	)

Parameters

$key
$value

Reimplemented from ilDclBaseFieldModel.

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

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

References ilDclBaseFieldModel\$id, $key, ilDclSelectionOption\flushOptions(), ilDclBaseFieldModel\getId(), getProperty(), isMulti(), multiPropertyChanged(), reorderExistingValues(), and SELECTION_TYPE_MULTI.

Referenced by storePropertiesFromForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ storePropertiesFromForm()

ilDclSelectionFieldModel::storePropertiesFromForm ( ilPropertyFormGUI $form )

called when saving the 'edit field' form

Parameters

ilPropertyFormGUI $form

Reimplemented from ilDclBaseFieldModel.

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

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