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)

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

Constructor & Destructor Documentation

◆ __construct()

ilDclBaseFieldModel::__construct ( $a_id = 0 )

Parameters

int $a_id

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

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

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

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

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

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

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

Referenced by ilDclFieldEditGUI\initForm().

Here is the caller graph for this function:

◆ addToTableViews()

ilDclBaseFieldModel::addToTableViews ( )

protected

create ilDclTableViewFieldSettings for this field in each tableview

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

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

References ilDclTableView\getAllForTableId().

Referenced by doCreate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ afterClone()

ilDclBaseFieldModel::afterClone ( $records )

Parameters

$records

Reimplemented in ilDclStandardField.

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

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

References $records, and ilDclCache\getRecordFieldCache().

Here is the call graph for this function:

◆ allowFilterInListView()

ilDclBaseFieldModel::allowFilterInListView ( )

Returns: bool

Reimplemented in ilDclStandardField, ilDclFileuploadFieldModel, ilDclFormulaFieldModel, ilDclMobFieldModel, ilDclPluginFieldModel, and ilDclReferenceFieldModel.

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

                                                {
                return true;
        }

◆ buildFromDBRecord()

ilDclBaseFieldModel::buildFromDBRecord ( $rec )

Builds model from db record.

Parameters

$rec

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

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

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

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

Reimplemented in ilDclTextFieldModel.

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

                                                                         {
                return true;
        }

◆ checkTitlesForImport()

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

Parameters

array	$titles
array	$import_fields

Reimplemented in ilDclTextFieldModel.

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

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

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

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

Reimplemented in ilDclDatetimeFieldModel, ilDclFileuploadFieldModel, ilDclNumberFieldModel, and ilDclTextFieldModel.

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

                                                                 {
                //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;
        }

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

Referenced by checkValidityFromForm().

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

Reimplemented in ilDclTextFieldModel.

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

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

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

Here is the call graph for this function:

◆ cloneProperties()

ilDclBaseFieldModel::cloneProperties ( ilDclBaseFieldModel $originalField )

Parameters

ilDclBaseFieldModel $originalField

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

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

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

Referenced by cloneStructure().

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

Reimplemented in ilDclStandardField.

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

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

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

Here is the call graph for this function:

◆ doCreate()

ilDclBaseFieldModel::doCreate ( )

Create new field.

Reimplemented in ilDclStandardField.

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

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

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

Referenced by cloneStructure().

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

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

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

Here is the call graph for this function:

◆ doRead()

ilDclBaseFieldModel::doRead ( )

Read field.

Reimplemented in ilDclStandardField.

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

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

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

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ doUpdate()

ilDclBaseFieldModel::doUpdate ( )

Update field.

Reimplemented in ilDclStandardField.

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

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

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

Here is the call graph for this function:

◆ fillHeaderExcel()

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

Parameters

ilExcel	$worksheet
	$row
	$col

Reimplemented in ilDclTextFieldModel.

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

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

References $row, $worksheet, and getTitle().

Here is the call graph for this function:

◆ getDatatype()

ilDclBaseFieldModel::getDatatype ( )

Returns: ilDclDatatype

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

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

References $datatype, and loadDatatype().

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

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

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDatatypeTitle()

ilDclBaseFieldModel::getDatatypeTitle ( )

Returns: string

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

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

References loadDatatype().

Here is the call graph for this function:

◆ getDescription()

ilDclBaseFieldModel::getDescription ( )

Get description.

Returns: string

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

                                         {
                return $this->description;
        }

References $description.

Referenced by doCreate(), and doUpdate().

Here is the caller graph for this function:

◆ getExportable()

ilDclBaseFieldModel::getExportable ( )

Returns: bool

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

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

References $exportable, and loadExportability().

Here is the call graph for this function:

◆ getFieldSettings()

ilDclBaseFieldModel::getFieldSettings ( )

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

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

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

Referenced by doDelete().

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

                                {
                return $this->id;
        }

References $id.

