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

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 ()
	@description Return the Name of your Connector Table More...

	setConnectorContainerName (string $connector_container_name)

	getPrimaryFieldValue ()

	setPrimaryFieldValue ($value)

	__construct ($primary_key=0)

	storeObjectToCache ()

	asStdClass ()

	buildFromArray (array $array)

	fixDateField ($field_name, $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 ()
	@depracated never use in ILIAS Core, Plugins only More...

static	preloadObjects ()

static	additionalParams (array $additional_params)

static	findOrFail ($primary_key, array $add_constructor_args=array())
	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=array())

static	where ($where, $operator=null)

static	innerjoinAR (ActiveRecord $ar, $on_this, $on_external, array $fields=array(' *'), string $operator='=', $both_external=false)

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

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

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

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

static	limit ($start, $end)

static	affectedRows ()

static	count ()

static	get ()

static	debug ()

static	first ()

static	getCollection ()

static	last ()

static	getFirstFromLastQuery ()

static	connector (arConnector $connector)

static	raw (bool $set_raw=true)

static	getArray (?string $key=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 ()
	@description Returns an instance of the instatiated calling active record (needs to be done in static methods) @TODO : This should be cached somehow More...

static	fromCamelCase (string $str)

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

Member Function Documentation

◆ cloneStructure()

ilDclTableViewFieldSetting::cloneStructure ( ilDclTableViewFieldSetting $orig )

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

                                                                    : 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());
        $this->setFilterValue($orig->getFilterValue());
        $this->setVisible($orig->isVisibleInList());
        $this->create();
        return $this->getId();
    }

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

Here is the call graph for this function:

◆ getDefaultValue()

ilDclTableViewFieldSetting::getDefaultValue ( )

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

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

References $default_value.

◆ getField()

ilDclTableViewFieldSetting::getField ( )

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

                              : string
    {
        return $this->field;
    }

References $field.

Referenced by wakeUp().

Here is the caller graph for this function:

◆ getFieldObject()

ilDclTableViewFieldSetting::getFieldObject ( )

