Inheritance diagram for ilDclBaseFieldModel:

Collaboration diagram for ilDclBaseFieldModel:

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

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

static	_getFieldIdByTitle ($title, $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"

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

Protected Attributes
	$id

	$table_id

	$title

	$description

	$datatypeId

	$required

	$order

	$unique

	$locked

	$property = array()

	$exportable

	$datatype

	$storage_location_override = null

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

Detailed Description

Class ilDclBaseFieldModel.

Author: Michael Herren mh@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch; Martin Studer ms@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch; Marcel Raimann mr@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch; Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch; Oskar Truffer ot@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

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

Constructor & Destructor Documentation

◆ __construct()

ilDclBaseFieldModel::__construct ( $a_id = 0 )

Parameters

int $a_id

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

References doRead().

     {
         if ($a_id != 0) {
             $this->id = $a_id;
             $this->doRead();
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ _getFieldIdByTitle()

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

static

Parameters

$title	Title of the field
$table_id	ID of table where the field belongs to

Returns: int

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

References $DIC, $id, $ilDB, $result, $table_id, and $title.

     {
         global $DIC;
         $ilDB = $DIC['ilDB'];
         $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 ( $a_as_regex = true )

static

All valid chars for filed titles.

Parameters

bool $a_as_regex

Returns: string

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

Referenced by ilDclFieldEditGUI\initForm().

     {
         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 479 of file class.ilDclBaseFieldModel.php.

References ilDclTableView\getAllForTableId().

Referenced by doCreate().

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

Parameters

$records

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

References $records, and ilDclCache\getRecordFieldCache().

Referenced by ilDclReferenceFieldModel\getFieldRef().

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

Returns: bool

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

     {
         return true;
     }

◆ buildFromDBRecord()

ilDclBaseFieldModel::buildFromDBRecord ( $rec )

Builds model from db record.

Parameters

$rec

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

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

     {
         $this->setId($rec["id"]);
         $this->setTableId($rec["table_id"]);
         $this->setTitle($rec["title"]);
         $this->setDescription($rec["description"]);
         $this->setDatatypeId($rec["datatype_id"]);
         $this->setRequired($rec["required"]);
         $this->setUnique($rec["is_unique"]);
         $this->setLocked($rec["is_locked"]);
     }

Here is the call graph for this function:

◆ checkFieldCreationInput()

ilDclBaseFieldModel::checkFieldCreationInput ( ilPropertyFormGUI $form )

Checks input of specific fields befor saving.

Parameters

ilPropertyFormGUI $form

Returns: boolean if checkInput was successful

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

     {
         return true;
     }

◆ checkTitlesForImport()

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

Parameters

array	$titles
array	$import_fields

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

References $title, getTitle(), and ilStr\isUtf8().

     {
         foreach ($titles as $k => $title) {
             if (!ilStr::isUtf8($title)) {
                 $title = utf8_encode($title);
             }
             if ($title == $this->getTitle()) {
                 $import_fields[$k] = $this;
             }
         }
     }

Here is the call graph for this function:

◆ checkValidity()

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

Check if input is valid.

Parameters

	$value
null	$record_id

Returns: bool

Exceptions

ilDclInputException

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

References $table, ilDclCache\getTableCache(), getTableId(), isUnique(), normalizeValue(), and ilDclInputException\UNIQUE_EXCEPTION.

Referenced by checkValidityFromForm().

     {
         //Don't check empty values
         if ($value == null) {
             return true;
         }
 
         if ($this->isUnique()) {
             $table = ilDclCache::getTableCache($this->getTableId());
             foreach ($table->getRecords() as $record) {
                 if ($this->normalizeValue($record->getRecordFieldValue($this->getId())) == $this->normalizeValue($value) &&
                     ($record->getId() != $record_id || $record_id == 0)) {
                     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,
			$record_id = `null`
	)

Parameters

ilPropertyFormGUI	$form
null	$record_id

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

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

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

Here is the call graph for this function:

◆ cloneProperties()

ilDclBaseFieldModel::cloneProperties ( ilDclBaseFieldModel $originalField )

Parameters

ilDclBaseFieldModel $originalField

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

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

Referenced by cloneStructure().

     {
         $orgProps = $originalField->getValidFieldProperties();
         if (count($orgProps) == 0) {
             return;
         }
         foreach ($orgProps as $prop_name) {
             $fieldprop_obj = new ilDclFieldProperty();
             $fieldprop_obj->setFieldId($this->getId());
             $fieldprop_obj->setName($prop_name);
 
             $value = $originalField->getProperty($prop_name);
 
             // If reference field, we must reset the referenced field, otherwise it will point to the old ID
             if ($originalField->getDatatypeId() == ilDclDatatype::INPUTFORMAT_REFERENCE && $prop_name == ilDclBaseFieldModel::PROP_REFERENCE) {
                 $value = null;
             }
 
             $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 ( $original_id )

Parameters

$original_id

Exceptions

ilException

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

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

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

Here is the call graph for this function:

◆ doCreate()

ilDclBaseFieldModel::doCreate ( )

Create new field.

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

References $DIC, $id, $ilDB, $query, ilDclTable\_tableExists(), addToTableViews(), getDatatypeId(), getDescription(), getId(), getLocked(), getRequired(), getTableId(), getTitle(), isUnique(), setId(), setLocked(), and updateTableFieldSetting().

Referenced by cloneStructure().

     {
         global $DIC;
         $ilDB = $DIC['ilDB'];
         $this->getLocked() == null ? $this->setLocked(false) : true;
 
         if (!ilDclTable::_tableExists($this->getTableId())) {
             throw new ilException("The field does not have a related table!");
         }
 
         $id = $ilDB->nextId("il_dcl_field");
         $this->setId($id);
         $query = "INSERT INTO il_dcl_field (" . "id" . ", table_id" . ", datatype_id" . ", title" . ", description" . ", required" . ", is_unique"
             . ", is_locked" . " ) VALUES (" . $ilDB->quote($this->getId(), "integer") . "," . $ilDB->quote($this->getTableId(), "integer") . ","
             . $ilDB->quote($this->getDatatypeId(), "integer") . "," . $ilDB->quote($this->getTitle(), "text") . ","
             . $ilDB->quote($this->getDescription(), "text") . "," . $ilDB->quote($this->getRequired(), "integer") . ","
             . $ilDB->quote($this->isUnique(), "integer") . "," . $ilDB->quote($this->getLocked() ? 1 : 0, "integer") . ")";
         $ilDB->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 561 of file class.ilDclBaseFieldModel.php.

References $DIC, $ilDB, $query, getFieldSettings(), getId(), ilDclTableFieldSetting\getInstance(), and getTableId().

     {
         global $DIC;
         $ilDB = $DIC['ilDB'];
 
         // delete tablefield setting.
         ilDclTableFieldSetting::getInstance($this->getTableId(), $this->getId())->delete();
 
         $query = "DELETE FROM il_dcl_field_prop WHERE field_id = " . $ilDB->quote($this->getId(), "text");
         $ilDB->manipulate($query);
 
         $query = "DELETE FROM il_dcl_field WHERE id = " . $ilDB->quote($this->getId(), "text");
         $ilDB->manipulate($query);
 
         foreach ($this->getFieldSettings() as $field_setting) {
             $field_setting->delete();
         }
     }

Here is the call graph for this function:

◆ doRead()

ilDclBaseFieldModel::doRead ( )

Read field.

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

References $DIC, $ilDB, $query, getId(), loadProperties(), loadTableFieldSetting(), setDatatypeId(), setDescription(), setLocked(), setRequired(), setTableId(), setTitle(), and setUnique().

Referenced by __construct().

     {
         global $DIC;
         $ilDB = $DIC['ilDB'];
 
         //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 = " . $ilDB->quote($this->getId(), "integer");
         $set = $ilDB->query($query);
         $rec = $ilDB->fetchAssoc($set);
 
         $this->setTableId($rec["table_id"]);
         $this->setTitle($rec["title"]);
         $this->setDescription($rec["description"]);
         $this->setDatatypeId($rec["datatype_id"]);
         $this->setRequired($rec["required"]);
         $this->setUnique($rec["is_unique"]);
         $this->setLocked($rec["is_locked"]);
         $this->loadProperties();
         $this->loadTableFieldSetting();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ doUpdate()

ilDclBaseFieldModel::doUpdate ( )

Update field.

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

References $DIC, $ilDB, array, getDatatypeId(), getDescription(), getId(), getLocked(), getRequired(), getTableId(), getTitle(), isUnique(), updateProperties(), and updateTableFieldSetting().

     {
         global $DIC;
         $ilDB = $DIC['ilDB'];
 
         $ilDB->update("il_dcl_field", array(
             "table_id" => array(
                 "integer",
                 $this->getTableId()
             ),
             "datatype_id" => array(
                 "text",
                 $this->getDatatypeId()
             ),
             "title" => array(
                 "text",
                 $this->getTitle()
             ),
             "description" => array(
                 "text",
                 $this->getDescription()
             ),
             "required" => array(
                 "integer",
                 $this->getRequired()
             ),
             "is_unique" => array(
                 "integer",
                 $this->isUnique()
             ),
             "is_locked" => array(
                 "integer",
                 $this->getLocked() ? 1 : 0
             ),
         ), array(
             "id" => array(
                 "integer",
                 $this->getId()
             )
         ));
         $this->updateTableFieldSetting();
         $this->updateProperties();
     }

Here is the call graph for this function:

◆ fillHeaderExcel()

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

Parameters

ilExcel	$worksheet
	$row
	$col

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

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

     {
         $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

Parameters

ilPropertyFormGUI $form

Returns: bool

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

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

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

Parameters

ilPropertyFormGUI $form

Returns: ilConfirmationGUI

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

References $DIC, ilFormGUI\getFormAction(), and ilPropertyFormGUI\getInput().

     {
         global $DIC;
         $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('required', $form->getInput('required'));
         $ilConfirmationGUI->addHiddenItem('unique', $form->getInput('unique'));
         $ilConfirmationGUI->setConfirm($DIC->language()->txt('dcl_update_field'), 'update');
         $ilConfirmationGUI->setCancel($DIC->language()->txt('cancel'), 'edit');
         return $ilConfirmationGUI;
     }

Here is the call graph for this function:

◆ getDatatype()

ilDclBaseFieldModel::getDatatype ( )

Returns: ilDclDatatype

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

References $datatype, and loadDatatype().

Referenced by ilDclFieldFactory\getClassPathByInstance(), and ilDclFieldFactory\getFieldTypeByInstance().

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

Returns: int

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

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

Referenced by cloneProperties(), doCreate(), doUpdate(), ilDclSelectionFieldModel\fillPropertiesForm(), fillPropertiesForm(), ilDclStandardField\getRecordQueryFilterObject(), and hasNumericSorting().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDatatypeTitle()

ilDclBaseFieldModel::getDatatypeTitle ( )

Returns: string

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

References loadDatatype().

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

Here is the call graph for this function:

◆ getDescription()

ilDclBaseFieldModel::getDescription ( )

Get description.

Returns: string

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

References $description.

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

     {
         return $this->description;
     }

Here is the caller graph for this function:

◆ getExportable()

ilDclBaseFieldModel::getExportable ( )

Returns: bool

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

References $exportable, and loadExportability().

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

Here is the call graph for this function:

◆ getFieldSettings()

ilDclBaseFieldModel::getFieldSettings ( )

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

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

Referenced by doDelete().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getId()

ilDclBaseFieldModel::getId ( )

Get field id.

Returns: int

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

References $id.

     {
         return $this->id;
     }

Here is the caller graph for this function:

◆ getLocked()

ilDclBaseFieldModel::getLocked ( )

Returns: boolean

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

References $locked.

Referenced by doCreate(), and doUpdate().

     {
         return $this->locked;
     }

Here is the caller graph for this function:

◆ getOrder()

ilDclBaseFieldModel::getOrder ( )

Returns: int

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

References $order, and loadTableFieldSetting().

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

Here is the call graph for this function:

◆ getProperty()

ilDclBaseFieldModel::getProperty ( $key )

Returns a certain property of a field.

Parameters

$key

Returns: null

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

References $key, and getPropertyInstance().

Referenced by ilDclTextFieldModel\checkRegexAndLength(), ilDclTextFieldModel\checkValidity(), ilDclTextFieldModel\checkValidityFromForm(), cloneProperties(), ilDclTextFieldModel\fillHeaderExcel(), fillPropertiesForm(), ilDclFieldFactory\getClassPathByInstance(), ilDclReferenceFieldModel\getFieldRef(), ilDclFieldFactory\getFieldTypeByInstance(), ilDclReferenceFieldModel\getRecordQueryFilterObject(), ilDclReferenceFieldModel\getRecordQuerySortObject(), and ilDclFileuploadFieldModel\getSupportedExtensions().

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

Return ActiveRecord of property.

Parameters

$key

Returns: null

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

References $key, hasProperty(), and loadProperties().

Referenced by getProperty(), ilDclSelectionFieldModel\storePropertiesFromForm(), and storePropertiesFromForm().

     {
         $this->loadProperties();
         if ($this->hasProperty($key)) {
             $value = $this->property[$key];
             return $value;
         }
         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	$filter_value
ilDclBaseFieldModel \| null	$sort_field

Returns: null|ilDclRecordQueryObject

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

     {
         return null;
     }

◆ getRecordQuerySortObject()

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

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

Parameters

string	$direction
boolean	$sort_by_status	The specific sort object is a status field

Returns: null|ilDclRecordQueryObject

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

References $DIC, $ilDB, and getId().

     {
         global $DIC;
         $ilDB = $DIC['ilDB'];
 
         $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 = "
             . $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)";
 
         $sql_obj->setSelectStatement($select_str);
         $sql_obj->setJoinStatement($join_str);
         $sql_obj->setOrderStatement("field_{$this->getId()} {$direction}");
 
         return $sql_obj;
     }

Here is the call graph for this function:

◆ getRequired()

ilDclBaseFieldModel::getRequired ( )

Get Required Required.

Returns: boolean

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

References $required.

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

     {
         return $this->required;
     }

Here is the caller graph for this function:

◆ getSortField()

ilDclBaseFieldModel::getSortField ( )

Returns the sort-field id.

Returns: string

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

References getTitle().

     {
         return $this->getTitle();
     }

Here is the call graph for this function:

◆ getStorageLocation()

ilDclBaseFieldModel::getStorageLocation ( )

Get storage location for the model.

Returns: int|null

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

References getStorageLocationOverride(), and loadDatatype().

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

Here is the call graph for this function:

◆ getStorageLocationOverride()

ilDclBaseFieldModel::getStorageLocationOverride ( )

Returns: int|null

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

References $storage_location_override.

Referenced by getStorageLocation().

     {
         return $this->storage_location_override;
     }

Here is the caller graph for this function:

◆ getTableId()

ilDclBaseFieldModel::getTableId ( )

Get table id.

Returns: int

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

References $table_id.

Referenced by ilDclStandardField\allowFilterInListView(), ilDclDatetimeFieldModel\checkValidity(), ilDclTextFieldModel\checkValidity(), ilDclFileuploadFieldModel\checkValidity(), checkValidity(), ilDclTextFieldModel\checkValidityOfURLField(), doCreate(), doDelete(), doUpdate(), ilDclSelectionFieldModel\fillPropertiesForm(), fillPropertiesForm(), loadTableFieldSetting(), ilDclSelectionFieldModel\multiPropertyChanged(), ilDclSelectionFieldModel\reorderExistingValues(), and updateTableFieldSetting().

     {
         return $this->table_id;
     }

Here is the caller graph for this function:

◆ getTitle()

ilDclBaseFieldModel::getTitle ( )

Get title.

Returns: string

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

References $title.

Referenced by ilDclTextFieldModel\checkTitlesForImport(), checkTitlesForImport(), doCreate(), doUpdate(), ilDclTextFieldModel\fillHeaderExcel(), fillHeaderExcel(), ilDclSelectionFieldModel\fillPropertiesForm(), fillPropertiesForm(), ilDclFieldFactory\getClassPathByInstance(), and getSortField().

     {
         return $this->title;
     }

Here is the caller graph for this function:

◆ getValidFieldProperties()

ilDclBaseFieldModel::getValidFieldProperties ( )

Returns all valid properties for a field-type.

Returns: array

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

References array.

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

     {
         return array();
     }

Here is the caller graph for this function:

◆ hasNumericSorting()

ilDclBaseFieldModel::hasNumericSorting ( )

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

Returns: bool

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

References getDatatypeId(), and ilDclDatatype\INPUTFORMAT_NUMBER.

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

Here is the call graph for this function:

◆ hasProperty()

ilDclBaseFieldModel::hasProperty ( $key )

Checks if a certain property for a field is set.

Parameters

$key

Returns: bool

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

References $key, and loadProperties().

Referenced by ilDclTextFieldModel\checkTitlesForImport(), ilDclFieldFactory\getClassPathByInstance(), ilDclFieldFactory\getFieldTypeByInstance(), getPropertyInstance(), ilDclReferenceFieldModel\getRecordQuerySortObject(), ilDclTextFieldModel\getRecordQuerySortObject(), and ilDclFileuploadFieldModel\getSupportedExtensions().

     {
         $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

Parameters

ilPropertyFormGUI $form

Returns: bool

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

     {
         return false;
     }

◆ isStandardField()

ilDclBaseFieldModel::isStandardField ( )

Returns: bool

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

Referenced by getDatatypeId().

     {
         return false;
     }

Here is the caller graph for this function:

◆ isUnique()

ilDclBaseFieldModel::isUnique ( )

Returns: bool

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

References $unique.

Referenced by ilDclDatetimeFieldModel\checkValidity(), ilDclTextFieldModel\checkValidity(), ilDclFileuploadFieldModel\checkValidity(), checkValidity(), ilDclTextFieldModel\checkValidityOfURLField(), doCreate(), doUpdate(), ilDclSelectionFieldModel\fillPropertiesForm(), and fillPropertiesForm().

     {
         return $this->unique;
     }

Here is the caller graph for this function:

◆ loadDatatype()

ilDclBaseFieldModel::loadDatatype ( )

protected

Load datatype for model.

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

References ilDclCache\getDatatype().

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

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

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 381 of file class.ilDclBaseFieldModel.php.

References loadTableFieldSetting().

Referenced by getExportable().

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

Returns: array

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

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

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

     {
         $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 359 of file class.ilDclBaseFieldModel.php.

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

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

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

protected

Parameters

$value

Returns: string

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

Referenced by ilDclTextFieldModel\checkValidity(), ilDclFileuploadFieldModel\checkValidity(), and checkValidity().

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

Here is the caller graph for this function:

◆ setDatatypeId()

ilDclBaseFieldModel::setDatatypeId ( $a_id )

Set datatype id.

Parameters

int $a_id

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

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

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

Here is the caller graph for this function:

◆ setDescription()

ilDclBaseFieldModel::setDescription ( $a_desc )

Set description.

Parameters

string $a_desc

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

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

     {
         $this->description = $a_desc;
     }

Here is the caller graph for this function:

◆ setExportable()

ilDclBaseFieldModel::setExportable ( $exportable )

Parameters

boolean $exportable

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

References $exportable.

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

     {
         $this->exportable = $exportable;
     }

Here is the caller graph for this function:

◆ setId()

ilDclBaseFieldModel::setId ( $a_id )

Set field id.

Parameters

int $a_id

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

Referenced by buildFromDBRecord(), and doCreate().

     {
         $this->id = $a_id;
     }

Here is the caller graph for this function:

◆ setLocked()

ilDclBaseFieldModel::setLocked ( $locked )

Parameters

boolean $locked

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

References $locked.

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

     {
         $this->locked = $locked;
     }

Here is the caller graph for this function:

◆ setOrder()

ilDclBaseFieldModel::setOrder ( $order )

Parameters

$order

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

References $order.

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

     {
         $this->order = $order;
     }

Here is the caller graph for this function:

◆ setProperty()

ilDclBaseFieldModel::setProperty	(	$key,
		$value
	)

Set a property for a field (does not save)

Parameters

$key
$value

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

References $key, $property, getId(), and loadProperties().

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

     {
         $this->loadProperties();
         if (isset($this->property[$key])) {
             $this->property[$key]->setValue($value);
         } else {
             $property = new ilDclFieldProperty();
             $property->setName($key);
             $property->setFieldId($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:

◆ setRequired()

ilDclBaseFieldModel::setRequired ( $a_required )

Set Required.

Parameters

boolean $a_required Required

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

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

     {
         $this->required = $a_required;
     }

Here is the caller graph for this function:

◆ setStorageLocationOverride()

ilDclBaseFieldModel::setStorageLocationOverride ( $storage_location_override )

Parameters

int | null $storage_location_override

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

References $storage_location_override.

     {
         $this->storage_location_override = $storage_location_override;
     }

◆ setTableId()

ilDclBaseFieldModel::setTableId ( $a_id )

Set table id.

Parameters

int $a_id

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

Referenced by buildFromDBRecord(), and doRead().

     {
         $this->table_id = $a_id;
     }

Here is the caller graph for this function:

◆ setTitle()

ilDclBaseFieldModel::setTitle ( $a_title )

Set title.

Parameters

string $a_title

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

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

     {
         //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 ( $unique )

Parameters

bool $unique

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

References $unique.

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

     {
         $this->unique = $unique ? 1 : 0;
     }

Here is the caller graph for this function:

◆ storePropertiesFromForm()

ilDclBaseFieldModel::storePropertiesFromForm ( ilPropertyFormGUI $form )

called when saving the 'edit field' form

Parameters

ilPropertyFormGUI $form

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

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

     {
         $field_props = $this->getValidFieldProperties();
         foreach ($field_props as $property) {
             $representation = ilDclFieldFactory::getFieldRepresentationInstance($this);
             $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 ( )

Returns: array

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

References array.

     {
         return (array) $this;
     }

◆ updateProperties()

ilDclBaseFieldModel::updateProperties ( )

Update properties of this field in Database.

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

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

     {
         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 550 of file class.ilDclBaseFieldModel.php.

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $datatype

ilDclBaseFieldModel::$datatype

protected

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

Referenced by ilDclStandardField\_getDatatypeForId(), and getDatatype().

◆ $datatypeId

ilDclBaseFieldModel::$datatypeId

protected

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

Referenced by getDatatypeId().

◆ $description

ilDclBaseFieldModel::$description

protected

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

Referenced by getDescription().

◆ $exportable

ilDclBaseFieldModel::$exportable

protected

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

Referenced by getExportable(), and setExportable().

◆ $id

ilDclBaseFieldModel::$id

protected

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

Referenced by ilDclStandardField\_getDatatypeForId(), _getFieldIdByTitle(), ilDclStandardField\_getImportableStandardFieldTitle(), ilDclStandardField\_getNonImportableStandardFieldTitles(), doCreate(), getId(), and ilDclSelectionFieldModel\setProperty().

◆ $locked

ilDclBaseFieldModel::$locked

protected

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

Referenced by getLocked(), and setLocked().

◆ $order

ilDclBaseFieldModel::$order

protected

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

Referenced by getOrder(), and setOrder().

◆ $property

ilDclBaseFieldModel::$property = array()

protected

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

Referenced by setProperty(), ilDclSelectionFieldModel\storePropertiesFromForm(), and storePropertiesFromForm().

◆ $required

ilDclBaseFieldModel::$required

protected

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

Referenced by getRequired().

◆ $storage_location_override

ilDclBaseFieldModel::$storage_location_override = null

protected

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

Referenced by getStorageLocationOverride(), and setStorageLocationOverride().

◆ $table_id

ilDclBaseFieldModel::$table_id

protected

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

Referenced by _getFieldIdByTitle(), ilDclStandardField\_getStandardFields(), and getTableId().

◆ $title

ilDclBaseFieldModel::$title

protected

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

Referenced by _getFieldIdByTitle(), ilDclTextFieldModel\checkTitlesForImport(), checkTitlesForImport(), ilDclFileuploadFieldModel\checkValidity(), and getTitle().

◆ $unique

ilDclBaseFieldModel::$unique

protected

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

Referenced by isUnique(), and setUnique().

◆ EDIT_VIEW

const ilDclBaseFieldModel::EDIT_VIEW = 2

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

◆ EXPORTABLE_VIEW

const ilDclBaseFieldModel::EXPORTABLE_VIEW = 4

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

◆ PROP_DATE_SELECTION_OPTIONS

const ilDclBaseFieldModel::PROP_DATE_SELECTION_OPTIONS = "date_selection_options"

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

◆ PROP_DATE_SELECTION_TYPE

const ilDclBaseFieldModel::PROP_DATE_SELECTION_TYPE = "date_selection_type"

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

◆ PROP_DISPLAY_COPY_LINK_ACTION_MENU

const ilDclBaseFieldModel::PROP_DISPLAY_COPY_LINK_ACTION_MENU = "display_action_menu"

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

Referenced by ilDclIliasReferenceFieldRepresentation\buildFieldCreationInput(), ilDclIliasReferenceRecordRepresentation\getHTML(), and ilDclIliasReferenceFieldModel\getValidFieldProperties().

◆ PROP_FORMULA_EXPRESSION

const ilDclBaseFieldModel::PROP_FORMULA_EXPRESSION = "expression"

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

Referenced by ilDclFormulaRecordFieldModel\__construct(), ilDclFormulaFieldRepresentation\buildFieldCreationInput(), and ilDclFormulaFieldModel\getValidFieldProperties().

◆ PROP_HEIGHT

const ilDclBaseFieldModel::PROP_HEIGHT = "height"

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

Referenced by ilDclMobFieldRepresentation\buildFieldCreationInput(), ilDclMobRecordRepresentation\getHTML(), ilDclMobFieldModel\getValidFieldProperties(), and ilDclMobRecordFieldModel\parseValue().

◆ PROP_ILIAS_REFERENCE_LINK

const ilDclBaseFieldModel::PROP_ILIAS_REFERENCE_LINK = "ILIAS_reference_link"

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

Referenced by ilDclIliasReferenceFieldRepresentation\buildFieldCreationInput(), ilDclIliasReferenceRecordRepresentation\getHTML(), ilDclIliasReferenceRecordRepresentation\getLinkHTML(), ilDclIliasReferenceRecordRepresentation\getSingleHTML(), and ilDclIliasReferenceFieldModel\getValidFieldProperties().

◆ PROP_LEARNING_PROGRESS

const ilDclBaseFieldModel::PROP_LEARNING_PROGRESS = "learning_progress"

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

Referenced by ilDclRecordListTableGUI\buildData(), ilDclIliasReferenceFieldRepresentation\buildFieldCreationInput(), and ilDclIliasReferenceFieldModel\getValidFieldProperties().

◆ PROP_LENGTH

const ilDclBaseFieldModel::PROP_LENGTH = "lenght"

General properties.

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

Referenced by ilDclTextFieldRepresentation\buildFieldCreationInput(), ilDclTextFieldModel\checkFieldCreationInput(), ilDclTextFieldModel\checkRegexAndLength(), ilDclTextFieldRepresentation\getInputField(), and ilDclTextFieldModel\getValidFieldProperties().

◆ PROP_LINK_DETAIL_PAGE_TEXT

const ilDclBaseFieldModel::PROP_LINK_DETAIL_PAGE_TEXT = "link_detail_page"

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

Referenced by ilDclMobFieldRepresentation\buildFieldCreationInput(), ilDclTextFieldRepresentation\buildFieldCreationInput(), ilDclTextRecordRepresentation\getHTML(), ilDclMobRecordRepresentation\getHTML(), ilDclMobFieldModel\getValidFieldProperties(), and ilDclTextFieldModel\getValidFieldProperties().

◆ PROP_N_REFERENCE

const ilDclBaseFieldModel::PROP_N_REFERENCE = "multiple_selection"

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

Referenced by ilDclReferenceFieldRepresentation\buildFieldCreationInput(), ilDclReferenceRecordFieldModel\getExportValue(), ilDclReferenceFieldRepresentation\getInputField(), ilDclReferenceFieldModel\getRecordQueryFilterObject(), ilDclReferenceFieldModel\getValidFieldProperties(), ilDclReferenceRecordFieldModel\getValueFromExcel(), ilDataCollectionDataSet\getXmlNamespace(), and ilDclReferenceFieldRepresentation\passThroughFilter().

◆ PROP_PLUGIN_HOOK_NAME

const ilDclBaseFieldModel::PROP_PLUGIN_HOOK_NAME = "plugin_hook_name"

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

Referenced by ilDclPluginFieldRepresentation\buildFieldCreationInput(), ilDclFieldFactory\getClassPathByInstance(), ilDclFieldFactory\getFieldTypeByInstance(), and ilDclPluginFieldModel\getValidFieldProperties().

◆ PROP_REFERENCE

const ilDclBaseFieldModel::PROP_REFERENCE = "table_id"

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

Referenced by ilDclReferenceFieldRepresentation\addFilterInputFieldToTable(), ilDclReferenceFieldRepresentation\buildFieldCreationInput(), cloneProperties(), ilDclReferenceRecordFieldModel\getExportValue(), ilDclReferenceFieldModel\getFieldRef(), ilDclReferenceRecordRepresentation\getHTML(), ilDclReferenceFieldRepresentation\getInputField(), ilDclReferenceRecordRepresentation\getLinkHTML(), ilDclReferenceRecordFieldModel\getReferenceFromValue(), ilDclReferenceFieldModel\getValidFieldProperties(), and ilDataCollectionDataSet\getXmlNamespace().

◆ PROP_REFERENCE_LINK

const ilDclBaseFieldModel::PROP_REFERENCE_LINK = "reference_link"

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

Referenced by ilDclReferenceFieldRepresentation\buildFieldCreationInput(), ilDclReferenceRecordRepresentation\getHTML(), and ilDclReferenceFieldModel\getValidFieldProperties().

◆ PROP_REGEX

const ilDclBaseFieldModel::PROP_REGEX = "regex"

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

Referenced by ilDclTextFieldRepresentation\buildFieldCreationInput(), ilDclTextInputGUI\checkInput(), ilDclTextFieldModel\checkRegexAndLength(), and ilDclTextFieldModel\getValidFieldProperties().

◆ PROP_SUPPORTED_FILE_TYPES

const ilDclBaseFieldModel::PROP_SUPPORTED_FILE_TYPES = "supported_file_types"

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

Referenced by ilDclFileuploadFieldRepresentation\buildFieldCreationInput(), ilDclFileuploadFieldModel\getSupportedExtensions(), and ilDclFileuploadFieldModel\getValidFieldProperties().

◆ PROP_TEXT_SELECTION_OPTIONS

const ilDclBaseFieldModel::PROP_TEXT_SELECTION_OPTIONS = "text_selection_options"

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

◆ PROP_TEXT_SELECTION_TYPE

const ilDclBaseFieldModel::PROP_TEXT_SELECTION_TYPE = "text_selection_type"

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

◆ PROP_TEXTAREA

const ilDclBaseFieldModel::PROP_TEXTAREA = "text_area"

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

Referenced by ilDclTextFieldRepresentation\buildFieldCreationInput(), ilDclTextFieldModel\checkFieldCreationInput(), ilDclTextRecordRepresentation\fillFormInput(), ilDclTextFieldRepresentation\getInputField(), ilDclTextFieldModel\getValidFieldProperties(), and ilDclTextRecordFieldModel\parseValue().

◆ PROP_URL

const ilDclBaseFieldModel::PROP_URL = "url"

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

Referenced by ilDclTextRecordFieldModel\addHiddenItemsToConfirmation(), ilDclTextFieldRepresentation\buildFieldCreationInput(), ilDclTextFieldModel\checkTitlesForImport(), ilDclTextFieldModel\checkValidity(), ilDclTextFieldModel\checkValidityFromForm(), ilDclTextRecordFieldModel\fillExcelExport(), ilDclTextRecordRepresentation\fillFormInput(), ilDclTextFieldModel\fillHeaderExcel(), ilDclTextRecordFieldModel\getExportValue(), ilDclTextRecordRepresentation\getHTML(), ilDclReferenceFieldRepresentation\getInputField(), ilDclTextFieldRepresentation\getInputField(), ilDclTextFieldModel\getRecordQuerySortObject(), ilDclTextFieldModel\getValidFieldProperties(), ilDclTextRecordFieldModel\getValueFromExcel(), ilDclTextRecordFieldModel\parseSortingValue(), ilDclTextRecordFieldModel\parseValue(), and ilDclTextRecordFieldModel\setValueFromForm().

◆ PROP_WIDTH

const ilDclBaseFieldModel::PROP_WIDTH = "width"

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

Referenced by ilDclMobFieldRepresentation\buildFieldCreationInput(), ilDclMobRecordRepresentation\getHTML(), ilDclMobFieldModel\getValidFieldProperties(), and ilDclMobRecordFieldModel\parseValue().

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

Modules/DataCollection/classes/Fields/Base/class.ilDclBaseFieldModel.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getFieldIdByTitle()

◆ _getTitleInvalidChars()

◆ addToTableViews()

◆ afterClone()

◆ allowFilterInListView()

◆ buildFromDBRecord()

◆ checkFieldCreationInput()

◆ checkTitlesForImport()

◆ checkValidity()

◆ checkValidityFromForm()

◆ cloneProperties()

◆ cloneStructure()

◆ doCreate()

◆ doDelete()

◆ doRead()

◆ doUpdate()

◆ fillHeaderExcel()

◆ fillPropertiesForm()

◆ getConfirmationGUI()

◆ getDatatype()

◆ getDatatypeId()

◆ getDatatypeTitle()

◆ getDescription()

◆ getExportable()

◆ getFieldSettings()

◆ getId()

◆ getLocked()

◆ getOrder()

◆ getProperty()

◆ getPropertyInstance()

◆ getRecordQueryFilterObject()

◆ getRecordQuerySortObject()

◆ getRequired()

◆ getSortField()

◆ getStorageLocation()

◆ getStorageLocationOverride()

◆ getTableId()

◆ getTitle()

◆ getValidFieldProperties()

◆ hasNumericSorting()

◆ hasProperty()

◆ isConfirmationRequired()

◆ isStandardField()

◆ isUnique()

◆ loadDatatype()

◆ loadExportability()

◆ loadProperties()

◆ loadTableFieldSetting()

◆ normalizeValue()

◆ setDatatypeId()

◆ setDescription()

◆ setExportable()

◆ setId()

◆ setLocked()

◆ setOrder()

◆ setProperty()

◆ setRequired()

◆ setStorageLocationOverride()

◆ setTableId()

◆ setTitle()

◆ setUnique()

◆ storePropertiesFromForm()

◆ toArray()

◆ updateProperties()

◆ updateTableFieldSetting()

Field Documentation

◆ $datatype

◆ $datatypeId

◆ $description

◆ $exportable