Class ilDclTableViewFieldSetting. More...

Inheritance diagram for ilDclTableViewFieldSetting:

Collaboration diagram for ilDclTableViewFieldSetting:

Public Member Functions
	getTableviewId ()

	setTableviewId ($tableview_id)

	getField ()

	setField ($field)

	isVisibleInList ()

	setVisible ($visible)

	isInFilter ()

	setInFilter ($in_filter)

	getFilterValue ()

	setFilterValue ($filter_value)

	isFilterChangeable ()

	setFilterChangeable ($filter_changeable)

	getId ()

	setId ($id)

	isRequiredCreate ()

	setRequiredCreate ($required_create)

	isLockedCreate ()

	setLockedCreate ($locked_create)

	isRequiredEdit ()

	setRequiredEdit ($required_edit)

	isLockedEdit ()

	setLockedEdit ($locked_edit)

	getDefaultValue ()

	setDefaultValue ($default_value)

	isVisibleCreate ()

	setVisibleCreate ($visible_create)

	setNotVisibleCreate (bool $not_visible_create)

	isNotVisibleCreate ()

	isVisibleEdit ()

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

	setConnectorContainerName ($connector_container_name)

	getPrimaryFieldValue ()

	setPrimaryFieldValue ($value)

	__construct ($primary_key=0, arConnector $connector=null)

	storeObjectToCache ()

	__getConvertedDateFieldsAsArray ($format=null)

	__asCsv ($separator=';', $header=false)

	__asArray ()

	__asStdClass ()

	__asSerializedObject ()

	buildFromArray (array $array)

	fixDateField ($field_name, $value)

	sleep ($field_name)

	wakeUp ($field_name, $field_value)

	getArrayForDb ()

	getArrayForConnector ()

	installConnector ()

	store ()

	save ()

	create ()

	copy ($new_id=0)

	afterObjectLoad ()

	read ()

	update ()

	delete ()

	__call ($name, $arguments)

Static Public Member Functions
static	returnDbTableName ()

static	getInstance ($tableview_id, $field_id)

Static Public Member Functions inherited from ActiveRecord
static	returnDbTableName ()

static	installDB ()

static	renameDBField ($old_name, $new_name)

static	tableExists ()

static	fieldExists ($field_name)

static	removeDBField ($field_name)

static	updateDB ()

static	resetDB ()

static	truncateDB ()

static	flushDB ()

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, $fields=array(' *'), $operator='=', $both_external=false)

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

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

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

