ilDclTextFieldModel Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilDclTextFieldModel:

Collaboration diagram for ilDclTextFieldModel:

Public Member Functions
	getRecordQueryFilterObject ( $filter_value="", ?ilDclBaseFieldModel $sort_field=null)
	getRecordQuerySortObject (string $direction="asc", bool $sort_by_status=false)
	Returns a query-object for building the record-loader-sql-query. More...
	checkValidityFromForm (ilPropertyFormGUI &$form, ?int $record_id=null)
	checkValidity ($value, ?int $record_id=null)
	checkFieldCreationInput (ilPropertyFormGUI $form)
	Checks input of specific fields befor saving. More...
	getValidFieldProperties ()
	@inheritDoc More...
	strlen (string $value, string $encoding='UTF-8')
	fillHeaderExcel (ilExcel $worksheet, int &$row, int &$col)
	checkTitlesForImport (array &$titles, array &$import_fields)
Public Member Functions inherited from ilDclBaseFieldModel
	__construct (int $a_id=0)
	setId ($a_id)
	Set field id. More...
	getId ()
	Get field id. More...
	setTableId (int $a_id)
	Set table id. More...
	getTableId ()
	Get table id. More...
	setTitle (string $a_title)
	Set title. More...
	getTitle ()
	Get title. More...
	setDescription (string $a_desc)
	Set description. More...
	getDescription ()
	Get description. More...
	setDatatypeId (int $a_id)
	Set datatype id. More...
	getDatatypeId ()
	Get datatype_id. More...
	isUnique ()
	setUnique (?bool $unique)
	getDatatype ()
	getDatatypeTitle ()
	getPresentationTitle ()
	getPresentationDescription ()
	getStorageLocation ()
	Get storage location for the model. More...
	getExportable ()
	toArray ()
	isStandardField ()
	doRead ()
	buildFromDBRecord (array $rec)
	Builds model from db record. More...
	doCreate ()
	doUpdate ()
	updateProperties ()
	Update properties of this field in Database. More...
	doDelete ()
	Remove field and properties. More...
	getViewSettings ()
	getViewSetting (int $tableview_id)
	getOrder ()
	setOrder (string $order)
	hasProperty (string $key)
	Checks if a certain property for a field is set. More...
	getProperty (string $key)
	Returns a certain property of a field. More...
	getPropertyInstance (string $key)
	Return ActiveRecord of property. More...
	setProperty (string $key, $value)
	Set a property for a field (does not save) More...
	getValidFieldProperties ()
	Returns all valid properties for a field-type. More...
	checkValidityFromForm (ilPropertyFormGUI &$form, ?int $record_id=null)
	checkValidity ($value, ?int $record_id=null)
	Check if input is valid. More...
	cloneStructure (int $original_id)
	afterClone (array $records)
	cloneProperties (ilDclBaseFieldModel $originalField)
	setExportable (bool $exportable)
	allowFilterInListView ()
	getRecordQuerySortObject (string $direction="asc", bool $sort_by_status=false)
	Returns a query-object for building the record-loader-sql-query. More...
	getRecordQueryFilterObject ( $filter_value="", ?ilDclBaseFieldModel $sort_field=null)
	Returns a query-object for building the record-loader-sql-query. More...
	getSortField ()
	Returns the sort-field id. More...
	hasNumericSorting ()
	Set to true, when the sorting should be handled numerical. More...
	checkFieldCreationInput (ilPropertyFormGUI $form)
	Checks input of specific fields befor saving. More...
	getStorageLocationOverride ()
	setStorageLocationOverride (?int $storage_location_override)
	fillHeaderExcel (ilExcel $worksheet, int &$row, int &$col)
	checkTitlesForImport (array &$titles, array &$import_fields)
	storePropertiesFromForm (ilPropertyFormGUI $form)
	called when saving the 'edit field' form More...
	fillPropertiesForm (ilPropertyFormGUI &$form)
	called to fill the 'edit field' form More...
	isConfirmationRequired (ilPropertyFormGUI $form)
	called by ilDclFieldEditGUI when updating field properties if you overwrite this method, remember to also overwrite getConfirmationGUI More...
	getConfirmationGUI (ilPropertyFormGUI $form)
	called by ilDclFieldEditGUI if isConfirmationRequired returns true More...

Protected Member Functions
	checkValidityOfURLField ($value, ?int $record_id)
	checkRegexAndLength (string $value)
