Inheritance diagram for ilDclStandardField:

Collaboration diagram for ilDclStandardField:

Public Member Functions
	__construct ($a_id=0)

	doRead ()

	doCreate ()

	doUpdate ()

	clone (ilDclStandardField $original_record)

	getLocked ()

	isStandardField ()

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

	allowFilterInListView ()

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

	getValueFromExcel (ilExcel $excel, int $row, int $col)

	afterClone ($records)

Public Member Functions inherited from ilDclBaseFieldModel
	__construct (int $a_id=0)

	setId ($a_id)
	Set field id. More...

	getId ()
	Get field id. More...

	setTableId (int $a_id)
	Set table id. More...

	getTableId ()
	Get table id. More...

	setTitle (string $a_title)
	Set title. More...

	getTitle ()
	Get title. More...

	setDescription (string $a_desc)
	Set description. More...

	getDescription ()
	Get description. More...

	setDatatypeId (int $a_id)
	Set datatype id. More...

	getDatatypeId ()
	Get datatype_id. More...

	getDatatype ()

	getDatatypeTitle ()

	getPresentationTitle ()

	getPresentationDescription ()

	getStorageLocation ()
	Get storage location for the model. More...

	getExportable ()

	toArray ()

	isStandardField ()

	doRead ()

	buildFromDBRecord (array $rec)
	Builds model from db record. More...

	doCreate ()

	doUpdate ()

	updateProperties ()
	Update properties of this field in Database. More...

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

	getViewSettings ()

	getViewSetting (int $tableview_id)

	getOrder ()

	setOrder (int $order)

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

	getProperty (string $key)

	getPropertyInstance (string $key)

	setProperty (string $key, $value)

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

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

	checkValidity ($value, ?int $record_id)
	Check if input is valid. More...

	cloneStructure (int $original_id)

	afterClone (array $records)

	cloneProperties (ilDclBaseFieldModel $originalField)

	setExportable (bool $exportable)

	allowFilterInListView ()

	getRecordQuerySortObject (string $direction="asc", bool $sort_by_status=false)
	Returns a query-object for building the record-loader-sql-query. More...

	getRecordQueryFilterObject ( $filter_value="", ?ilDclBaseFieldModel $sort_field=null)
	Returns a query-object for building the record-loader-sql-query. More...

	getSortField ()
	Returns the sort-field id. More...

	hasNumericSorting ()
	Set to true, when the sorting should be handled numerical. More...

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

	checkUniqueProp (ilPropertyFormGUI $form)

	checkUnique ($value, ?int $record_id)

	getStorageLocationOverride ()

	setStorageLocationOverride (?int $storage_location_override)

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

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

	storePropertiesFromForm (ilPropertyFormGUI $form)
	called when saving the 'edit field' form More...

	fillPropertiesForm (ilPropertyFormGUI &$form)
	called to fill the 'edit field' form More...

	isConfirmationRequired (ilPropertyFormGUI $form)
	called by ilDclFieldEditGUI when updating field properties if you overwrite this method, remember to also overwrite getConfirmationGUI More...

	getConfirmationGUI (ilPropertyFormGUI $form)
	called by ilDclFieldEditGUI if isConfirmationRequired returns true More...

Static Public Member Functions
static	_getStandardFieldsAsArray ()

static	_getStandardFields (int $table_id)

static	_getNonImportableStandardFieldTitles ()

static	_getImportableStandardFieldTitle ()

static	_isStandardField ($field_id)

static	_getDatatypeForId (string $id)
	gives you the datatype id of a specified standard field. More...

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)

Private Attributes
ilGlobalTemplateInterface	$main_tpl

Additional Inherited Members
Data Fields inherited from ilDclBaseFieldModel
const	PROP_LENGTH = "lenght"
	General properties. More...

const	PROP_REGEX = "regex"

const	PROP_REFERENCE = "table_id"

const	PROP_URL = "url"

const	PROP_REFERENCE_LINK = "reference_link"

const	PROP_UNIQUE = "unique"

const	PROP_WIDTH = "width"

const	PROP_HEIGHT = "height"

const	PROP_LEARNING_PROGRESS = "learning_progress"

const	PROP_ILIAS_REFERENCE_LINK = "ILIAS_reference_link"

const	PROP_N_REFERENCE = "multiple_selection"

const	PROP_FORMULA_EXPRESSION = "expression"

