Inheritance diagram for ilDclTableViewFieldSetting:

Collaboration diagram for ilDclTableViewFieldSetting:

Public Member Functions
	getTableviewId ()

	setTableviewId (int $tableview_id)

	getField ()

	setField (string $field)

	isVisibleInList ()

	setVisible (bool $visible)

	isInFilter ()

	setInFilter (bool $in_filter)

	getFilterValue ()

	setFilterValue ($filter_value)

	isFilterChangeable ()

	setFilterChangeable (bool $filter_changeable)

	getId ()

	setId (int $id)

	isRequiredCreate ()

	setRequiredCreate (bool $required_create)

	isLockedCreate ()

	setLockedCreate (bool $locked_create)

	isRequiredEdit ()

	setRequiredEdit (bool $required_edit)

	isLockedEdit ()

	setLockedEdit (bool $locked_edit)

	getDefaultValue ()

	setDefaultValue (?string $default_value)

	isVisibleCreate ()

	setVisibleCreate (bool $visible_create)

	setNotVisibleCreate (bool $not_visible_create)

	isNotVisibleCreate ()

	isVisibleEdit ()

	setVisibleEdit (bool $visible_edit)

	setNotVisibleEdit (bool $not_visible)

	isNotVisibleEdit ()

	isVisibleInForm (bool $creation_mode)

	isLocked (bool $creation_mode)

	isRequired (bool $creation_mode)

	sleep ($field_name)

	wakeUp ($field_name, $field_value)

	cloneStructure (ilDclTableViewFieldSetting $orig)

	getFieldObject ()

Public Member Functions inherited from ActiveRecord
	getArConnector ()

	getArFieldList ()

	getConnectorContainerName ()
	Return the Name of your Connector Table More...

	setConnectorContainerName (string $connector_container_name)

	getPrimaryFieldValue ()

	setPrimaryFieldValue ($value)

	__construct (mixed $primary_key=0)

	storeObjectToCache ()

	asStdClass ()

	asArray ()

	buildFromArray (array $array)

	fixDateField ($field_name, string $value)

	sleep ($field_name)

	wakeUp ($field_name, $field_value)

	getArrayForConnector ()

	installConnector ()

	store ()

	save ()

	create ()

	copy (int $new_id=0)

	afterObjectLoad ()

	read ()

	update ()

	delete ()

	__call ($name, $arguments)

Static Public Member Functions
static	returnDbTableName ()

static	getTableViewFieldSetting (string $id, int $tableview_id)

static	getInstance (int $tableview_id, int $field_id)

Static Public Member Functions inherited from ActiveRecord
static	returnDbTableName ()

static	installDB ()

static	renameDBField (string $old_name, string $new_name)

static	tableExists ()

static	fieldExists (string $field_name)

static	removeDBField (string $field_name)

static	updateDB ()

static	resetDB ()

static	truncateDB ()

static	flushDB ()
	never use in ILIAS Core, Plugins only More...

static	preloadObjects ()

static	additionalParams (array $additional_params)

static	findOrFail ($primary_key, array $add_constructor_args=[])
	Tries to find the object and throws an Exception if object is not found, instead of returning null. More...

static	findOrGetInstance ($primary_key, array $add_constructor_args=[])

static	where ($where, $operator=null)

static	innerjoinAR (ActiveRecord $activeRecord, $on_this, string $on_external, array $fields=[' *'], string $operator='=', bool $both_external=false)

static	innerjoin (string $tablename, $on_this, string $on_external, array $fields=[' *'], string $operator='=', bool $both_external=false)

static	leftjoin (string $tablename, $on_this, string $on_external, array $fields=[' *'], string $operator='=', bool $both_external=false)

static	orderBy (string $orderBy, string $orderDirection='ASC')

static	dateFormat (string $date_format='d.m.Y - H:i:s')

static	limit (int $start, int $end)

static	affectedRows ()

static	count ()

static	get ()

static	debug ()

static	first ()

static	getCollection ()

static	last ()

static	getFirstFromLastQuery ()

static	connector (arConnector $arConnector)

static	raw (bool $set_raw=true)

static	getArray (?string $key=null, string\|array\|null $values=null)

static	_toCamelCase (string $str, bool $capitalise_first_char=false)

