ilDclPluginFieldModel Class Reference

Inheritance diagram for ilDclPluginFieldModel:

Collaboration diagram for ilDclPluginFieldModel:

Public Member Functions
	getValidFieldProperties ()
	getCustomValidFieldProperties ()
	Method for adding custom fields to plugins. More...
	allowFilterInListView ()
	getPresentationTitle ()
	getPresentationDescription ()
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 (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=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...

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 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 (mixed $value)
Protected Attributes inherited from ilDclBaseFieldModel
string	$id = ""
int	$table_id = 0
string	$title = ""
string	$description = ""
int	$datatype_id = 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

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

Member Function Documentation

allowFilterInListView()

ilDclPluginFieldModel::allowFilterInListView

(

)

Returns

bool

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

                                           : bool
    {
        return false;
    }

getCustomValidFieldProperties()

ilDclPluginFieldModel::getCustomValidFieldProperties

(

)

Method for adding custom fields to plugins.

Definition at line 31 of file class.ilDclPluginFieldModel.php.

Referenced by getValidFieldProperties().

                                                   : array
    {
        return [];
    }

Here is the caller graph for this function:

getPresentationDescription()

ilDclPluginFieldModel::getPresentationDescription

(

)

Definition at line 54 of file class.ilDclPluginFieldModel.php.

References $DIC, XapiProxy\$plugin, ilDclBaseFieldModel\getDatatype(), ilDclFieldTypePlugin\getPluginId(), and ilDclBaseFieldModel\getTitle().

                                                : string
    {
        global $DIC;
        $plugin = $DIC["component.factory"]->getPlugin(ilDclFieldTypePlugin::getPluginId($this->getDatatype()->getTitle()));
        if (str_ends_with($plugin->txt('field_type_info'), 'field_type_info-')) {
            return '';
        }
        return $plugin->txt('field_type_info');
    }

Here is the call graph for this function:

getPresentationTitle()

ilDclPluginFieldModel::getPresentationTitle

(

)

Definition at line 44 of file class.ilDclPluginFieldModel.php.

References $DIC, XapiProxy\$plugin, ilDclBaseFieldModel\getDatatype(), ilDclFieldTypePlugin\getPluginId(), and ilDclBaseFieldModel\getTitle().

                                          : string
    {
        global $DIC;
        $plugin = $DIC["component.factory"]->getPlugin(ilDclFieldTypePlugin::getPluginId($this->getDatatype()->getTitle()));
        if (str_ends_with($plugin->txt('field_type_name'), 'field_type_name-')) {
            return $plugin->getPluginName();
        }
        return $plugin->txt('field_type_name');
    }

Here is the call graph for this function:

getValidFieldProperties()

ilDclPluginFieldModel::getValidFieldProperties

(

)

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

References getCustomValidFieldProperties(), and ilDclBaseFieldModel\PROP_PLUGIN_HOOK_NAME.

                                             : array
    {
        return array_merge([ilDclBaseFieldModel::PROP_PLUGIN_HOOK_NAME], $this->getCustomValidFieldProperties());
    }

Here is the call graph for this function:

---

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

• components/ILIAS/DataCollection/classes/Fields/Plugin/class.ilDclPluginFieldModel.php