const	PROP_DISPLAY_COPY_LINK_ACTION_MENU = "display_action_menu"

const	PROP_LINK_DETAIL_PAGE_TEXT = "link_detail_page_text"

const	PROP_LINK_DETAIL_PAGE_MOB = "link_detail_page_mob"

const	PROP_SUPPORTED_FILE_TYPES = "supported_file_types"

const	PROP_PLUGIN_HOOK_NAME = "plugin_hook_name"

const	EDIT_VIEW = 2

const	EXPORTABLE_VIEW = 4

Protected Member Functions inherited from ilDclBaseFieldModel
	loadDatatype ()
	Load datatype for model. More...

	loadTableFieldSetting ()
	loadTableFieldSetting More...

	addToTableViews ()
	create ilDclTableViewFieldSettings for this field in each tableview More...

	updateTableFieldSetting ()
	update exportable and fieldorder More...

	loadProperties ()
	Get all properties of a field. More...

	areEqual ($value_1, $value_2)

	normalizeValue (mixed $value)

Protected Attributes inherited from ilDclBaseFieldModel
string	$id = ""

int	$table_id = 0

string	$title = ""

string	$description = ""

int	$datatype_id = 0

int	$order = null

array	$property = []

bool	$exportable = false

ilDclDatatype	$datatype = null

int	$storage_location_override = null
	With this property the datatype-storage-location can be overwritten. More...

ilDBInterface	$db

ilLanguage	$lng

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilDclStandardField::__construct ( $a_id = 0 )

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

    {
        parent::__construct($a_id);
        global $DIC;
        $this->main_tpl = $DIC->ui()->mainTemplate();
    }

References $DIC, and ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

Member Function Documentation

◆ _getDatatypeForId()

static ilDclStandardField::_getDatatypeForId ( string $id )

static

gives you the datatype id of a specified standard field.

Parameters

string $id the id of the standardfield eg. "create_date"

Definition at line 204 of file class.ilDclStandardField.php.

                                                        : ?int
    {
        return self::_getStandardFieldsAsArray()[$id]['datatype_id'];
    }

References ilDclBaseFieldModel\$id, and _getStandardFieldsAsArray().

Referenced by ilDclBaseFieldModel\getDatatypeId(), and ilDclTableViewFieldSetting\getFieldObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getImportableStandardFieldTitle()

static ilDclStandardField::_getImportableStandardFieldTitle ( )

static

Returns: array all possible titles of importable (excel import) standardfields (atm exclusively owner), in all languages;

Definition at line 164 of file class.ilDclStandardField.php.

                                                             : array
    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
        $identifiers = '';
        $id = 'dcl_owner';
        $identifiers .= $ilDB->quote($id, 'text') . ',';
        $identifiers = rtrim($identifiers, ',');
        $sql = $ilDB->query(
            'SELECT value, identifier FROM lng_data WHERE identifier IN ('
            . $identifiers . ')'
        );
        $titles = [];
        while ($rec = $ilDB->fetchAssoc($sql)) {
            $titles[$rec['identifier']][] = $rec['value'];
        }
 
        return $titles;
    }

References $DIC, ilDclBaseFieldModel\$id, and $ilDB.

Referenced by ilDclContentImporter\getImportFieldsFromTitles().

Here is the caller graph for this function:

◆ _getNonImportableStandardFieldTitles()

static ilDclStandardField::_getNonImportableStandardFieldTitles ( )

static

Returns: array all possible titles of non-importable (excel import) standardfields (atm all except owner), in all languages;

Definition at line 131 of file class.ilDclStandardField.php.

                                                                 : array
    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
        $identifiers = '';
        foreach (
            [
                'dcl_id',
                'dcl_creation_date',
                'dcl_last_update',
                'dcl_last_edited_by',
                'dcl_comments',
            ] as $id
        ) {
            $identifiers .= $ilDB->quote($id, 'text') . ',';
        }
        $identifiers = rtrim($identifiers, ',');
        $sql = $ilDB->query(
            'SELECT value FROM lng_data WHERE identifier IN (' . $identifiers
            . ')'
        );
        $titles = [];
        while ($rec = $ilDB->fetchAssoc($sql)) {
            $titles[] = $rec['value'];
        }
 
        return $titles;
    }

References $DIC, ilDclBaseFieldModel\$id, and $ilDB.