Protected Attributes
int	$id

int	$tableview_id

string	$field = ""

bool	$visible = false

bool	$in_filter = false

	$filter_value = ""

bool	$filter_changeable = false

bool	$required_create = false

bool	$locked_create = false

string	$default_value = null

bool	$visible_create = false

bool	$visible_edit = false

bool	$required_edit = false

bool	$locked_edit = false

Protected Attributes inherited from ActiveRecord
bool	$ar_safe_read = true

string	$connector_container_name = ''

bool	$is_new = true

Additional Inherited Members
Protected Member Functions inherited from ActiveRecord
	installDatabase ()

Static Protected Member Functions inherited from ActiveRecord
static	getCalledClass ()
	Returns an instance of the instatiated calling active record (needs to be done in static methods) : This should be cached somehow More...

static	fromCamelCase (string $str)

Detailed Description

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

Member Function Documentation

◆ cloneStructure()

ilDclTableViewFieldSetting::cloneStructure ( ilDclTableViewFieldSetting $orig )

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

References $filter_value, ActiveRecord\create(), getField(), getFilterValue(), getId(), isFilterChangeable(), isInFilter(), isLockedCreate(), isLockedEdit(), isRequiredCreate(), isRequiredEdit(), isVisibleCreate(), isVisibleEdit(), isVisibleInList(), setFilterChangeable(), setFilterValue(), setInFilter(), setLockedCreate(), setLockedEdit(), setRequiredCreate(), setRequiredEdit(), setVisible(), setVisibleCreate(), and setVisibleEdit().

                                                                     : int
     {
         $this->setFilterChangeable($orig->isFilterChangeable());
         $this->setInFilter($orig->isInFilter());
         $this->setVisibleCreate($orig->isVisibleCreate());
         $this->setVisibleEdit($orig->isVisibleEdit());
         $this->setLockedCreate($orig->isLockedCreate());
         $this->setLockedEdit($orig->isLockedEdit());
         $this->setRequiredCreate($orig->isRequiredCreate());
         $this->setRequiredEdit($orig->isRequiredEdit());
         $filter_value = $orig->getFilterValue();
         $this->setFilterValue($filter_value['filter_' . $orig->getField()] ?? $filter_value);
         $this->setVisible($orig->isVisibleInList());
         $this->create();
         return $this->getId();
     }

Here is the call graph for this function:

◆ getDefaultValue()

ilDclTableViewFieldSetting::getDefaultValue ( )

Definition at line 252 of file class.ilDclTableViewFieldSetting.php.

References $default_value.

Referenced by ilDclCreateViewTableGUI\getHTML().

                                      : ?string
     {
         return $this->default_value;
     }

Here is the caller graph for this function:

◆ getField()

ilDclTableViewFieldSetting::getField ( )

Definition at line 149 of file class.ilDclTableViewFieldSetting.php.

References $field.

Referenced by cloneStructure(), ilDclCreateViewTableGUI\getHTML(), and wakeUp().

                               : string
     {
         return $this->field;
     }

Here is the caller graph for this function:

◆ getFieldObject()

ilDclTableViewFieldSetting::getFieldObject ( )

Returns: ilDclBaseFieldModel|ilDclStandardField

Definition at line 368 of file class.ilDclTableViewFieldSetting.php.

References $DIC, $lng, ilDclStandardField\_getDatatypeForId(), and ilDclCache\getFieldCache().