Protected Member Functions inherited from ilDclBaseFieldModel
	loadDatatype ()
	Load datatype for model. More...
	loadTableFieldSetting ()
	loadTableFieldSetting More...
	addToTableViews ()
	create ilDclTableViewFieldSettings for this field in each tableview More...
	updateTableFieldSetting ()
	update exportable and fieldorder More...
	loadProperties ()
	Get all properties of a field. More...
	normalizeValue ($value)

Additional Inherited Members
Static Public Member Functions inherited from ilDclBaseFieldModel
static	_getTitleInvalidChars (bool $a_as_regex=true)
	All valid chars for filed titles. More...
static	_getFieldIdByTitle (string $title, int $table_id)
Data Fields inherited from ilDclBaseFieldModel
const	PROP_LENGTH = "lenght"
	General properties. More...
const	PROP_REGEX = "regex"
const	PROP_REFERENCE = "table_id"
const	PROP_URL = "url"
const	PROP_TEXTAREA = "text_area"
const	PROP_REFERENCE_LINK = "reference_link"
const	PROP_WIDTH = "width"
const	PROP_HEIGHT = "height"
const	PROP_LEARNING_PROGRESS = "learning_progress"
const	PROP_ILIAS_REFERENCE_LINK = "ILIAS_reference_link"
const	PROP_N_REFERENCE = "multiple_selection"
const	PROP_FORMULA_EXPRESSION = "expression"
const	PROP_DISPLAY_COPY_LINK_ACTION_MENU = "display_action_menu"
const	PROP_LINK_DETAIL_PAGE_TEXT = "link_detail_page_text"
const	PROP_LINK_DETAIL_PAGE_MOB = "link_detail_page_mob"
const	PROP_SUPPORTED_FILE_TYPES = "supported_file_types"
const	PROP_PLUGIN_HOOK_NAME = "plugin_hook_name"
const	EDIT_VIEW = 2
const	EXPORTABLE_VIEW = 4
Protected Attributes inherited from ilDclBaseFieldModel
string	$id = ""
int	$table_id = 0
string	$title = ""
string	$description = ""
int	$datatypeId = 0
int	$order = null
bool	$unique = false
array	$property = []
bool	$exportable = false
ilDclDatatype	$datatype = null
int	$storage_location_override = null
	With this property the datatype-storage-location can be overwritten. More...
ilDBInterface	$db
ilLanguage	$lng

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

Definition at line 19 of file class.ilDclTextFieldModel.php.

Member Function Documentation

checkFieldCreationInput()

ilDclTextFieldModel::checkFieldCreationInput

(

ilPropertyFormGUI

$form

)

Checks input of specific fields befor saving.

Parameters

ilPropertyFormGUI

$form

Returns

bool if checkInput was successful

Reimplemented from ilDclBaseFieldModel.

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

                                                                    : bool
    {
        $return = true;
        // Additional check for text fields: The length property should be max 200 if the textarea option is not set
        if ((int) $form->getInput('prop_' . ilDclBaseFieldModel::PROP_LENGTH) > 200 && !$form->getInput('prop_' . ilDclBaseFieldModel::PROP_TEXTAREA)) {
            $inputObj = $form->getItemByPostVar('prop_' . ilDclBaseFieldModel::PROP_LENGTH);
            $inputObj->setAlert($this->lng->txt("form_msg_value_too_high"));
            $return = false;
        }
 
        return $return;
    }

References ilPropertyFormGUI\getInput(), ilPropertyFormGUI\getItemByPostVar(), ILIAS\Repository\lng(), ilDclBaseFieldModel\PROP_LENGTH, and ilDclBaseFieldModel\PROP_TEXTAREA.

Here is the call graph for this function:

checkRegexAndLength()

ilDclTextFieldModel::checkRegexAndLength ( string  $value )

protected

Definition at line 172 of file class.ilDclTextFieldModel.php.

                                                         : void
    {
        $regex = $this->getProperty(ilDclBaseFieldModel::PROP_REGEX);
        if (substr($regex, 0, 1) != "/") {
            $regex = "/" . $regex;
        }
        if (substr($regex, -1) != "/") {
            $regex .= "/";
        }
 
        if ($this->getProperty(ilDclBaseFieldModel::PROP_LENGTH) < $this->strlen($value)
            && is_numeric($this->getProperty(ilDclBaseFieldModel::PROP_LENGTH))
        ) {
            throw new ilDclInputException(ilDclInputException::LENGTH_EXCEPTION);
        }
 
        if ($this->getProperty(ilDclBaseFieldModel::PROP_REGEX) != null) {
            try {
                $preg_match = preg_match($regex, $value);
            } catch (ErrorException $e) {
                throw new ilDclInputException(ilDclInputException::REGEX_CONFIG_EXCEPTION);
            }
 
            if ($preg_match == false) {
                throw new ilDclInputException(ilDclInputException::REGEX_EXCEPTION);
            }
        }
    }