Referenced by ilDclContentImporter\getImportFieldsFromTitles().

Here is the caller graph for this function:

◆ _getStandardFields()

static ilDclStandardField::_getStandardFields ( int $table_id )

static

Definition at line 114 of file class.ilDclStandardField.php.

                                                            : array
    {
        $stdFields = [];
        foreach (self::_getStandardFieldsAsArray() as $array) {
            $array["table_id"] = $table_id;
            $field = new ilDclStandardField();
            $field->buildFromDBRecord($array);
            $stdFields[] = $field;
        }
 
        return $stdFields;
    }

References ilDclBaseFieldModel\$table_id.

◆ _getStandardFieldsAsArray()

static ilDclStandardField::_getStandardFieldsAsArray ( )

static

Definition at line 68 of file class.ilDclStandardField.php.

                                                      : array
    {
 
        //TODO: this isn't particularly pretty especially as $lng is used in the model. On the long run the standard fields should be refactored into "normal" fields.
        global $DIC;
        $lng = $DIC->language();
        return [
            "id" => [
                "id" => "id",
                "title" => $lng->txt("dcl_id"),
                "description" => $lng->txt("dcl_id_description"),
                "datatype_id" => ilDclDatatype::INPUTFORMAT_NUMBER
            ],
            "create_date" => [
                "id" => "create_date",
                "title" => $lng->txt("dcl_creation_date"),
                "description" => $lng->txt("dcl_creation_date_description"),
                "datatype_id" => ilDclDatatype::INPUTFORMAT_DATETIME
            ],
            "last_update" => [
                "id" => "last_update",
                "title" => $lng->txt("dcl_last_update"),
                "description" => $lng->txt("dcl_last_update_description"),
                "datatype_id" => ilDclDatatype::INPUTFORMAT_DATETIME
            ],
            "owner" => [
                "id" => "owner",
                "title" => $lng->txt("dcl_owner"),
                "description" => $lng->txt("dcl_owner_description"),
                "datatype_id" => ilDclDatatype::INPUTFORMAT_TEXT
            ],
            "last_edit_by" => [
                "id" => "last_edit_by",
                "title" => $lng->txt("dcl_last_edited_by"),
                "description" => $lng->txt("dcl_last_edited_by_description"),
                "datatype_id" => ilDclDatatype::INPUTFORMAT_TEXT
            ],
            'comments' => [
                'id' => 'comments',
                'title' => $lng->txt('dcl_comments'),
                'description' => $lng->txt('dcl_comments_desc'),
                'datatype_id' => ilDclDatatype::INPUTFORMAT_TEXT
            ],
        ];
    }

References $DIC, ilDclBaseFieldModel\$lng, ilDclDatatype\INPUTFORMAT_DATETIME, ilDclDatatype\INPUTFORMAT_NUMBER, ilDclDatatype\INPUTFORMAT_TEXT, and ilLanguage\txt().

Referenced by _getDatatypeForId().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _isStandardField()

static ilDclStandardField::_isStandardField ( $field_id )

static

Parameters

int | string $field_id

Returns: bool

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

                                                      : bool
    {
        $return = false;
        foreach (self::_getStandardFieldsAsArray() as $field) {
            if ($field["id"] == $field_id) {
                $return = true;
            }
        }
 
        return $return;
    }

Referenced by ilDclTableView\createFieldSetting(), ilDclBaseRecordModel\fillRecordFieldExcelExport(), ilDclBaseRecordModel\fillRecordFieldFormInput(), ilDclBaseRecordModel\getRecordFieldFormulaValue(), ilDclBaseRecordModel\getRecordFieldHTML(), ilDclBaseRecordModel\getRecordFieldValue(), ilDclBaseRecordModel\setRecordFieldValue(), and ilDclBaseRecordModel\setRecordFieldValueFromForm().

Here is the caller graph for this function:

◆ afterClone()

ilDclStandardField::afterClone ( $records )

Parameters

$records

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

350 {

351 }

◆ allowFilterInListView()

ilDclStandardField::allowFilterInListView ( )

Reimplemented from ilDclBaseFieldModel.

Definition at line 314 of file class.ilDclStandardField.php.

                                           : bool
    {
        //comments are filterable if they are enabled in the tables settings
        return $this->id != 'comments'
            || ilDclCache::getTableCache($this->getTableId())->getPublicCommentsEnabled();
    }

