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

Inheritance diagram for ilDclStandardField:

Collaboration diagram for ilDclStandardField:

Public Member Functions
	__construct ($a_id=0)

	doRead ()

	doCreate ()

	doUpdate ()

	clone (ilDclStandardField $original_record)

	getLocked ()

	isStandardField ()

	isUnique ()

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

	hasNumericSorting ()

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

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

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_TEXTAREA = "text_area"

const	PROP_REFERENCE_LINK = "reference_link"

const	PROP_WIDTH = "width"

const	PROP_HEIGHT = "height"

const	PROP_LEARNING_PROGRESS = "learning_progress"

const	PROP_ILIAS_REFERENCE_LINK = "ILIAS_reference_link"

const	PROP_N_REFERENCE = "multiple_selection"

const	PROP_FORMULA_EXPRESSION = "expression"

const	PROP_DISPLAY_COPY_LINK_ACTION_MENU = "display_action_menu"

const	PROP_LINK_DETAIL_PAGE_TEXT = "link_detail_page_text"

const	PROP_LINK_DETAIL_PAGE_MOB = "link_detail_page_mob"

const	PROP_SUPPORTED_FILE_TYPES = "supported_file_types"

const	PROP_PLUGIN_HOOK_NAME = "plugin_hook_name"

const	EDIT_VIEW = 2

const	EXPORTABLE_VIEW = 4

Protected Member Functions 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)

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

Constructor & Destructor Documentation

◆ __construct()

ilDclStandardField::__construct ( $a_id = 0 )

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

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

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

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 206 of file class.ilDclStandardField.php.

References ilDclBaseFieldModel\$datatype.

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

                                                         : ?string
     {
         $datatype = null;
         foreach (self::_getStandardFieldsAsArray() as $fields_data) {
             if ($id == $fields_data['id']) {
                 $datatype = $fields_data['datatype_id'];
                 break;
             }
         }
 
         return $datatype;
     }

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 165 of file class.ilDclStandardField.php.

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

Referenced by ilDclContentImporter\getImportFieldsFromTitles().

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

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 132 of file class.ilDclStandardField.php.

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

Referenced by ilDclContentImporter\getImportFieldsFromTitles().

                                                                  : array
     {
         global $DIC;
         $ilDB = $DIC['ilDB'];
         $identifiers = '';
         foreach (
             array(
                 '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 = array();
         while ($rec = $ilDB->fetchAssoc($sql)) {
             $titles[] = $rec['value'];
         }
 
         return $titles;
     }

Here is the caller graph for this function:

◆ _getStandardFields()

static ilDclStandardField::_getStandardFields ( int $table_id )

static

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

References ilDclBaseFieldModel\$table_id.

Referenced by ilDclTable\getFieldsForFormula().

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

Here is the caller graph for this function:

◆ _getStandardFieldsAsArray()

static ilDclStandardField::_getStandardFieldsAsArray ( )

static

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

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

                                                       : 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();
         $stdfields = [
             [
                 "id" => "id",
                 "title" => $lng->txt("dcl_id"),
                 "description" => $lng->txt("dcl_id_description"),
                 "datatype_id" => ilDclDatatype::INPUTFORMAT_NUMBER
             ],
             [
                 "id" => "create_date",
                 "title" => $lng->txt("dcl_creation_date"),
                 "description" => $lng->txt("dcl_creation_date_description"),
                 "datatype_id" => ilDclDatatype::INPUTFORMAT_DATETIME
             ],
             [
                 "id" => "last_update",
                 "title" => $lng->txt("dcl_last_update"),
                 "description" => $lng->txt("dcl_last_update_description"),
                 "datatype_id" => ilDclDatatype::INPUTFORMAT_DATETIME
             ],
             [
                 "id" => "owner",
                 "title" => $lng->txt("dcl_owner"),
                 "description" => $lng->txt("dcl_owner_description"),
                 "datatype_id" => ilDclDatatype::INPUTFORMAT_TEXT
             ],
             [
                 "id" => "last_edit_by",
                 "title" => $lng->txt("dcl_last_edited_by"),
                 "description" => $lng->txt("dcl_last_edited_by_description"),
                 "datatype_id" => ilDclDatatype::INPUTFORMAT_TEXT
             ],
             [
                 'id' => 'comments',
                 'title' => $lng->txt('dcl_comments'),
                 'description' => $lng->txt('dcl_comments_desc'),
                 'datatype_id' => ilDclDatatype::INPUTFORMAT_TEXT
             ],
         ];
 
         return $stdfields;
     }

Here is the call graph for this function:

◆ _isStandardField()

static ilDclStandardField::_isStandardField ( $field_id )

static

Parameters

int | string $field_id

Returns: bool

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

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

Here is the caller graph for this function:

◆ afterClone()

ilDclStandardField::afterClone ( $records )

Parameters

$records

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

365 {

366 }

◆ allowFilterInListView()

ilDclStandardField::allowFilterInListView ( )

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

References ilDclCache\getTableCache(), and ilDclBaseFieldModel\getTableId().

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

Here is the call graph for this function:

◆ clone()

ilDclStandardField::clone ( ilDclStandardField $original_record )

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

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

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

Here is the call graph for this function:

◆ doCreate()

ilDclStandardField::doCreate ( )

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

References $DIC, and $message.

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

◆ doRead()

ilDclStandardField::doRead ( )

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

References $DIC, and $message.

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

◆ doUpdate()

ilDclStandardField::doUpdate ( )

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

References ilDclBaseFieldModel\updateTableFieldSetting().

Referenced by clone().

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

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
	)

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

References $DIC, ilDclBaseFieldModel\$lng, ilDclBaseFieldModel\getId(), ilExcel\setCell(), and ilLanguage\txt().

                                                                              : 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++;
         }
     }

Here is the call graph for this function:

◆ getLocked()

ilDclStandardField::getLocked ( )

Definition at line 62 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.

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

References $DIC, $ilDB, ilDclBaseFieldModel\getDatatypeId(), ilDclDatatype\INPUTFORMAT_DATETIME, ilDclDatatype\INPUTFORMAT_NUMBER, and ilDclDatatype\INPUTFORMAT_TEXT.

      : ?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;
     }

Here is the call graph for this function:

◆ getRecordQuerySortObject()

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

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

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

References ilDclBaseFieldModel\getId().

      : ?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;
     }

Here is the call graph for this function:

◆ getSortField()

ilDclStandardField::getSortField ( )

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

References ilDclBaseFieldModel\getId(), and ilDclBaseFieldModel\getTitle().

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

Here is the call graph for this function:

◆ getValueFromExcel()

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

Returns: string|int

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

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

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

Here is the call graph for this function:

◆ hasNumericSorting()

ilDclStandardField::hasNumericSorting ( )

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

References ilDclBaseFieldModel\getId().

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

Here is the call graph for this function:

◆ isStandardField()

ilDclStandardField::isStandardField ( )

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

                                      : bool
     {
         return true;
     }

◆ isUnique()

ilDclStandardField::isUnique ( )

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

Referenced by clone().

                               : bool
     {
         return false;
     }

Here is the caller graph for this function:

Field Documentation

◆ $main_tpl

ilGlobalTemplateInterface ilDclStandardField::$main_tpl

private

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

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

Modules/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()

◆ isUnique()

Field Documentation

◆ $main_tpl