static	dateFormat ($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 ($set_raw=true)

static	getArray ($key=null, $values=null)

static	_toCamelCase ($str, $capitalise_first_char=false)

Protected Attributes
	$id

	$tableview_id

	$field

	$visible

	$in_filter

	$filter_value

	$filter_changeable

	$required_create

	$locked_create

	$default_value

	$visible_create

	$visible_edit

	$required_edit

	$locked_edit

Protected Attributes inherited from ActiveRecord
	$ar_safe_read = true

	$connector_container_name = ''

Additional Inherited Members
Data Fields inherited from ActiveRecord
const	ACTIVE_RECORD_VERSION = '2.0.7'

Protected Member Functions inherited from ActiveRecord
	serializeToCSV ($field)
	This method is called for every field of your instance if you use __asCsv. More...

	installDatabase ()

Static Protected Member Functions inherited from ActiveRecord
static	getCalledClass ()

static	fromCamelCase ($str)

Detailed Description

Class ilDclTableViewFieldSetting.

defines tableview/field specific settings: visible, in_filter, filter_value, filter_changeable

Author: Theodor Truffer tt@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

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

Member Function Documentation

◆ cloneStructure()

ilDclTableViewFieldSetting::cloneStructure ( ilDclTableViewFieldSetting $orig )

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

    {
        $this->setFilterChangeable($orig->isFilterChangeable());
        $this->setInFilter($orig->isInFilter());
        $this->setVisible($orig->isVisibleInList());
        $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->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 ( )

Returns: string

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

    {
        return $this->default_value;
    }

References $default_value.

◆ getField()

ilDclTableViewFieldSetting::getField ( )

Returns: int

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

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

Returns: string

Definition at line 222 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 ( )

Returns: int

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

    {
        return $this->id;
    }

References $id.

Referenced by cloneStructure().

Here is the caller graph for this function:

◆ getInstance()

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

static

Parameters

$tableview_id
$field_id

Returns: ActiveRecord

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

    {
        if ($setting = self::where(array('field' => $field_id, 'tableview_id' => $tableview_id))->first()) {
            return $setting;
        } else {
            $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:

◆ getTableviewId()

ilDclTableViewFieldSetting::getTableviewId ( )

Returns: int

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

    {
        return $this->tableview_id;
    }

References $tableview_id.

◆ isFilterChangeable()

ilDclTableViewFieldSetting::isFilterChangeable ( )

Returns: boolean

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

    {
        return $this->filter_changeable;
    }

References $filter_changeable.

Referenced by cloneStructure().

Here is the caller graph for this function:

◆ isInFilter()

ilDclTableViewFieldSetting::isInFilter ( )

Returns: boolean

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

    {
        return $this->in_filter;
    }

References $in_filter.

Referenced by cloneStructure().

Here is the caller graph for this function:

◆ isLocked()

ilDclTableViewFieldSetting::isLocked ( bool $creation_mode )

Parameters

bool $creation_mode

Returns: bool

Definition at line 445 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 ( )

Returns: bool

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

    {
        return $this->locked_create;
    }

References $locked_create.

Referenced by cloneStructure(), and isLocked().

Here is the caller graph for this function:

◆ isLockedEdit()

ilDclTableViewFieldSetting::isLockedEdit ( )

Returns: bool

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

    {
        return $this->locked_edit;
    }

References $locked_edit.

Referenced by cloneStructure(), and isLocked().

Here is the caller graph for this function:

◆ isNotVisibleCreate()

ilDclTableViewFieldSetting::isNotVisibleCreate ( )

Returns: bool

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

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

References $visible_create.

◆ isNotVisibleEdit()

ilDclTableViewFieldSetting::isNotVisibleEdit ( )

Returns: bool

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

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

References $visible_edit.

◆ isRequired()

ilDclTableViewFieldSetting::isRequired ( bool $creation_mode )

Parameters

bool $creation_mode

Returns: bool

Definition at line 454 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 ( )

Returns: bool

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

    {
        return $this->required_create;
    }

References $required_create.

Referenced by cloneStructure(), and isRequired().

Here is the caller graph for this function:

◆ isRequiredEdit()

ilDclTableViewFieldSetting::isRequiredEdit ( )

Returns: bool

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

    {
        return $this->required_edit;
    }

References $required_edit.

Referenced by cloneStructure(), and isRequired().

Here is the caller graph for this function:

◆ isVisibleCreate()

ilDclTableViewFieldSetting::isVisibleCreate ( )

Returns: bool

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

    {
        return $this->visible_create;
    }

References $visible_create.

Referenced by cloneStructure(), and isVisibleInForm().

Here is the caller graph for this function:

◆ isVisibleEdit()

ilDclTableViewFieldSetting::isVisibleEdit ( )

Returns: bool

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

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

Parameters

bool $creation_mode

Returns: bool

Definition at line 436 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 ( )

Returns: boolean

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

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

    {
        return "il_dcl_tview_set";
    }

◆ setDefaultValue()

ilDclTableViewFieldSetting::setDefaultValue ( $default_value )

Parameters

string $default_value

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

    {
        $this->default_value = $default_value;
    }

References $default_value.

◆ setField()

ilDclTableViewFieldSetting::setField ( $field )

Parameters

int $field

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

    {
        $this->field = $field;
    }

References $field.

◆ setFilterChangeable()

ilDclTableViewFieldSetting::setFilterChangeable ( $filter_changeable )

Parameters

boolean $filter_changeable

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

    {
        $this->filter_changeable = $filter_changeable;
    }

References $filter_changeable.

Referenced by cloneStructure().

Here is the caller graph for this function:

◆ setFilterValue()

ilDclTableViewFieldSetting::setFilterValue ( $filter_value )

Parameters

string $filter_value

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

    {
        $this->filter_value = $filter_value;
    }

References $filter_value.

Referenced by cloneStructure().

Here is the caller graph for this function:

◆ setId()

ilDclTableViewFieldSetting::setId ( $id )

Parameters

int $id

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

    {
        $this->id = $id;
    }

References $id.

◆ setInFilter()

ilDclTableViewFieldSetting::setInFilter ( $in_filter )

Parameters

boolean $in_filter

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

    {
        $this->in_filter = $in_filter;
    }

References $in_filter.

Referenced by cloneStructure().

Here is the caller graph for this function:

◆ setLockedCreate()

ilDclTableViewFieldSetting::setLockedCreate ( $locked_create )

Parameters

bool $locked_create

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

    {
        $this->locked_create = $locked_create;
    }

References $locked_create.

Referenced by cloneStructure().

Here is the caller graph for this function:

◆ setLockedEdit()

ilDclTableViewFieldSetting::setLockedEdit ( $locked_edit )

Parameters

bool $locked_edit

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

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

Parameters

bool $not_visible_create

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

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

◆ setNotVisibleEdit()

ilDclTableViewFieldSetting::setNotVisibleEdit ( bool $not_visible )

Parameters

bool $not_visible

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

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

◆ setRequiredCreate()

ilDclTableViewFieldSetting::setRequiredCreate ( $required_create )

Parameters

bool $required_create

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

    {
        $this->required_create = $required_create;
    }

References $required_create.

Referenced by cloneStructure().

Here is the caller graph for this function:

◆ setRequiredEdit()

ilDclTableViewFieldSetting::setRequiredEdit ( $required_edit )

Parameters

bool $required_edit

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

    {
        $this->required_edit = $required_edit;
    }

References $required_edit.

Referenced by cloneStructure().

Here is the caller graph for this function:

◆ setTableviewId()

ilDclTableViewFieldSetting::setTableviewId ( $tableview_id )

Parameters

int $tableview_id

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

    {
        $this->tableview_id = $tableview_id;
    }

References $tableview_id.

◆ setVisible()

ilDclTableViewFieldSetting::setVisible ( $visible )

Parameters

boolean $visible

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

    {
        $this->visible = $visible;
    }

References $visible.

Referenced by cloneStructure().

Here is the caller graph for this function:

◆ setVisibleCreate()

ilDclTableViewFieldSetting::setVisibleCreate ( $visible_create )

Parameters

bool $visible_create

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

    {
        $this->visible_create = $visible_create;
    }

References $visible_create.

Referenced by cloneStructure().

Here is the caller graph for this function:

◆ setVisibleEdit()

ilDclTableViewFieldSetting::setVisibleEdit ( $visible_edit )

Parameters

bool $visible_edit

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

    {
        $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 464 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: mixed|null

Reimplemented from ActiveRecord.

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

    {
        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;
    }