Returns: ilDclBaseFieldModel|ilDclStandardField

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

    {
        if (is_numeric($this->field)) {   //normal field
            return ilDclCache::getFieldCache($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;
        }
    }

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

Here is the call graph for this function:

◆ getFilterValue()

ilDclTableViewFieldSetting::getFilterValue ( )

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

    {
        return $this->filter_value;
    }

References $filter_value.

Referenced by cloneStructure().

Here is the caller graph for this function:

◆ getId()

ilDclTableViewFieldSetting::getId ( )

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

                           : int
    {
        return $this->id;
    }

References $id.

Referenced by cloneStructure().

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 397 of file class.ilDclTableViewFieldSetting.php.

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

References $tableview_id, and ActiveRecord\first().

Here is the call graph for this function:

◆ getTableViewFieldSetting()

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

static

Returns: ActiveRecord|self

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

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

References $id, $tableview_id, and ActiveRecord\first().

Referenced by ilDclBaseFieldModel\getViewSetting().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTableviewId()

ilDclTableViewFieldSetting::getTableviewId ( )

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

                                    : int
    {
        return $this->tableview_id;
    }

References $tableview_id.

◆ isFilterChangeable()

ilDclTableViewFieldSetting::isFilterChangeable ( )

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

                                        : bool
    {
        return $this->filter_changeable;
    }

References $filter_changeable.

Referenced by cloneStructure().

Here is the caller graph for this function:

◆ isInFilter()

ilDclTableViewFieldSetting::isInFilter ( )

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

                                : bool
    {
        return $this->in_filter;
    }

References $in_filter.

Referenced by cloneStructure().

Here is the caller graph for this function:

◆ isLocked()

ilDclTableViewFieldSetting::isLocked ( bool $creation_mode )

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

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

References isLockedCreate(), and isLockedEdit().

Here is the call graph for this function:

◆ isLockedCreate()

ilDclTableViewFieldSetting::isLockedCreate ( )

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

                                    : bool
    {
        return $this->locked_create;
    }

References $locked_create.

Referenced by cloneStructure(), and isLocked().

Here is the caller graph for this function:

◆ isLockedEdit()

ilDclTableViewFieldSetting::isLockedEdit ( )

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

                                  : bool
    {
        return $this->locked_edit;
    }

References $locked_edit.

Referenced by cloneStructure(), and isLocked().

Here is the caller graph for this function:

◆ isNotVisibleCreate()

ilDclTableViewFieldSetting::isNotVisibleCreate ( )

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

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

References $visible_create.

◆ isNotVisibleEdit()

ilDclTableViewFieldSetting::isNotVisibleEdit ( )

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

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

References $visible_edit.

◆ isRequired()

ilDclTableViewFieldSetting::isRequired ( bool $creation_mode )

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

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

References isRequiredCreate(), and isRequiredEdit().

Here is the call graph for this function:

◆ isRequiredCreate()

ilDclTableViewFieldSetting::isRequiredCreate ( )

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

                                      : bool
    {
        return $this->required_create;
    }

References $required_create.

Referenced by cloneStructure(), and isRequired().

Here is the caller graph for this function:

◆ isRequiredEdit()

ilDclTableViewFieldSetting::isRequiredEdit ( )

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

                                    : bool
    {
        return $this->required_edit;
    }

References $required_edit.

Referenced by cloneStructure(), and isRequired().

Here is the caller graph for this function:

◆ isVisibleCreate()

ilDclTableViewFieldSetting::isVisibleCreate ( )

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

                                     : bool
    {
        return $this->visible_create;
    }

References $visible_create.

Referenced by cloneStructure(), and isVisibleInForm().

Here is the caller graph for this function:

◆ isVisibleEdit()

ilDclTableViewFieldSetting::isVisibleEdit ( )

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

                                   : bool
    {
        return $this->visible_edit;
    }

References $visible_edit.

Referenced by cloneStructure(), and isVisibleInForm().

Here is the caller graph for this function:

◆ isVisibleInForm()

ilDclTableViewFieldSetting::isVisibleInForm ( bool $creation_mode )

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

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

References isVisibleCreate(), and isVisibleEdit().

Here is the call graph for this function:

◆ isVisibleInList()

ilDclTableViewFieldSetting::isVisibleInList ( )

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

                                     : bool
    {
        return $this->visible;
    }

References $visible.

Referenced by cloneStructure().

Here is the caller graph for this function:

◆ returnDbTableName()

static ilDclTableViewFieldSetting::returnDbTableName ( )

static

Returns: string @description Return the Name of your Database Table

Reimplemented from ActiveRecord.

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

                                              : string
    {
        return "il_dcl_tview_set";
    }

◆ setDefaultValue()

ilDclTableViewFieldSetting::setDefaultValue ( ?string $default_value )

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

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

References $default_value.

◆ setField()

ilDclTableViewFieldSetting::setField ( string $field )

Parameters

$field

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

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

References $field.

◆ setFilterChangeable()

ilDclTableViewFieldSetting::setFilterChangeable ( bool $filter_changeable )

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

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

References $filter_changeable.

Referenced by cloneStructure().

Here is the caller graph for this function:

◆ setFilterValue()

ilDclTableViewFieldSetting::setFilterValue ( $filter_value )

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

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

References $filter_value.

Referenced by cloneStructure().

Here is the caller graph for this function:

◆ setId()

ilDclTableViewFieldSetting::setId ( int $id )

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

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

References $id.

◆ setInFilter()

ilDclTableViewFieldSetting::setInFilter ( bool $in_filter )

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

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

References $in_filter.

Referenced by cloneStructure().

Here is the caller graph for this function:

◆ setLockedCreate()

ilDclTableViewFieldSetting::setLockedCreate ( bool $locked_create )

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

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

References $locked_create.

Referenced by cloneStructure().

Here is the caller graph for this function:

◆ setLockedEdit()

ilDclTableViewFieldSetting::setLockedEdit ( bool $locked_edit )

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

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

References $locked_edit.

Referenced by cloneStructure().

Here is the caller graph for this function:

◆ setNotVisibleCreate()

ilDclTableViewFieldSetting::setNotVisibleCreate ( bool $not_visible_create )

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

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

◆ setNotVisibleEdit()

ilDclTableViewFieldSetting::setNotVisibleEdit ( bool $not_visible )

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

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

◆ setRequiredCreate()

ilDclTableViewFieldSetting::setRequiredCreate ( bool $required_create )

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

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

References $required_create.

Referenced by cloneStructure().

Here is the caller graph for this function:

◆ setRequiredEdit()

ilDclTableViewFieldSetting::setRequiredEdit ( bool $required_edit )

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

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

References $required_edit.

Referenced by cloneStructure().

Here is the caller graph for this function:

◆ setTableviewId()

ilDclTableViewFieldSetting::setTableviewId ( int $tableview_id )

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

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

References $tableview_id.

◆ setVisible()

ilDclTableViewFieldSetting::setVisible ( bool $visible )

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

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

References $visible.

Referenced by cloneStructure().

Here is the caller graph for this function:

◆ setVisibleCreate()

ilDclTableViewFieldSetting::setVisibleCreate ( bool $visible_create )

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

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

References $visible_create.

Referenced by cloneStructure().

Here is the caller graph for this function:

◆ setVisibleEdit()

ilDclTableViewFieldSetting::setVisibleEdit ( bool $visible_edit )

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

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

References $visible_edit.

Referenced by cloneStructure().

Here is the caller graph for this function:

◆ sleep()

ilDclTableViewFieldSetting::sleep ( $field_name )

Parameters

$field_name

Returns: null|string

Reimplemented from ActiveRecord.

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

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

Parameters

$field_name
$field_value

Returns: null

Reimplemented from ActiveRecord.

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

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