Referenced by ilDclTextFieldModel\checkValidity(), checkValidityFromForm(), ilDclTextFieldModel\checkValidityOfURLField(), cloneProperties(), cloneStructure(), doCreate(), doDelete(), doRead(), doUpdate(), ilDclFieldFactory\getClassPathByInstance(), getDatatypeId(), ilDclFieldFactory\getFieldModelInstanceByClass(), ilDclCache\getFieldRepresentation(), ilDclFieldFactory\getFieldRepresentationInstance(), getFieldSettings(), ilDclFieldFactory\getFieldTypeByInstance(), ilDclFieldFactory\getRecordFieldInstance(), ilDclBooleanFieldModel\getRecordQueryFilterObject(), ilDclDatetimeFieldModel\getRecordQueryFilterObject(), ilDclFileuploadFieldModel\getRecordQueryFilterObject(), ilDclIliasReferenceFieldModel\getRecordQueryFilterObject(), ilDclNumberFieldModel\getRecordQueryFilterObject(), ilDclReferenceFieldModel\getRecordQueryFilterObject(), ilDclTextFieldModel\getRecordQueryFilterObject(), getRecordQuerySortObject(), ilDclStandardField\getRecordQuerySortObject(), ilDclFileuploadFieldModel\getRecordQuerySortObject(), ilDclIliasReferenceFieldModel\getRecordQuerySortObject(), ilDclReferenceFieldModel\getRecordQuerySortObject(), ilDclStandardField\getSortField(), ilDclStandardField\hasNumericSorting(), loadProperties(), loadTableFieldSetting(), setProperty(), and updateTableFieldSetting().

Here is the caller graph for this function:

◆ getLocked()

ilDclBaseFieldModel::getLocked ( )

Returns: boolean

Reimplemented in ilDclStandardField.

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

                                    {
                return $this->locked;
        }

References $locked.

Referenced by doCreate(), and doUpdate().

Here is the caller graph for this function:

◆ getOrder()

ilDclBaseFieldModel::getOrder ( )

Returns: int

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

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

References $order, and loadTableFieldSetting().

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

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

References getPropertyInstance().

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

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

                                                  {
                $this->loadProperties();
                if($this->hasProperty($key)) {
                        $value = $this->property[$key];
                        return $value;
                }
                return null;
        }

References hasProperty(), and loadProperties().

Referenced by getProperty().

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

Reimplemented in ilDclStandardField, ilDclBooleanFieldModel, ilDclDatetimeFieldModel, ilDclFileuploadFieldModel, ilDclIliasReferenceFieldModel, ilDclNumberFieldModel, ilDclRatingFieldModel, ilDclReferenceFieldModel, and ilDclTextFieldModel.

Definition at line 828 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

Reimplemented in ilDclStandardField, ilDclFileuploadFieldModel, ilDclFormulaFieldModel, ilDclIliasReferenceFieldModel, ilDclRatingFieldModel, ilDclReferenceFieldModel, and ilDclTextFieldModel.

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

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

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

Here is the call graph for this function:

◆ getRequired()

ilDclBaseFieldModel::getRequired ( )

Get Required Required.

Returns: boolean

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

                                      {
                return $this->required;
        }

References $required.

Referenced by doCreate(), and doUpdate().

Here is the caller graph for this function:

◆ getSortField()

ilDclBaseFieldModel::getSortField ( )

Returns the sort-field id.

Returns: string

Reimplemented in ilDclStandardField.

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

                                       {
                return $this->getTitle();
        }

References getTitle().

Here is the call graph for this function:

◆ getStorageLocation()

ilDclBaseFieldModel::getStorageLocation ( )

Get storage location for the model.

Returns: int|null

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

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

References getStorageLocationOverride(), and loadDatatype().

Here is the call graph for this function:

◆ getStorageLocationOverride()

ilDclBaseFieldModel::getStorageLocationOverride ( )

Returns: int|null

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

                                                     {
                return $this->storage_location_override;
        }

References $storage_location_override.

Referenced by getStorageLocation().

Here is the caller graph for this function:

◆ getTableId()

ilDclBaseFieldModel::getTableId ( )

Get table id.

Returns: int

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

                                     {
                return $this->table_id;
        }

References $table_id.

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

Here is the caller graph for this function:

◆ getTitle()

ilDclBaseFieldModel::getTitle ( )

Get title.

Returns: string

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

                                   {
                return $this->title;
        }

References $title.

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

Here is the caller graph for this function:

◆ getValidFieldProperties()

ilDclBaseFieldModel::getValidFieldProperties ( )

Returns all valid properties for a field-type.

Returns: array

Reimplemented in ilDclFileuploadFieldModel, ilDclFormulaFieldModel, ilDclIliasReferenceFieldModel, ilDclMobFieldModel, ilDclPluginFieldModel, ilDclReferenceFieldModel, and ilDclTextFieldModel.

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

                                                  {
                return array();
        }