Referenced by ilDclCreateViewTableGUI\getHTML().

     {
         if (is_numeric($this->field)) {   //normal field
             return ilDclCache::getFieldCache((int) $this->field);
         } else {   //standard field
             global $DIC;
             $lng = $DIC['lng'];
             $stdfield = new ilDclStandardField();
             $stdfield->setId($this->field);
             $stdfield->setDatatypeId(ilDclStandardField::_getDatatypeForId($this->field));
             $stdfield->setTitle($lng->txt('dcl_' . $this->field));
 
             return $stdfield;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFilterValue()

ilDclTableViewFieldSetting::getFilterValue ( )

Definition at line 182 of file class.ilDclTableViewFieldSetting.php.

References $filter_value.

Referenced by cloneStructure().

     {
         return $this->filter_value;
     }

Here is the caller graph for this function:

◆ getId()

ilDclTableViewFieldSetting::getId ( )

Definition at line 202 of file class.ilDclTableViewFieldSetting.php.

References $id.

Referenced by cloneStructure(), and ilDclCreateViewTableGUI\getHTML().

                            : int
     {
         return $this->id;
     }

Here is the caller graph for this function:

◆ getInstance()

static ilDclTableViewFieldSetting::getInstance	(	int	$tableview_id,
		int	$field_id
	)

static

Parameters

$tableview_id
$field_id

Returns: ActiveRecord|self

Definition at line 399 of file class.ilDclTableViewFieldSetting.php.

References ActiveRecord\first().

Referenced by ilDataCollectionDataSet\getXmlNamespace().

                                                                         : ActiveRecord
     {
         if (!($setting = self::where(['field' => $field_id, 'tableview_id' => $tableview_id])->first())) {
             $setting = new self();
             $setting->setField((string) $field_id);
             $setting->setTableviewId($tableview_id);
         }
         return $setting;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTableViewFieldSetting()

static ilDclTableViewFieldSetting::getTableViewFieldSetting	(	string	$id,
		int	$tableview_id
	)

static

Returns: ActiveRecord|self

Definition at line 387 of file class.ilDclTableViewFieldSetting.php.

References ActiveRecord\first().

Referenced by ilDclBaseFieldModel\getViewSetting().

                                                                                   : ActiveRecord
     {
         return parent::where(['field' => $id,
                               'tableview_id' => $tableview_id
         ])->first();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTableviewId()

ilDclTableViewFieldSetting::getTableviewId ( )

Definition at line 139 of file class.ilDclTableViewFieldSetting.php.

References $tableview_id.

                                     : int
     {
         return $this->tableview_id;
     }

◆ isFilterChangeable()

ilDclTableViewFieldSetting::isFilterChangeable ( )

Definition at line 192 of file class.ilDclTableViewFieldSetting.php.

References $filter_changeable.

Referenced by cloneStructure().

                                         : bool
     {
         return $this->filter_changeable;
     }

Here is the caller graph for this function:

◆ isInFilter()

ilDclTableViewFieldSetting::isInFilter ( )

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

References $in_filter.

Referenced by cloneStructure().

                                 : bool
     {
         return $this->in_filter;
     }

Here is the caller graph for this function:

◆ isLocked()

ilDclTableViewFieldSetting::isLocked ( bool $creation_mode )

Definition at line 307 of file class.ilDclTableViewFieldSetting.php.

References isLockedCreate(), and isLockedEdit().

                                                  : bool
     {
         return $creation_mode ? $this->isLockedCreate() : $this->isLockedEdit();
     }

Here is the call graph for this function:

◆ isLockedCreate()

ilDclTableViewFieldSetting::isLockedCreate ( )

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

References $locked_create.

Referenced by cloneStructure(), ilDclCreateViewTableGUI\getHTML(), and isLocked().

                                     : bool
     {
         return $this->locked_create;
     }

Here is the caller graph for this function:

◆ isLockedEdit()

ilDclTableViewFieldSetting::isLockedEdit ( )

Definition at line 242 of file class.ilDclTableViewFieldSetting.php.

References $locked_edit.

Referenced by cloneStructure(), and isLocked().

                                   : bool
     {
         return $this->locked_edit;
     }

Here is the caller graph for this function:

◆ isNotVisibleCreate()

ilDclTableViewFieldSetting::isNotVisibleCreate ( )

Definition at line 277 of file class.ilDclTableViewFieldSetting.php.

References $visible_create.

                                         : bool
     {
         return !$this->visible_create;
     }

◆ isNotVisibleEdit()

ilDclTableViewFieldSetting::isNotVisibleEdit ( )

Definition at line 297 of file class.ilDclTableViewFieldSetting.php.

References $visible_edit.

                                       : bool
     {
         return !$this->visible_edit;
     }

◆ isRequired()

ilDclTableViewFieldSetting::isRequired ( bool $creation_mode )

Definition at line 312 of file class.ilDclTableViewFieldSetting.php.

References isRequiredCreate(), and isRequiredEdit().

                                                    : bool
     {
         return $creation_mode ? $this->isRequiredCreate() : $this->isRequiredEdit();
     }

Here is the call graph for this function:

◆ isRequiredCreate()

ilDclTableViewFieldSetting::isRequiredCreate ( )

Definition at line 212 of file class.ilDclTableViewFieldSetting.php.

References $required_create.

Referenced by cloneStructure(), ilDclCreateViewTableGUI\getHTML(), and isRequired().

                                       : bool
     {
         return $this->required_create;
     }

Here is the caller graph for this function:

◆ isRequiredEdit()

ilDclTableViewFieldSetting::isRequiredEdit ( )

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

References $required_edit.

Referenced by cloneStructure(), and isRequired().

                                     : bool
     {
         return $this->required_edit;
     }

Here is the caller graph for this function:

◆ isVisibleCreate()

ilDclTableViewFieldSetting::isVisibleCreate ( )

Definition at line 262 of file class.ilDclTableViewFieldSetting.php.

References $visible_create.

Referenced by cloneStructure(), ilDclCreateViewTableGUI\getHTML(), and isVisibleInForm().

                                      : bool
     {
         return $this->visible_create;
     }

Here is the caller graph for this function:

◆ isVisibleEdit()

ilDclTableViewFieldSetting::isVisibleEdit ( )

Definition at line 282 of file class.ilDclTableViewFieldSetting.php.

References $visible_edit.

Referenced by cloneStructure(), and isVisibleInForm().

                                    : bool
     {
         return $this->visible_edit;
     }

Here is the caller graph for this function:

◆ isVisibleInForm()

ilDclTableViewFieldSetting::isVisibleInForm ( bool $creation_mode )

Definition at line 302 of file class.ilDclTableViewFieldSetting.php.

References isVisibleCreate(), and isVisibleEdit().

                                                         : bool
     {
         return $creation_mode ? $this->isVisibleCreate() : $this->isVisibleEdit();
     }

Here is the call graph for this function:

◆ isVisibleInList()

ilDclTableViewFieldSetting::isVisibleInList ( )

Definition at line 162 of file class.ilDclTableViewFieldSetting.php.

References $visible.

Referenced by cloneStructure().

                                      : bool
     {
         return $this->visible;
     }

Here is the caller graph for this function:

◆ returnDbTableName()

static ilDclTableViewFieldSetting::returnDbTableName ( )

static

Returns: string Return the Name of your Database Table

Definition at line 134 of file class.ilDclTableViewFieldSetting.php.

                                               : string
     {
         return "il_dcl_tview_set";
     }

◆ setDefaultValue()

ilDclTableViewFieldSetting::setDefaultValue ( ?string $default_value )

Definition at line 257 of file class.ilDclTableViewFieldSetting.php.

References $default_value.

                                                            : void
     {
         $this->default_value = $default_value;
     }

◆ setField()

ilDclTableViewFieldSetting::setField ( string $field )

Parameters

$field

Definition at line 157 of file class.ilDclTableViewFieldSetting.php.

References $field.

                                            : void
     {
         $this->field = $field;
     }

◆ setFilterChangeable()

ilDclTableViewFieldSetting::setFilterChangeable ( bool $filter_changeable )

Definition at line 197 of file class.ilDclTableViewFieldSetting.php.

References $filter_changeable.

Referenced by cloneStructure().

                                                                 : void
     {
         $this->filter_changeable = $filter_changeable;
     }

Here is the caller graph for this function:

◆ setFilterValue()

ilDclTableViewFieldSetting::setFilterValue ( $filter_value )

Definition at line 187 of file class.ilDclTableViewFieldSetting.php.

References $filter_value.

Referenced by cloneStructure().

                                                  : void
     {
         $this->filter_value = $filter_value;
     }

Here is the caller graph for this function:

◆ setId()

ilDclTableViewFieldSetting::setId ( int $id )

Definition at line 207 of file class.ilDclTableViewFieldSetting.php.

References $id.

                                   : void
     {
         $this->id = $id;
     }

◆ setInFilter()

ilDclTableViewFieldSetting::setInFilter ( bool $in_filter )

Definition at line 177 of file class.ilDclTableViewFieldSetting.php.

References $in_filter.

Referenced by cloneStructure().

                                                 : void
     {
         $this->in_filter = $in_filter;
     }

Here is the caller graph for this function:

◆ setLockedCreate()

ilDclTableViewFieldSetting::setLockedCreate ( bool $locked_create )

Definition at line 227 of file class.ilDclTableViewFieldSetting.php.

References $locked_create.

Referenced by cloneStructure().

                                                         : void
     {
         $this->locked_create = $locked_create;
     }

Here is the caller graph for this function:

◆ setLockedEdit()

ilDclTableViewFieldSetting::setLockedEdit ( bool $locked_edit )

Definition at line 247 of file class.ilDclTableViewFieldSetting.php.

References $locked_edit.

Referenced by cloneStructure().

                                                     : void
     {
         $this->locked_edit = $locked_edit;
     }

Here is the caller graph for this function:

◆ setNotVisibleCreate()

ilDclTableViewFieldSetting::setNotVisibleCreate ( bool $not_visible_create )

Definition at line 272 of file class.ilDclTableViewFieldSetting.php.

                                                                  : void
     {
         $this->visible_create = !$not_visible_create;
     }

◆ setNotVisibleEdit()

ilDclTableViewFieldSetting::setNotVisibleEdit ( bool $not_visible )

Definition at line 292 of file class.ilDclTableViewFieldSetting.php.

                                                         : void
     {
         $this->visible_edit = !$not_visible;
     }

◆ setRequiredCreate()

ilDclTableViewFieldSetting::setRequiredCreate ( bool $required_create )

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

References $required_create.

Referenced by cloneStructure().

                                                             : void
     {
         $this->required_create = $required_create;
     }

Here is the caller graph for this function:

◆ setRequiredEdit()

ilDclTableViewFieldSetting::setRequiredEdit ( bool $required_edit )

Definition at line 237 of file class.ilDclTableViewFieldSetting.php.

References $required_edit.

Referenced by cloneStructure().

                                                         : void
     {
         $this->required_edit = $required_edit;
     }

Here is the caller graph for this function:

◆ setTableviewId()

ilDclTableViewFieldSetting::setTableviewId ( int $tableview_id )

Definition at line 144 of file class.ilDclTableViewFieldSetting.php.

References $tableview_id.

                                                      : void
     {
         $this->tableview_id = $tableview_id;
     }

◆ setVisible()

ilDclTableViewFieldSetting::setVisible ( bool $visible )

Definition at line 167 of file class.ilDclTableViewFieldSetting.php.

References $visible.

Referenced by cloneStructure().

                                              : void
     {
         $this->visible = $visible;
     }

Here is the caller graph for this function:

◆ setVisibleCreate()

ilDclTableViewFieldSetting::setVisibleCreate ( bool $visible_create )

Definition at line 267 of file class.ilDclTableViewFieldSetting.php.

References $visible_create.

Referenced by cloneStructure().

                                                           : void
     {
         $this->visible_create = $visible_create;
     }

Here is the caller graph for this function:

◆ setVisibleEdit()

ilDclTableViewFieldSetting::setVisibleEdit ( bool $visible_edit )

Definition at line 287 of file class.ilDclTableViewFieldSetting.php.

References $visible_edit.

Referenced by cloneStructure().

                                                       : void
     {
         $this->visible_edit = $visible_edit;
     }

Here is the caller graph for this function:

◆ sleep()

ilDclTableViewFieldSetting::sleep ( $field_name )

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

References null.

                                       : ?string
     {
         if ($field_name == 'filter_value' && is_array($this->filter_value)) {
             return json_encode($this->filter_value);
         }
 
         return null;
     }

◆ wakeUp()

ilDclTableViewFieldSetting::wakeUp	(	$field_name,
		$field_value
	)

Definition at line 326 of file class.ilDclTableViewFieldSetting.php.

References getField(), and null.

                                                      : ?array
     {
         if ($field_name == 'filter_value') {
             $return = [];
             $json = null;
             if ($field_value) {
                 $json = json_decode($field_value, true);
             }
             if (is_array($json)) {
                 foreach ($json as $key => $value) {
                     $return['filter_' . $this->getField() . '_' . $key] = $value;
                 }
             } else {
                 $return = ['filter_' . $this->getField() => $field_value];
             }
 
             return $return;
         }
 
         return null;
     }