References ilDclCache\getTableCache().

Here is the call graph for this function:

◆ clone()

ilDclStandardField::clone ( ilDclStandardField $original_record )

Definition at line 55 of file class.ilDclStandardField.php.

                                                              : void
    {
        $this->setOrder($original_record->getOrder());
        $this->setExportable($original_record->getExportable());
 
        $this->doUpdate();
    }

References doUpdate(), ilDclBaseFieldModel\getExportable(), ilDclBaseFieldModel\getOrder(), ilDclBaseFieldModel\setExportable(), and ilDclBaseFieldModel\setOrder().

Here is the call graph for this function:

◆ doCreate()

ilDclStandardField::doCreate ( )

Reimplemented from ilDclBaseFieldModel.

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

                              : void
    {
        global $DIC;
        $ilLog = $DIC['ilLog'];
        $message = "Standard fields cannot be written to DB";
        $this->main_tpl->setOnScreenMessage('failure', $message);
        $ilLog->write("[ilDclStandardField] " . $message);
    }

References $DIC, and $message.

◆ doRead()

ilDclStandardField::doRead ( )

Reimplemented from ilDclBaseFieldModel.

Definition at line 32 of file class.ilDclStandardField.php.

                            : void
    {
        global $DIC;
        $ilLog = $DIC['ilLog'];
        $message = "Standard fields cannot be read from DB";
        $this->main_tpl->setOnScreenMessage('failure', $message);
        $ilLog->write("[ilDclStandardField] " . $message);
    }

References $DIC, and $message.

◆ doUpdate()

ilDclStandardField::doUpdate ( )

Reimplemented from ilDclBaseFieldModel.

Definition at line 50 of file class.ilDclStandardField.php.

                              : void
    {
        $this->updateTableFieldSetting();
    }

References ilDclBaseFieldModel\updateTableFieldSetting().

Referenced by clone().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fillHeaderExcel()

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

Reimplemented from ilDclBaseFieldModel.

Definition at line 321 of file class.ilDclStandardField.php.

                                                                             : void
    {
        parent::fillHeaderExcel($worksheet, $row, $col);
        if ($this->getId() == 'owner') {
            global $DIC;
            $lng = $DIC['lng'];
            $worksheet->setCell($row, $col, $lng->txt("dcl_owner_name"));
            $col++;
        }
    }

References $DIC, $lng, ILIAS\Survey\Mode\getId(), and ilExcel\setCell().

Here is the call graph for this function:

◆ getLocked()

ilDclStandardField::getLocked ( )

Definition at line 63 of file class.ilDclStandardField.php.

                               : bool
    {
        return true;
    }

◆ getRecordQueryFilterObject()

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

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

Reimplemented from ilDclBaseFieldModel.

Definition at line 244 of file class.ilDclStandardField.php.

     : ?ilDclRecordQueryObject {
        global $DIC;
        $ilDB = $DIC['ilDB'];
 
        $where_additions = "";
        $join_str = "";
        if ($this->getDatatypeId() == ilDclDatatype::INPUTFORMAT_TEXT) {
            $join_str = "INNER JOIN usr_data AS filter_usr_data_{$this->getId()} ON (filter_usr_data_{$this->getId()}.usr_id = record.{$this->getId()} AND filter_usr_data_{$this->getId()}.login LIKE "
                . $ilDB->quote("%$filter_value%", 'text') . ") ";
        } else {
            if ($this->getDatatypeId() == ilDclDatatype::INPUTFORMAT_NUMBER) {
                $from = (isset($filter_value['from'])) ? $filter_value['from'] : null;
                $to = (isset($filter_value['to'])) ? $filter_value['to'] : null;
                if (is_numeric($from)) {
                    $where_additions .= " AND record.{$this->getId()} >= "
                        . $ilDB->quote($from, 'integer');
                }
                if (is_numeric($to)) {
                    $where_additions .= " AND record.{$this->getId()} <= "
                        . $ilDB->quote($to, 'integer');
                }
            } else {
                if ($this->getDatatypeId() === ilDclDatatype::INPUTFORMAT_DATETIME) {
                    $date_from = (isset($filter_value['from'])
                        && is_object($filter_value['from'])) ? $filter_value['from'] : null;
                    $date_to = (isset($filter_value['to'])
                        && is_object($filter_value['to'])) ? $filter_value['to'] : null;
 
                    // db->quote(.. date) at some point invokes ilDate->_toString, which adds a <br /> to the string,
                    // that's why strip_tags is used
                    if ($date_from) {
                        $where_additions .= " AND (record.{$this->getId()} >= "
                            . strip_tags($ilDB->quote($date_from, 'date')) . ")";
                    }
                    if ($date_to) {
                        $where_additions .= " AND (record.{$this->getId()} <= "
                            . strip_tags($ilDB->quote($date_to, 'date')) . ")";
                    }
                }
            }
        }
 
        $sql_obj = new ilDclRecordQueryObject();
        $sql_obj->setJoinStatement($join_str);
        $sql_obj->setWhereStatement($where_additions);
 
        return $sql_obj;
    }