Referenced by cloneProperties().

Here is the caller graph for this function:

◆ hasNumericSorting()

ilDclBaseFieldModel::hasNumericSorting ( )

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

Returns: bool

Reimplemented in ilDclStandardField, and ilDclNumberFieldModel.

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

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

References getDatatypeId(), and ilDclDatatype\INPUTFORMAT_NUMBER.

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

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

References loadProperties().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isStandardField()

ilDclBaseFieldModel::isStandardField ( )

Returns: bool

Reimplemented in ilDclStandardField.

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

                                          {
                return false;
        }

Referenced by getDatatypeId().

Here is the caller graph for this function:

◆ isUnique()

ilDclBaseFieldModel::isUnique ( )

Returns: bool

Reimplemented in ilDclStandardField.

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

                                   {
                return $this->unique;
        }

References $unique.

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

Here is the caller graph for this function:

◆ loadDatatype()

ilDclBaseFieldModel::loadDatatype ( )

protected

Load datatype for model.

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

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

References ilDclCache\getDatatype().

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

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

                                             {
                if ($this->exportable == NULL) {
                        $this->loadTableFieldSetting();
                }
        }

References loadTableFieldSetting().

Referenced by getExportable().

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

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ loadTableFieldSetting()

ilDclBaseFieldModel::loadTableFieldSetting ( )

protected

loadTableFieldSetting

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

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

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

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

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

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

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

Here is the caller graph for this function:

◆ setDatatypeId()

ilDclBaseFieldModel::setDatatypeId ( $a_id )

Set datatype id.

Parameters

int $a_id

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

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

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

Here is the caller graph for this function:

◆ setDescription()

ilDclBaseFieldModel::setDescription ( $a_desc )

Set description.

Parameters

string $a_desc

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

                                                {
                $this->description = $a_desc;
        }

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

Here is the caller graph for this function:

◆ setExportable()

ilDclBaseFieldModel::setExportable ( $exportable )

Parameters

boolean $exportable

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

                                                   {
                $this->exportable = $exportable;
        }

References $exportable.

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

Here is the caller graph for this function:

◆ setId()

ilDclBaseFieldModel::setId ( $a_id )

Set field id.

Parameters

int $a_id

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

                                     {
                $this->id = $a_id;
        }

Referenced by buildFromDBRecord(), and doCreate().

Here is the caller graph for this function:

◆ setLocked()

ilDclBaseFieldModel::setLocked ( $locked )

Parameters

boolean $locked

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

                                           {
                $this->locked = $locked;
        }

References $locked.

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

Here is the caller graph for this function:

◆ setOrder()

ilDclBaseFieldModel::setOrder ( $order )

Parameters

$order

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

                                         {
                $this->order = $order;
        }

References $order.

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

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

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

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

Here is the call graph for this function:

◆ setRequired()

ilDclBaseFieldModel::setRequired ( $a_required )

Set Required.

Parameters

boolean $a_required Required

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

                                                 {
                $this->required = $a_required;
        }

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

Here is the caller graph for this function:

◆ setStorageLocationOverride()

ilDclBaseFieldModel::setStorageLocationOverride ( $storage_location_override )

Parameters

int | null $storage_location_override

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

                                                                               {
                $this->storage_location_override = $storage_location_override;
        }

References $storage_location_override.

◆ setTableId()

ilDclBaseFieldModel::setTableId ( $a_id )

Set table id.

Parameters

int $a_id

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

                                          {
                $this->table_id = $a_id;
        }

Referenced by buildFromDBRecord(), and doRead().

Here is the caller graph for this function:

◆ setTitle()

ilDclBaseFieldModel::setTitle ( $a_title )

Set title.

Parameters

string $a_title

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

                                           {
                //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;
        }

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

Here is the caller graph for this function:

◆ setUnique()

ilDclBaseFieldModel::setUnique ( $unique )

Parameters

bool $unique

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

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

References $unique.

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

Here is the caller graph for this function:

◆ toArray()

ilDclBaseFieldModel::toArray ( )

Returns: array

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

                                  {
                return (array)$this;
        }

◆ updateProperties()

ilDclBaseFieldModel::updateProperties ( )

Update properties of this field in Database.

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

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

Referenced by doUpdate().

Here is the caller graph for this function:

◆ updateTableFieldSetting()

ilDclBaseFieldModel::updateTableFieldSetting ( )

protected

update exportable and fieldorder

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

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