Inheritance diagram for ilDclBaseFieldModel:

Collaboration diagram for ilDclBaseFieldModel:

Public Member Functions
	__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 (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=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...

Static Public Member Functions
static	_getTitleInvalidChars (bool $a_as_regex=true)
	All valid chars for filed titles. More...

static	_getFieldIdByTitle (string $title, int $table_id)

Data Fields
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
	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
string	$id = ""

int	$table_id = 0

string	$title = ""

string	$description = ""

int	$datatype_id = 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

Private Member Functions
	loadExportability ()
	Load exportability. More...

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilDclBaseFieldModel::__construct ( int $a_id = 0 )

Definition at line 65 of file class.ilDclBaseFieldModel.php.

References $DIC, doRead(), and ILIAS\Repository\lng().

     {
         global $DIC;
         $this->db = $DIC->database();
         $this->lng = $DIC->language();
 
         if ($a_id != 0) {
             $this->id = (string) $a_id;
             $this->doRead();
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ _getFieldIdByTitle()

static ilDclBaseFieldModel::_getFieldIdByTitle	(	string	$title,
		int	$table_id
	)

static

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

References $DIC, $id, and $ilDB.

                                                                            : int
     {
         global $DIC;
         $ilDB = $DIC->database();
 
         $result = $ilDB->query(
             'SELECT id FROM il_dcl_field WHERE title = ' . $ilDB->quote($title, 'text') . ' AND table_id = '
             . $ilDB->quote($table_id, 'integer')
         );
         $id = 0;
         while ($rec = $ilDB->fetchAssoc($result)) {
             $id = $rec['id'];
         }
 
         return $id;
     }

◆ _getTitleInvalidChars()

static ilDclBaseFieldModel::_getTitleInvalidChars ( bool $a_as_regex = true )

static

All valid chars for filed titles.

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

Referenced by ilDclFieldEditGUI\initForm().

                                                                          : string
     {
         if ($a_as_regex) {
             return '/^[^<>\\\\":]*$/i';
         } else {
             return '\ < > " :';
         }
     }

Here is the caller graph for this function:

◆ addToTableViews()

ilDclBaseFieldModel::addToTableViews ( )

protected

create ilDclTableViewFieldSettings for this field in each tableview

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

References ilDclTableView\getAllForTableId().

Referenced by doCreate().

                                         : void
     {
         foreach (ilDclTableView::getAllForTableId($this->table_id) as $tableview) {
             $tableview->createFieldSetting($this->id);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ afterClone()

ilDclBaseFieldModel::afterClone ( array $records )

Definition at line 594 of file class.ilDclBaseFieldModel.php.

References ilDclCache\getRecordFieldCache().

Referenced by ilDclReferenceFieldModel\getFieldRef(), and ilDclCopyFieldModel\getValidFieldProperties().

     {
         foreach ($records as $rec) {
             ilDclCache::getRecordFieldCache($rec, $this)->afterClone();
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ allowFilterInListView()

ilDclBaseFieldModel::allowFilterInListView ( )

Definition at line 636 of file class.ilDclBaseFieldModel.php.

                                            : bool
     {
         return true;
     }

◆ areEqual()

ilDclBaseFieldModel::areEqual	(	$value_1,
		$value_2
	)

protected

Definition at line 561 of file class.ilDclBaseFieldModel.php.

References normalizeValue().

Referenced by checkValidity().

                                                    : bool
     {
         return $this->normalizeValue($value_1) === $this->normalizeValue($value_2);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildFromDBRecord()

ilDclBaseFieldModel::buildFromDBRecord ( array $rec )

Builds model from db record.

Definition at line 322 of file class.ilDclBaseFieldModel.php.

References setDatatypeId(), setDescription(), setId(), setTableId(), setTitle(), and setUnique().

                                                  : void
     {
         $this->setId($rec["id"]);
         $this->setTableId($rec["table_id"]);
         $this->setTitle($rec["title"]);
         $this->setDescription($rec["description"]);
         $this->setDatatypeId($rec["datatype_id"]);
         $this->setUnique($rec["is_unique"] ?? null);
     }

Here is the call graph for this function:

◆ checkFieldCreationInput()

ilDclBaseFieldModel::checkFieldCreationInput ( ilPropertyFormGUI $form )

Checks input of specific fields befor saving.

Parameters

ilPropertyFormGUI $form

Returns: bool if checkInput was successful

Definition at line 700 of file class.ilDclBaseFieldModel.php.

                                                                     : bool
     {
         return true;
     }

◆ checkTitlesForImport()

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

Definition at line 727 of file class.ilDclBaseFieldModel.php.

References getTitle().

                                                                                : void
     {
         foreach ($titles as $k => $title) {
             if (!mb_detect_encoding($title, "UTF-8", true) == "UTF-8") {
                 $title = mb_convert_encoding($title, 'UTF-8', 'ISO-8859-1');
             }
             if ($title == $this->getTitle()) {
                 $import_fields[$k] = $this;
             }
         }
     }

Here is the call graph for this function:

◆ checkValidity()

ilDclBaseFieldModel::checkValidity	(		$value,
		?int	$record_id = `null`
	)

Check if input is valid.

Parameters

float | int | string | array | null $value

Exceptions

ilDclInputException

Definition at line 539 of file class.ilDclBaseFieldModel.php.

References areEqual(), ilDclCache\getTableCache(), getTableId(), isUnique(), and ilDclInputException\UNIQUE_EXCEPTION.

Referenced by checkValidityFromForm().

                                                                  : bool
     {
         //Don't check empty values
         if ($value == null) {
             return true;
         }
 
         if ($this->isUnique()) {
             $table = ilDclCache::getTableCache($this->getTableId());
             foreach ($table->getRecords() as $record) {
                 if ($record->getId() !== $record_id || $record_id === 0) {
                     if ($this->areEqual($record->getRecordFieldValue($this->getId()), $value)) {
                         throw new ilDclInputException(ilDclInputException::UNIQUE_EXCEPTION);
                     }
                 }
             }
 
         }
 
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkValidityFromForm()

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

Definition at line 528 of file class.ilDclBaseFieldModel.php.

References checkValidity(), getId(), and ilPropertyFormGUI\getInput().

                                                                                            : void
     {
         $value = $form->getInput('field_' . $this->getId());
         $this->checkValidity($value, $record_id);
     }

Here is the call graph for this function:

◆ cloneProperties()

ilDclBaseFieldModel::cloneProperties ( ilDclBaseFieldModel $originalField )

Definition at line 601 of file class.ilDclBaseFieldModel.php.

References getDatatypeId(), getId(), getProperty(), getValidFieldProperties(), ilDclDatatype\INPUTFORMAT_COPY, ilDclDatatype\INPUTFORMAT_REFERENCE, and PROP_REFERENCE.

Referenced by cloneStructure().

                                                                        : void
     {
         $orgProps = $originalField->getValidFieldProperties();
         if (count($orgProps) == 0) {
             return;
         }
         foreach ($orgProps as $prop_name) {
             $fieldprop_obj = new ilDclFieldProperty();
             $fieldprop_obj->setFieldId((int) $this->getId());
             $fieldprop_obj->setName($prop_name);
 
             $value = $originalField->getProperty($prop_name);
 
             if (
                 $prop_name == ilDclBaseFieldModel::PROP_REFERENCE &&
                 (
                     $originalField->getDatatypeId() == ilDclDatatype::INPUTFORMAT_REFERENCE ||
                     $originalField->getDatatypeId() == ilDclDatatype::INPUTFORMAT_COPY
                 )
             ) {
                 $value = null;
             }
 
             if ($value) {
                 $fieldprop_obj->setValue($value);
                 $fieldprop_obj->create();
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cloneStructure()

ilDclBaseFieldModel::cloneStructure ( int $original_id )

Exceptions

ilException

Definition at line 578 of file class.ilDclBaseFieldModel.php.

References cloneProperties(), doCreate(), ilDclCache\getFieldCache(), getId(), ilDclCache\setCloneOf(), setDatatypeId(), setDescription(), setExportable(), setOrder(), setTitle(), setUnique(), and ilDclCache\TYPE_FIELD.

                                                     : void
     {
         $original = ilDclCache::getFieldCache($original_id);
         $this->setTitle($original->getTitle());
         $this->setDatatypeId($original->getDatatypeId());
         $this->setDescription($original->getDescription());
         $this->setOrder($original->getOrder());
         $this->setUnique($original->isUnique());
         $this->setExportable($original->getExportable());
         $this->doCreate();
         $this->cloneProperties($original);
 
         // mandatory for all cloning functions
         ilDclCache::setCloneOf($original_id, (int) $this->getId(), ilDclCache::TYPE_FIELD);
     }

Here is the call graph for this function:

◆ doCreate()

ilDclBaseFieldModel::doCreate ( )

Definition at line 332 of file class.ilDclBaseFieldModel.php.

References ilDclTable\_tableExists(), addToTableViews(), getDatatypeId(), getDescription(), getId(), getTableId(), getTitle(), isUnique(), setId(), and updateTableFieldSetting().

Referenced by cloneStructure().

                               : void
     {
         if (!ilDclTable::_tableExists($this->getTableId())) {
             throw new ilException("The field does not have a related table!");
         }
 
         $id = $this->db->nextId("il_dcl_field");
         $this->setId($id);
         $query = "INSERT INTO il_dcl_field (" . "id" . ", table_id" . ", datatype_id" . ", title" . ", description" . ", is_unique"
             . " ) VALUES (" . $this->db->quote($this->getId(), "integer") . "," . $this->db->quote(
                 $this->getTableId(),
                 "integer"
             ) . ","
             . $this->db->quote($this->getDatatypeId(), "integer") . "," . $this->db->quote($this->getTitle(), "text") . ","
             . $this->db->quote($this->getDescription(), "text") . "," . $this->db->quote($this->isUnique(), "integer") . ")";
         $this->db->manipulate($query);
 
         $this->updateTableFieldSetting();
 
         $this->addToTableViews();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ doDelete()

ilDclBaseFieldModel::doDelete ( )

Remove field and properties.

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

References getId(), ilDclTableFieldSetting\getInstance(), getTableId(), and getViewSettings().

                               : void
     {
         // delete tablefield setting.
         ilDclTableFieldSetting::getInstance($this->getTableId(), $this->getId())->delete();
 
         $query = "DELETE FROM il_dcl_field_prop WHERE field_id = " . $this->db->quote($this->getId(), "text");
         $this->db->manipulate($query);
 
         $query = "DELETE FROM il_dcl_field WHERE id = " . $this->db->quote($this->getId(), "text");
         $this->db->manipulate($query);
 
         foreach ($this->getViewSettings() as $field_setting) {
             $field_setting->delete();
         }
     }

Here is the call graph for this function:

◆ doRead()

ilDclBaseFieldModel::doRead ( )

Definition at line 296 of file class.ilDclBaseFieldModel.php.

References getId(), loadProperties(), loadTableFieldSetting(), setDatatypeId(), setDescription(), setTableId(), setTitle(), and setUnique().

Referenced by __construct().

                             : void
     {
         //THEN 1 ELSE 0 END AS has_options FROM il_dcl_field f WHERE id = ".$ilDB->quote($this->getId(),"integer");
         $query = "SELECT * FROM il_dcl_field WHERE id = " . $this->db->quote($this->getId(), "integer");
         $set = $this->db->query($query);
         $rec = $this->db->fetchAssoc($set);
 
         if ($rec) {
             $this->setTableId($rec["table_id"]);
             if (null !== $rec["title"]) {
                 $this->setTitle($rec["title"]);
             }
             if (null !== $rec["description"]) {
                 $this->setDescription($rec["description"]);
             }
             $this->setDatatypeId($rec["datatype_id"]);
             $this->setUnique((bool) $rec["is_unique"]);
         }
 
         $this->loadProperties();
         $this->loadTableFieldSetting();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ doUpdate()

ilDclBaseFieldModel::doUpdate ( )

Definition at line 364 of file class.ilDclBaseFieldModel.php.

References getDatatypeId(), getDescription(), getId(), getTableId(), getTitle(), isUnique(), updateProperties(), and updateTableFieldSetting().

                               : void
     {
         $this->db->update(
             "il_dcl_field",
             [
                 "table_id" => [
                     "integer",
                     $this->getTableId(),
                 ],
                 "datatype_id" => [
                     "text",
                     $this->getDatatypeId(),
                 ],
                 "title" => [
                     "text",
                     $this->getTitle(),
                 ],
                 "description" => [
                     "text",
                     $this->getDescription(),
                 ],
                 "is_unique" => [
                     "integer",
                     $this->isUnique(),
                 ],
             ],
             [
                 "id" => [
                     "integer",
                     $this->getId(),
                 ],
             ]
         );
         $this->updateTableFieldSetting();
         $this->updateProperties();
     }

Here is the call graph for this function:

◆ fillHeaderExcel()

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

Definition at line 721 of file class.ilDclBaseFieldModel.php.

References getTitle(), and ilExcel\setCell().

                                                                              : void
     {
         $worksheet->setCell($row, $col, $this->getTitle());
         $col++;
     }

Here is the call graph for this function:

◆ fillPropertiesForm()

ilDclBaseFieldModel::fillPropertiesForm ( ilPropertyFormGUI & $form )

called to fill the 'edit field' form

Definition at line 760 of file class.ilDclBaseFieldModel.php.

References getDatatypeId(), getDescription(), getId(), getProperty(), getTableId(), getTitle(), getValidFieldProperties(), isUnique(), and ilPropertyFormGUI\setValuesByArray().

                                                                 : 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) {
             $values['prop_' . $prop] = $this->getProperty($prop);
         }
 
         $form->setValuesByArray($values);
 
         return true;
     }

Here is the call graph for this function:

◆ getConfirmationGUI()

ilDclBaseFieldModel::getConfirmationGUI ( ilPropertyFormGUI $form )

called by ilDclFieldEditGUI if isConfirmationRequired returns true

Definition at line 793 of file class.ilDclBaseFieldModel.php.

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

                                                                : ilConfirmationGUI
     {
         $ilConfirmationGUI = new ilConfirmationGUI();
         $ilConfirmationGUI->setFormAction($form->getFormAction());
         $ilConfirmationGUI->addHiddenItem('confirmed', "1");
         $ilConfirmationGUI->addHiddenItem('field_id', $form->getInput('field_id'));
         $ilConfirmationGUI->addHiddenItem('title', $form->getInput('title'));
         $ilConfirmationGUI->addHiddenItem('description', $form->getInput('description'));
         $ilConfirmationGUI->addHiddenItem('datatype', $form->getInput('datatype'));
         $ilConfirmationGUI->addHiddenItem('unique', $form->getInput('unique'));
         $ilConfirmationGUI->setConfirm($this->lng->txt('dcl_update_field'), 'update');
         $ilConfirmationGUI->setCancel($this->lng->txt('cancel'), 'edit');
 
         return $ilConfirmationGUI;
     }

Here is the call graph for this function:

◆ getDatatype()

ilDclBaseFieldModel::getDatatype ( )

Definition at line 207 of file class.ilDclBaseFieldModel.php.

References $datatype, and loadDatatype().

Referenced by ilDclFieldFactory\getClassPathByInstance(), ilDclFieldFactory\getFieldTypeByInstance(), ilDclPluginFieldModel\getPresentationDescription(), and ilDclPluginFieldModel\getPresentationTitle().

                                  : ilDclDatatype
     {
         $this->loadDatatype();
 
         return $this->datatype;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDatatypeId()

ilDclBaseFieldModel::getDatatypeId ( )

Get datatype_id.

Definition at line 188 of file class.ilDclBaseFieldModel.php.

References $datatype_id, ilDclStandardField\_getDatatypeForId(), getId(), and isStandardField().

Referenced by ilDclCopyFieldRepresentation\buildFieldCreationInput(), ilDclReferenceFieldRepresentation\buildFieldCreationInput(), ilDclContentImporter\checkImportType(), cloneProperties(), doCreate(), doUpdate(), fillPropertiesForm(), ilDclFieldListTableGUI\fillRowFromObject(), ilDclFieldFactory\getClassPathByInstance(), ilDclFieldFactory\getFieldModelInstanceByClass(), ilDclFieldFactory\getFieldTypeByInstance(), ilDclStandardField\getRecordQueryFilterObject(), and hasNumericSorting().

                                    : ?int
     {
         if ($this->isStandardField()) {
             return ilDclStandardField::_getDatatypeForId($this->getId());
         }
 
         return $this->datatype_id;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDatatypeTitle()

ilDclBaseFieldModel::getDatatypeTitle ( )

Definition at line 214 of file class.ilDclBaseFieldModel.php.

References loadDatatype().

Referenced by getPresentationDescription(), and getPresentationTitle().

                                       : string
     {
         $this->loadDatatype();
         return $this->datatype->getTitle();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDescription()

ilDclBaseFieldModel::getDescription ( )

Get description.

Definition at line 170 of file class.ilDclBaseFieldModel.php.

References $description.

Referenced by doCreate(), doUpdate(), fillPropertiesForm(), ilDclFieldListTableGUI\fillRowFromObject(), and ilDclBaseFieldRepresentation\setupInputField().

                                     : string
     {
         return $this->description;
     }

Here is the caller graph for this function:

◆ getExportable()

ilDclBaseFieldModel::getExportable ( )

Returns: bool

Definition at line 267 of file class.ilDclBaseFieldModel.php.

References $exportable, and loadExportability().

Referenced by ilDclStandardField\clone(), and ilDclFieldListTableGUI\fillRowFromObject().

                                    : bool
     {
         if (!isset($this->exportable)) {
             $this->loadExportability();
         }
 
         return $this->exportable;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getId()

ilDclBaseFieldModel::getId ( )

Get field id.

Definition at line 118 of file class.ilDclBaseFieldModel.php.

References $id.

                            : string
     {
         return $this->id;
     }

Here is the caller graph for this function:

◆ getOrder()

ilDclBaseFieldModel::getOrder ( )

Definition at line 454 of file class.ilDclBaseFieldModel.php.

References $order, and loadTableFieldSetting().

Referenced by ilDclStandardField\clone(), ilDclTable\compareOrder(), and updateTableFieldSetting().

                               : int
     {
         if ($this->order == null) {
             $this->loadTableFieldSetting();
         }
 
         return !$this->order ? 0 : $this->order;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPresentationDescription()

ilDclBaseFieldModel::getPresentationDescription ( )

Definition at line 225 of file class.ilDclBaseFieldModel.php.

References getDatatypeTitle(), and ILIAS\Repository\lng().

                                                 : string
     {
         return $this->lng->txt('dcl_' . $this->getDatatypeTitle() . '_desc');
     }

Here is the call graph for this function:

◆ getPresentationTitle()

ilDclBaseFieldModel::getPresentationTitle ( )

Definition at line 220 of file class.ilDclBaseFieldModel.php.

References getDatatypeTitle(), and ILIAS\Repository\lng().

Referenced by ilDclFieldListTableGUI\fillRowFromObject().

                                           : string
     {
         return $this->lng->txt('dcl_' . $this->getDatatypeTitle());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getProperty()

ilDclBaseFieldModel::getProperty ( string $key )

Definition at line 486 of file class.ilDclBaseFieldModel.php.

References getPropertyInstance().

Referenced by ilDclTextFieldModel\checkRegexAndLength(), ilDclTextFieldModel\checkValidityFromForm(), cloneProperties(), ilDclTextFieldModel\fillHeaderExcel(), fillPropertiesForm(), ilDclReferenceFieldModel\getFieldRef(), ilDclReferenceFieldModel\getRecordQueryFilterObject(), ilDclReferenceFieldModel\getRecordQuerySortObject(), and ilDclFileFieldModel\getSupportedExtensions().

                                             : mixed
     {
         $instance = $this->getPropertyInstance($key);
 
         return ($instance !== null) ? $instance->getValue() : null;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPropertyInstance()

ilDclBaseFieldModel::getPropertyInstance ( string $key )

Definition at line 493 of file class.ilDclBaseFieldModel.php.

References ILIAS\LTI\ToolProvider\$key, hasProperty(), and loadProperties().

Referenced by getProperty(), and storePropertiesFromForm().

                                                     : ?ilDclFieldProperty
     {
         $this->loadProperties();
         if ($this->hasProperty($key)) {
             return $this->property[$key];
         }
 
         return null;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRecordQueryFilterObject()

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

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

Parameters

string | int $filter_value

Definition at line 668 of file class.ilDclBaseFieldModel.php.

      : ?ilDclRecordQueryObject {
         return null;
     }

◆ getRecordQuerySortObject()

ilDclBaseFieldModel::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

Definition at line 645 of file class.ilDclBaseFieldModel.php.

References getId().

      : ?ilDclRecordQueryObject {
         $sql_obj = new ilDclRecordQueryObject();
 
         $select_str = "sort_stloc_{$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 = "
             . $this->db->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)";
 
         $sql_obj->setSelectStatement($select_str);
         $sql_obj->setJoinStatement($join_str);
         $sql_obj->setOrderStatement("field_{$this->getId()} $direction, ID ASC");
 
         return $sql_obj;
     }

Here is the call graph for this function:

◆ getSortField()

ilDclBaseFieldModel::getSortField ( )

Returns the sort-field id.

Definition at line 678 of file class.ilDclBaseFieldModel.php.

References getTitle().

                                   : string
     {
         return $this->getTitle();
     }

Here is the call graph for this function:

◆ getStorageLocation()

ilDclBaseFieldModel::getStorageLocation ( )

Get storage location for the model.

Definition at line 233 of file class.ilDclBaseFieldModel.php.

References getStorageLocationOverride(), and loadDatatype().

                                         : ?int
     {
         if ($this->getStorageLocationOverride() !== null) {
             return $this->getStorageLocationOverride();
         }
 
         $this->loadDatatype();
 
         return $this->datatype->getStorageLocation();
     }

Here is the call graph for this function:

◆ getStorageLocationOverride()

ilDclBaseFieldModel::getStorageLocationOverride ( )

Deprecated:

Definition at line 708 of file class.ilDclBaseFieldModel.php.

References $storage_location_override.

Referenced by getStorageLocation().

                                                 : ?int
     {
         return $this->storage_location_override;
     }

Here is the caller graph for this function:

◆ getTableId()

ilDclBaseFieldModel::getTableId ( )

Get table id.

Definition at line 134 of file class.ilDclBaseFieldModel.php.

References $table_id.

Referenced by ilDclStandardField\allowFilterInListView(), checkValidity(), doCreate(), doDelete(), doUpdate(), fillPropertiesForm(), ilDclReferenceFieldModel\getRecordQuerySortObject(), ilDclReferenceRecordFieldModel\getReferenceFromValue(), loadTableFieldSetting(), and updateTableFieldSetting().

                                 : int
     {
         return $this->table_id;
     }

Here is the caller graph for this function:

◆ getTitle()

ilDclBaseFieldModel::getTitle ( )

Get title.

Definition at line 154 of file class.ilDclBaseFieldModel.php.

References $title.

Referenced by ilDclCopyFieldRepresentation\buildFieldCreationInput(), ilDclReferenceFieldRepresentation\buildFieldCreationInput(), ilDclContentImporter\checkImportType(), ilDclTextFieldModel\checkTitlesForImport(), checkTitlesForImport(), doCreate(), doUpdate(), ilDclTextFieldModel\fillHeaderExcel(), fillHeaderExcel(), fillPropertiesForm(), ilDclFieldListTableGUI\fillRowFromObject(), ilDclPluginFieldModel\getPresentationDescription(), ilDclPluginFieldModel\getPresentationTitle(), ilDclStandardField\getSortField(), and getSortField().

                               : string
     {
         return $this->title;
     }

Here is the caller graph for this function:

◆ getValidFieldProperties()

ilDclBaseFieldModel::getValidFieldProperties ( )

Returns all valid properties for a field-type.

Definition at line 523 of file class.ilDclBaseFieldModel.php.

Referenced by cloneProperties(), fillPropertiesForm(), and storePropertiesFromForm().

Here is the caller graph for this function:

◆ getViewSetting()

ilDclBaseFieldModel::getViewSetting ( int $tableview_id )

Definition at line 449 of file class.ilDclBaseFieldModel.php.

References getId(), and ilDclTableViewFieldSetting\getTableViewFieldSetting().

                                                      : ilDclTableViewFieldSetting
     {
         return ilDclTableViewFieldSetting::getTableViewFieldSetting($this->getId(), $tableview_id);
     }

Here is the call graph for this function:

◆ getViewSettings()

ilDclBaseFieldModel::getViewSettings ( )

Returns: ilDclTableViewFieldSetting[]

Definition at line 444 of file class.ilDclBaseFieldModel.php.

References getId(), and ActiveRecord\where().

Referenced by doDelete().

                                      : array
     {
         return ilDclTableViewFieldSetting::where(['field' => $this->getId()])->get();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasNumericSorting()

ilDclBaseFieldModel::hasNumericSorting ( )

Set to true, when the sorting should be handled numerical.

Definition at line 686 of file class.ilDclBaseFieldModel.php.

References getDatatypeId(), and ilDclDatatype\INPUTFORMAT_NUMBER.

                                        : bool
     {
         if ($this->getDatatypeId() == ilDclDatatype::INPUTFORMAT_NUMBER) {
             return true;
         }
 
         return false;
     }

Here is the call graph for this function:

◆ hasProperty()

ilDclBaseFieldModel::hasProperty ( string $key )

Checks if a certain property for a field is set.

Definition at line 479 of file class.ilDclBaseFieldModel.php.

References ILIAS\UI\Implementation\Component\Input\getValue(), and loadProperties().

Referenced by ilDclTextFieldModel\checkTitlesForImport(), getPropertyInstance(), ilDclReferenceFieldModel\getRecordQuerySortObject(), and ilDclFileFieldModel\getSupportedExtensions().

                                             : bool
     {
         $this->loadProperties();
 
         return (isset($this->property[$key]) && $this->property[$key]->getValue() != null);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isConfirmationRequired()

ilDclBaseFieldModel::isConfirmationRequired ( ilPropertyFormGUI $form )

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

Definition at line 785 of file class.ilDclBaseFieldModel.php.

                                                                    : bool
     {
         return false;
     }

◆ isStandardField()

ilDclBaseFieldModel::isStandardField ( )

Definition at line 291 of file class.ilDclBaseFieldModel.php.

Referenced by ilDclFieldListTableGUI\fillRowFromObject(), and getDatatypeId().

                                      : bool
     {
         return false;
     }

Here is the caller graph for this function:

◆ isUnique()

ilDclBaseFieldModel::isUnique ( )

Definition at line 197 of file class.ilDclBaseFieldModel.php.

References $unique.

Referenced by checkValidity(), doCreate(), doUpdate(), fillPropertiesForm(), and ilDclFieldListTableGUI\fillRowFromObject().

                               : bool
     {
         return $this->unique;
     }

Here is the caller graph for this function:

◆ loadDatatype()

ilDclBaseFieldModel::loadDatatype ( )

protected

Load datatype for model.

Definition at line 247 of file class.ilDclBaseFieldModel.php.

References ilDclCache\getDatatype().

Referenced by getDatatype(), getDatatypeTitle(), and getStorageLocation().

                                      : void
     {
         if ($this->datatype == null) {
             $this->datatype = ilDclCache::getDatatype($this->datatype_id);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ loadExportability()

ilDclBaseFieldModel::loadExportability ( )

private

Load exportability.

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

References loadTableFieldSetting().

Referenced by getExportable().

                                         : void
     {
         if ($this->exportable == null) {
             $this->loadTableFieldSetting();
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ loadProperties()

ilDclBaseFieldModel::loadProperties ( )

protected

Get all properties of a field.

Definition at line 471 of file class.ilDclBaseFieldModel.php.

References ilDclCache\getFieldProperties(), and getId().

Referenced by doRead(), getPropertyInstance(), hasProperty(), and setProperty().

                                        : void
     {
         $this->property = ilDclCache::getFieldProperties($this->getId());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ loadTableFieldSetting()

ilDclBaseFieldModel::loadTableFieldSetting ( )

protected

loadTableFieldSetting

Definition at line 257 of file class.ilDclBaseFieldModel.php.

References getId(), ilDclTableFieldSetting\getInstance(), and getTableId().

Referenced by doRead(), getOrder(), and loadExportability().

                                               : void
     {
         $tablefield_setting = ilDclTableFieldSetting::getInstance($this->getTableId(), $this->getId());
         $this->exportable = $tablefield_setting->isExportable();
         $this->order = $tablefield_setting->getFieldOrder();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ normalizeValue()

ilDclBaseFieldModel::normalizeValue ( mixed $value )

protected

Definition at line 566 of file class.ilDclBaseFieldModel.php.

Referenced by areEqual().

     {
         if (is_string($value)) {
             $value = trim(preg_replace("/\\s+/uism", " ", $value));
         }
 
         return $value;
     }

Here is the caller graph for this function:

◆ setDatatypeId()

ilDclBaseFieldModel::setDatatypeId ( int $a_id )

Set datatype id.

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

Referenced by buildFromDBRecord(), cloneStructure(), and doRead().

                                             : void
     {
         //unset the cached datatype.
         $this->datatype = null;
         $this->datatype_id = $a_id;
     }

Here is the caller graph for this function:

◆ setDescription()

ilDclBaseFieldModel::setDescription ( string $a_desc )

Set description.

Definition at line 162 of file class.ilDclBaseFieldModel.php.

Referenced by buildFromDBRecord(), cloneStructure(), and doRead().

                                                   : void
     {
         $this->description = $a_desc;
     }

Here is the caller graph for this function:

◆ setExportable()

ilDclBaseFieldModel::setExportable ( bool $exportable )

Definition at line 631 of file class.ilDclBaseFieldModel.php.

References $exportable.

Referenced by ilDclStandardField\clone(), and cloneStructure().

                                                    : void
     {
         $this->exportable = $exportable;
     }

Here is the caller graph for this function:

◆ setId()

ilDclBaseFieldModel::setId ( $a_id )

Set field id.

Parameters

int|string

Definition at line 110 of file class.ilDclBaseFieldModel.php.

Referenced by buildFromDBRecord(), and doCreate().

                                 : void
     {
         $this->id = (string) $a_id;
     }

Here is the caller graph for this function:

◆ setOrder()

ilDclBaseFieldModel::setOrder ( int $order )

Definition at line 463 of file class.ilDclBaseFieldModel.php.

References $order.

Referenced by ilDclStandardField\clone(), and cloneStructure().

                                         : void
     {
         $this->order = $order;
     }

Here is the caller graph for this function:

◆ setProperty()

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

Definition at line 503 of file class.ilDclBaseFieldModel.php.

References ILIAS\LTI\ToolProvider\$key, $property, getId(), and loadProperties().

Referenced by ilDclReferenceFieldModel\getFieldRef(), ilDclCopyFieldModel\getValidFieldProperties(), and storePropertiesFromForm().

                                                     : ?ilDclFieldProperty
     {
         $this->loadProperties();
         if (isset($this->property[$key])) {
             $this->property[$key]->setValue($value);
         } else {
             $property = new ilDclFieldProperty();
             $property->setName($key);
             $property->setFieldId((int) $this->getId());
             $property->setValue($value);
 
             $this->property[$key] = $property;
         }
 
         return $this->property[$key];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setStorageLocationOverride()

ilDclBaseFieldModel::setStorageLocationOverride ( ?int $storage_location_override )

Deprecated:: override ilDclFieldTypePlugin::getStorageLocation() instead

Definition at line 716 of file class.ilDclBaseFieldModel.php.

References $storage_location_override.

                                                                                : void
     {
         $this->storage_location_override = $storage_location_override;
     }

◆ setTableId()

ilDclBaseFieldModel::setTableId ( int $a_id )

Set table id.

Definition at line 126 of file class.ilDclBaseFieldModel.php.

Referenced by buildFromDBRecord(), and doRead().

                                          : void
     {
         $this->table_id = $a_id;
     }

Here is the caller graph for this function:

◆ setTitle()

ilDclBaseFieldModel::setTitle ( string $a_title )

Set title.

Definition at line 142 of file class.ilDclBaseFieldModel.php.

Referenced by buildFromDBRecord(), cloneStructure(), and doRead().

                                              : void
     {
         //title cannot begin with _ as this is saved for other purposes. make __ instead.
         if (substr($a_title, 0, 1) == "_" && substr($a_title, 0, 2) != "__") {
             $a_title = "_" . $a_title;
         }
         $this->title = $a_title;
     }

Here is the caller graph for this function:

◆ setUnique()

ilDclBaseFieldModel::setUnique ( ?bool $unique )

Definition at line 202 of file class.ilDclBaseFieldModel.php.

Referenced by buildFromDBRecord(), ilDclStandardField\clone(), cloneStructure(), and doRead().

                                             : void
     {
         $this->unique = (bool) $unique;
     }

Here is the caller graph for this function:

◆ storePropertiesFromForm()

ilDclBaseFieldModel::storePropertiesFromForm ( ilPropertyFormGUI $form )

called when saving the 'edit field' form

Definition at line 742 of file class.ilDclBaseFieldModel.php.

References ilDclFieldFactory\getFieldRepresentationInstance(), ilPropertyFormGUI\getInput(), getPropertyInstance(), getValidFieldProperties(), and setProperty().

                                                                     : void
     {
         $field_props = $this->getValidFieldProperties();
         $representation = ilDclFieldFactory::getFieldRepresentationInstance($this);
 
         foreach ($field_props as $property) {
             $value = $form->getInput($representation->getPropertyInputFieldId($property));
 
             // 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)?->store();
             }
         }
     }

Here is the call graph for this function:

◆ toArray()

ilDclBaseFieldModel::toArray ( )

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

                              : array
     {
         return (array) $this;
     }

◆ updateProperties()

ilDclBaseFieldModel::updateProperties ( )

Update properties of this field in Database.

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

Referenced by doUpdate(), ilDclReferenceFieldModel\getFieldRef(), and ilDclCopyFieldModel\getValidFieldProperties().

                                       : void
     {
         foreach ($this->property as $prop) {
             $prop->store();
         }
     }

Here is the caller graph for this function:

◆ updateTableFieldSetting()

ilDclBaseFieldModel::updateTableFieldSetting ( )

protected

update exportable and fieldorder

Definition at line 414 of file class.ilDclBaseFieldModel.php.

References getId(), ilDclTableFieldSetting\getInstance(), getOrder(), and getTableId().

Referenced by doCreate(), ilDclStandardField\doUpdate(), and doUpdate().

                                                 : void
     {
         $tablefield_setting = ilDclTableFieldSetting::getInstance($this->getTableId(), $this->getId());
         $tablefield_setting->setExportable($this->exportable);
         $tablefield_setting->setFieldOrder($this->getOrder());
         $tablefield_setting->store();
     }