References $ilDB.

◆ getRecordQuerySortObject()

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

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

Reimplemented from ilDclBaseFieldModel.

Definition at line 217 of file class.ilDclStandardField.php.

     : ?ilDclRecordQueryObject {
        $sql_obj = new ilDclRecordQueryObject();
 
        $join_str = "";
        if ($this->getId() == 'owner' || $this->getId() == 'last_edit_by') {
            $join_str = "LEFT JOIN usr_data AS sort_usr_data_{$this->getId()} ON (sort_usr_data_{$this->getId()}.usr_id = record.{$this->getId()})";
            $select_str = " sort_usr_data_{$this->getId()}.login AS field_{$this->getId()},";
        } else {
            $select_str = " record.{$this->getId()} AS field_{$this->getId()},";
        }
 
        $sql_obj->setSelectStatement($select_str);
        $sql_obj->setJoinStatement($join_str);
 
        if ($this->getId() !== "comments") {
            $sql_obj->setOrderStatement("field_{$this->getId()} " . $direction);
        }
 
        return $sql_obj;
    }

◆ getSortField()

ilDclStandardField::getSortField ( )

Returns the sort-field id.

Reimplemented from ilDclBaseFieldModel.

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

                                  : string
    {
        if ($this->getId() == 'comments') {
            return 'n_comments';
        } else {
            return $this->getTitle();
        }
    }

References ILIAS\Survey\Mode\getId(), and ILIAS\GlobalScreen\Scope\Footer\Factory\getTitle().

Here is the call graph for this function:

◆ getValueFromExcel()

ilDclStandardField::getValueFromExcel	(	ilExcel	$excel,
		int	$row,
		int	$col
	)

Returns: string|int

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

    {
        $value = $excel->getCell($row, $col);
        switch ($this->id) {
            case 'owner':
                return ilObjUser::_lookupId($value);
            default:
                return $value;
        }
    }

References ilObjUser\_lookupId(), and ilExcel\getCell().

Here is the call graph for this function:

◆ hasNumericSorting()

ilDclStandardField::hasNumericSorting ( )

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

Reimplemented from ilDclBaseFieldModel.

Definition at line 305 of file class.ilDclStandardField.php.

                                       : bool
    {
        if ($this->getId() == 'comments') {
            return true;
        }
 
        return parent::hasNumericSorting();
    }

References ILIAS\Survey\Mode\getId().

Here is the call graph for this function:

◆ isStandardField()

ilDclStandardField::isStandardField ( )

Reimplemented from ilDclBaseFieldModel.

Definition at line 209 of file class.ilDclStandardField.php.

                                     : bool
    {
        return true;
    }

Field Documentation

◆ $main_tpl

ilGlobalTemplateInterface ilDclStandardField::$main_tpl

private

Definition at line 23 of file class.ilDclStandardField.php.

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

components/ILIAS/DataCollection/classes/Fields/Base/class.ilDclStandardField.php

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getDatatypeForId()

◆ _getImportableStandardFieldTitle()

◆ _getNonImportableStandardFieldTitles()

◆ _getStandardFields()

◆ _getStandardFieldsAsArray()

◆ _isStandardField()

◆ afterClone()

◆ allowFilterInListView()

◆ clone()

◆ doCreate()

◆ doRead()

◆ doUpdate()

◆ fillHeaderExcel()

◆ getLocked()

◆ getRecordQueryFilterObject()

◆ getRecordQuerySortObject()

◆ getSortField()

◆ getValueFromExcel()

◆ hasNumericSorting()

◆ isStandardField()

Field Documentation

◆ $main_tpl