References Vendor\Package\$e, ilDclInputException\LENGTH_EXCEPTION, ilDclBaseFieldModel\PROP_LENGTH, ilDclBaseFieldModel\PROP_REGEX, ilDclInputException\REGEX_CONFIG_EXCEPTION, and ilDclInputException\REGEX_EXCEPTION.

checkTitlesForImport()

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

Reimplemented from ilDclBaseFieldModel.

Definition at line 222 of file class.ilDclTextFieldModel.php.

                                                                               : void
    {
        foreach ($titles as $k => $title) {
            if (!ilStr::isUtf8($title)) {
                $title = utf8_encode($title);
            }
            if ($title == $this->getTitle()) {
                $import_fields[$k] = $this;
                if ($this->hasProperty(ilDclBaseFieldModel::PROP_URL) && $titles[$k + 1] == $this->getTitle() . '_title') {
                    unset($titles[$k + 1]);
                }
            }
        }
    }

References ilStr\isUtf8(), and ilDclBaseFieldModel\PROP_URL.

Here is the call graph for this function:

checkValidity()

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

Parameters

null | string

$value

Exceptions

ilDclInputException

Reimplemented from ilDclBaseFieldModel.

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

                                                                 : bool
    {
        $has_url_property = $this->getProperty(ilDclBaseFieldModel::PROP_URL);
        if ($has_url_property) {
            return $this->checkValidityOfURLField($value, $record_id);
        }
 
        // Don't check empty values
        if ($value === null) {
            return true;
        }
 
        $this->checkRegexAndLength($value);
 
        if ($this->isUnique()) {
            $table = ilDclCache::getTableCache($this->getTableId());
            foreach ($table->getRecords() as $record) {
                //for text it has to be case insensitive.
                $record_value = $record->getRecordFieldValue($this->getId());
 
                if (strtolower($this->normalizeValue($record_value)) == strtolower($this->normalizeValue($value))
                    && ($record->getId() != $record_id
                        || $record_id == 0)
                ) {
                    throw new ilDclInputException(ilDclInputException::UNIQUE_EXCEPTION);
                }
            }
        }
 
        return false;
    }

References ILIAS\Survey\Mode\getId(), ilDclCache\getTableCache(), ilDclBaseFieldModel\PROP_URL, and ilDclInputException\UNIQUE_EXCEPTION.

Here is the call graph for this function:

checkValidityFromForm()

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

Reimplemented from ilDclBaseFieldModel.

Definition at line 52 of file class.ilDclTextFieldModel.php.

                                                                                           : void
    {
        $has_url_property = $this->getProperty(ilDclBaseFieldModel::PROP_URL);
        if ($has_url_property) {
            $values = [
                'link' => $form->getInput("field_" . $this->getId()),
                'title' => $form->getInput("field_" . $this->getId() . "_title"),
            ];
            $this->checkValidityOfURLField($values, $record_id);
        } else {
            parent::checkValidityFromForm($form, $record_id);
        }
    }

References ILIAS\Survey\Mode\getId(), ilPropertyFormGUI\getInput(), and ilDclBaseFieldModel\PROP_URL.

Here is the call graph for this function:

checkValidityOfURLField()

ilDclTextFieldModel::checkValidityOfURLField (   $value, ?int  $record_id  )

protected

Parameters

null | string | array	$value
int	$record_id

Returns

bool

Exceptions

ilDclInputException

Definition at line 108 of file class.ilDclTextFieldModel.php.

                                                                       : bool
    {
        // TODO: value should always be an array with url fields, can we remove the check & json_decode?
        if (!is_array($value)) {
            $value = ['link' => $value, 'title' => ''];
        }
 
        //Don't check empty values
        if (!$value['link']) {
            return true;
        }
 
        $this->checkRegexAndLength($value['link']);
 
        //check url/email
        $link = (substr($value['link'], 0, 3) === 'www') ? 'https://' . $value['link'] : $value['link'];
        if (!filter_var($link, FILTER_VALIDATE_URL) && !filter_var($link, FILTER_VALIDATE_EMAIL) && $link != '') {
            throw new ilDclInputException(ilDclInputException::NOT_URL);
        }
 
        if ($this->isUnique()) {
            $table = ilDclCache::getTableCache($this->getTableId());
            foreach ($table->getRecords() as $record) {
                $record_value = $record->getRecordFieldValue($this->getId());
 
                if ($record_value == $value
                    && ($record->getId() != $record_id
                        || !$record_id)
                ) {
                    throw new ilDclInputException(ilDclInputException::UNIQUE_EXCEPTION);
                }
            }
        }
 
        return true;
    }

