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 ()

	setProperty (string $key, $value)

	sanitizeOptionValue (string $value)

	personalizeOptionValue (string $value, ilObjUser $user)

	getProperty (string $key)

	cloneProperties (ilDclBaseFieldModel $originalField)

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

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

	checkValidity ($value, ?int $record_id)
	Check if input is valid. 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...

	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 (int $order)

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

	getProperty (string $key)

	getPropertyInstance (string $key)

	setProperty (string $key, $value)

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

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

	checkValidity ($value, ?int $record_id)
	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...

	checkUniqueProp (ilPropertyFormGUI $form)

	checkUnique ($value, ?int $record_id)

	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 string	SELECTION_TYPE_SINGLE = 'selection_type_single'

const string	SELECTION_TYPE_MULTI = 'selection_type_multi'

const string	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_REFERENCE_LINK = "reference_link"

const	PROP_UNIQUE = "unique"

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

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

	areEqual ($value_1, $value_2)

	normalizeValue (mixed $value)

Protected Attributes inherited from ilDclBaseFieldModel
string	$id = ""

int	$table_id = 0

string	$title = ""

string	$description = ""

int	$datatype_id = 0

int	$order = null

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

Definition at line 21 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 140 of file class.ilDclSelectionFieldModel.php.

                                                                    : bool
    {
        return $this->checkUniqueProp($form) && parent::checkFieldCreationInput($form);
    }

◆ checkValidity()

ilDclSelectionFieldModel::checkValidity	(		$value,
		?int	$record_id
	)

Check if input is valid.

Parameters

float | int | string | array | null $value

Exceptions

ilDclInputException

Reimplemented from ilDclBaseFieldModel.

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

                                                          : bool
    {
        $this->checkUnique($value, $record_id);
        return parent::checkValidity($value, $record_id);
    }

◆ cloneProperties()

ilDclSelectionFieldModel::cloneProperties ( ilDclBaseFieldModel $originalField )

Reimplemented from ilDclBaseFieldModel.

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

                                                                       : void
    {
        parent::cloneProperties($originalField);
        $options = ilDclSelectionOption::getAllForField((int) $originalField->getId());
        foreach ($options as $opt) {
            $new_opt = new ilDclSelectionOption();
            $new_opt->cloneOption($opt);
            $new_opt->setFieldId((int) $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 132 of file class.ilDclSelectionFieldModel.php.

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

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

Here is the call graph for this function:

◆ getProperty()

ilDclSelectionFieldModel::getProperty ( string $key )

Returns: ilDclSelectionOption[]|ilDclFieldProperty|null

Reimplemented from ilDclBaseFieldModel.

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

                                            : mixed
    {
        if ($key == $this::PROP_SELECTION_OPTIONS) {
            $prop_values = [];
            foreach (ilDclSelectionOption::getAllForField((int) $this->getId()) as $option) {
                $prop_values[$option->getOptId()] = $option->getValue();
            }
 
            return $prop_values;
        }
        return parent::getProperty($key);
    }

References 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 34 of file class.ilDclSelectionFieldModel.php.

     : ?ilDclRecordQueryObject {
 
        $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 = "
            . $this->db->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 = " . $this->db->quote("", 'text')
                . " OR filter_stloc_{$this->getId()}.value = " . $this->db->quote("[]", 'text')
                . ") ";
        } else {
            if ($this->isMulti()) {
                $where_str .= " (" .
                    "filter_stloc_{$this->getId()}.value LIKE " . $this->db->quote("%\"$filter_value\"%", 'text') .
                    ") ";
            } else {
                $where_str .= "filter_stloc_{$this->getId()}.value = "
                    . $this->db->quote($filter_value, 'integer');
            }
        }
 
        $join_str .= ") ";
 
        $sql_obj = new ilDclRecordQueryObject();
        $sql_obj->setJoinStatement($join_str);
        $sql_obj->setWhereStatement($where_str);
 
        return $sql_obj;
    }

◆ getValidFieldProperties()

ilDclSelectionFieldModel::getValidFieldProperties ( )

Returns all valid properties for a field-type.

Reimplemented from ilDclBaseFieldModel.

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

                                             : array
    {
        return [$this::PROP_SELECTION_OPTIONS, $this::PROP_SELECTION_TYPE, $this::PROP_UNIQUE];
    }

◆ isMulti()

ilDclSelectionFieldModel::isMulti ( )

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

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

◆ personalizeOptionValue()

ilDclSelectionFieldModel::personalizeOptionValue	(	string	$value,
		ilObjUser	$user
	)

Reimplemented in ilDclDateSelectionFieldModel, and ilDclDatetimeSelectionFieldModel.

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

                                                                          : string
    {
        return $value;
    }

◆ sanitizeOptionValue()

ilDclSelectionFieldModel::sanitizeOptionValue ( string $value )

Reimplemented in ilDclDatetimeSelectionFieldModel.

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

                                                      : string
    {
        return $value;
    }

◆ setProperty()

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

Parameters

array $value

Reimplemented from ilDclBaseFieldModel.

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

                                                    : ?ilDclFieldProperty
    {
        if ($key === $this::PROP_SELECTION_OPTIONS) {
            ilDclSelectionOption::flushOptions((int) $this->getId());
            $sorting = 1;
            foreach ($value as $id => $val) {
                ilDclSelectionOption::storeOption((int) $this->getId(), $id, $sorting, $this->sanitizeOptionValue($val));
                $sorting++;
            }
            return null;
        }
        return parent::setProperty($key, $value);
    }