References ILIAS\Survey\Mode\getId(), ilDclCache\getTableCache(), ilDclInputException\NOT_URL, and ilDclInputException\UNIQUE_EXCEPTION.

Here is the call graph for this function:

fillHeaderExcel()

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

Reimplemented from ilDclBaseFieldModel.

Definition at line 213 of file class.ilDclTextFieldModel.php.

                                                                             : void
    {
        parent::fillHeaderExcel($worksheet, $row, $col);
        if ($this->getProperty(ilDclBaseFieldModel::PROP_URL)) {
            $worksheet->setCell($row, $col, $this->getTitle() . '_title');
            $col++;
        }
    }

References ilDclBaseFieldModel\PROP_URL, and ilExcel\setCell().

Here is the call graph for this function:

getRecordQueryFilterObject()

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

Parameters

string | int

$filter_value

Reimplemented from ilDclBaseFieldModel.

Definition at line 24 of file class.ilDclTextFieldModel.php.

     : ?ilDclRecordQueryObject {
        $join_str
            = "INNER JOIN il_dcl_record_field AS filter_record_field_{$this->getId()} ON (filter_record_field_{$this->getId()}.record_id = record.id AND filter_record_field_{$this->getId()}.field_id = "
            . $this->db->quote($this->getId(), 'integer') . ") ";
        $join_str .= "INNER JOIN il_dcl_stloc{$this->getStorageLocation()}_value AS filter_stloc_{$this->getId()} ON (filter_stloc_{$this->getId()}.record_field_id = filter_record_field_{$this->getId()}.id AND filter_stloc_{$this->getId()}.value LIKE "
            . $this->db->quote("%$filter_value%", 'text') . ") ";
 
        $sql_obj = new ilDclRecordQueryObject();
        $sql_obj->setJoinStatement($join_str);
 
        return $sql_obj;
    }

getRecordQuerySortObject()

ilDclTextFieldModel::getRecordQuerySortObject	(	string	$direction = "asc",
		bool	$sort_by_status = false
	)

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

Parameters

bool

$sort_by_status

The specific sort object is a status field

Reimplemented from ilDclBaseFieldModel.

Definition at line 40 of file class.ilDclTextFieldModel.php.

     : ilDclRecordQueryObject {
        // use custom record sorting for url-fields
        if ($this->hasProperty(ilDclBaseFieldModel::PROP_URL)) {
            return new ilDclTextRecordQueryObject();
        } else {
            return parent::getRecordQuerySortObject($direction, $sort_by_status);
        }
    }

getValidFieldProperties()

ilDclTextFieldModel::getValidFieldProperties

(

)

@inheritDoc

Reimplemented from ilDclBaseFieldModel.

Definition at line 161 of file class.ilDclTextFieldModel.php.

                                             : array
    {
        return [
            ilDclBaseFieldModel::PROP_LENGTH,
            ilDclBaseFieldModel::PROP_REGEX,
            ilDclBaseFieldModel::PROP_URL,
            ilDclBaseFieldModel::PROP_TEXTAREA,
            ilDclBaseFieldModel::PROP_LINK_DETAIL_PAGE_TEXT,
        ];
    }

References ilDclBaseFieldModel\PROP_LENGTH, ilDclBaseFieldModel\PROP_LINK_DETAIL_PAGE_TEXT, ilDclBaseFieldModel\PROP_REGEX, ilDclBaseFieldModel\PROP_TEXTAREA, and ilDclBaseFieldModel\PROP_URL.

strlen()

ilDclTextFieldModel::strlen	(	string	$value,
		string	$encoding = 'UTF-8'
	)

Definition at line 201 of file class.ilDclTextFieldModel.php.

                                                                     : int
    {
        switch (true) {
            case function_exists('mb_strlen'):
                return mb_strlen($value, $encoding);
            case function_exists('iconv_strlen'):
                return iconv_strlen($value, $encoding);
            default:
                return strlen($value);
        }
    }

---

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

• Modules/DataCollection/classes/Fields/Text/class.ilDclTextFieldModel.php