Inheritance diagram for ilDclTableView:

Collaboration diagram for ilDclTableView:

Public Member Functions
	getId ()

	setId (int $id)

	getTableId ()

	setTableId (int $table_id)

	getTitle ()

	setTitle (string $title)

	getDescription ()

	setDescription (string $description)

	getRoles ()

	setRoles (array $roles)

	getRoleLimitation ()

	setRoleLimitation (bool $role_limitation)

	sleep ($field_name)

	wakeUp ($field_name, $field_value)

	delete ()

	getTable ()

	getFilterableFieldSettings ()
	getFilterableFields Returns all fieldsetting-objects of this tableview which have set their filterable to true, including standard fields. More...

	getVisibleFields ()
	Returns all field-objects of this tableview which have set their visibility to true, including standard fields. More...

	getFieldSettings ()

	getFieldSetting ($field_id)

	create (bool $create_default_settings=true)

	createDefaultSettings ()
	create default ilDclTableViewFieldSetting entries More...

	createFieldSetting ($field_id)
	create ilDclTableViewFieldSetting for this tableview and the given field id More...

	cloneStructure (ilDclTableView $orig, array $new_fields)

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 (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	findOrGetInstance ($primary_key, array $add_constructor_args=[])

static	getAllForTableId (int $table_id)

static	createOrGetStandardView (int $table_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=[])
	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	$table_id = 0

string	$title = ""

array	$roles = []

bool	$role_limitation = false

string	$description = ''

array	$visible_fields_cache = []

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

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

Member Function Documentation

◆ cloneStructure()

ilDclTableView::cloneStructure	(	ilDclTableView	$orig,
		array	$new_fields
	)

Parameters

ilDclTableView	$orig
array	$new_fields	fields mapping

Definition at line 333 of file class.ilDclTableView.php.

                                                                           : void
    {
        global $DIC;
        //clone structure
        $this->setTitle($orig->getTitle() . ' ' . $DIC->language()->txt('copy_of_suffix'));
        $this->setDescription($orig->getDescription());
        $this->setRoles($orig->getRoles());
        $this->setRoleLimitation($orig->getRoleLimitation());
        $this->create(false); //create default setting, adjust them later
 
        //clone default values
        $f = new ilDclDefaultValueFactory();
 
        //clone fieldsettings
        foreach ($orig->getFieldSettings() as $orig_fieldsetting) {
            $new_fieldsetting = new ilDclTableViewFieldSetting();
            $new_fieldsetting->setTableviewId($this->getId());
            if ($new_fields[$orig_fieldsetting->getField()] ?? null) {
                //normal fields
                $new_fieldsetting->setField($new_fields[$orig_fieldsetting->getField()]->getId());
            } else {
                //standard fields
                $new_fieldsetting->setField($orig_fieldsetting->getField());
            }
            $new_field_id = $new_fieldsetting->cloneStructure($orig_fieldsetting);
 
            //clone default value
            $datatype = $orig_fieldsetting->getFieldObject()->getDatatypeId();
            $match = ilDclTableViewBaseDefaultValue::findSingle($datatype, $orig_fieldsetting->getId());
 
            if (!is_null($match)) {
                $new_default_value = $f->create($datatype);
                $new_default_value->setTviewSetId($new_field_id);
                $new_default_value->setValue($match->getValue());
                $new_default_value->create();
            }
        }
        $this->createFieldSetting('comments');
 
        //clone pageobject
        if (ilDclDetailedViewDefinition::exists($orig->getId())) {
            $orig_pageobject = new ilDclDetailedViewDefinition($orig->getId());
            $orig_pageobject->copy($this->getId());
        }
 
        // mandatory for all cloning functions
        ilDclCache::setCloneOf($orig->getId(), $this->getId(), ilDclCache::TYPE_TABLEVIEW);
    }

References $DIC, Vendor\Package\$f, ActiveRecord\create(), createFieldSetting(), ilDclDetailedViewDefinition\exists(), getDescription(), getFieldSettings(), getId(), getRoleLimitation(), getRoles(), getTitle(), ilDclCache\setCloneOf(), setDescription(), setRoleLimitation(), setRoles(), setTitle(), and ilDclCache\TYPE_TABLEVIEW.

Here is the call graph for this function:

◆ create()

ilDclTableView::create ( bool $create_default_settings = true )

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

                                                                : void
    {
        parent::create();
        if ($create_default_settings) {
            $this->createDefaultSettings();
        }
    }

References createDefaultSettings().

Here is the call graph for this function:

◆ createDefaultSettings()

ilDclTableView::createDefaultSettings ( )

create default ilDclTableViewFieldSetting entries

Definition at line 286 of file class.ilDclTableView.php.

                                           : void
    {
        $table = ilDclCache::getTableCache($this->table_id);
 
        foreach ($table->getFieldIds() as $field_id) {
            $this->createFieldSetting($field_id);
        }
 
        //ilDclTable->getFieldIds won't reuturn comments if they are disabled,
        //still we have to create a fieldsetting for this field
        if (!$table->getPublicCommentsEnabled()) {
            $this->createFieldSetting('comments');
        }
    }

References createFieldSetting(), and ilDclCache\getTableCache().

Referenced by create().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createFieldSetting()

ilDclTableView::createFieldSetting ( $field_id )

create ilDclTableViewFieldSetting for this tableview and the given field id

Parameters

int | string $field_id

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

                                                 : void
    {
        if (!ilDclTableViewFieldSetting::where(
            [
                'tableview_id' => $this->id,
                'field' => $field_id,
            ]
        )->get()
        ) {
            $field_set = new ilDclTableViewFieldSetting();
            $field_set->setTableviewId($this->id);
            $field_set->setField($field_id);
            $field_set->setVisible(!ilDclStandardField::_isStandardField($field_id));
            $field_set->setFilterChangeable(true);
            $field_set->setLockedCreate(false);
            $field_set->setLockedEdit(false);
            $field_set->setRequiredCreate(false);
            $field_set->setRequiredEdit(false);
            $field_set->setVisibleCreate(true);
            $field_set->setVisibleEdit(true);
            $field_set->create();
        }
    }

References ilDclStandardField\_isStandardField(), and ActiveRecord\where().

Referenced by cloneStructure(), and createDefaultSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createOrGetStandardView()

static ilDclTableView::createOrGetStandardView ( int $table_id )

static

Parameters

$table_id

Returns: ilDclTableView|ActiveRecord

Definition at line 394 of file class.ilDclTableView.php.

                                                                 : ActiveRecord
    {
        if ($standardview = self::where(['table_id' => $table_id])->first()) {
            return $standardview;
        }
 
        global $DIC;
        $rbacreview = $DIC['rbacreview'];
        $http = $DIC->http();
        $refinery = $DIC->refinery();
 
        $roles = [];
 
        $ref_id = $http->wrapper()->query()->retrieve('ref_id', $refinery->kindlyTo()->int());
        foreach ($rbacreview->getParentRoleIds($ref_id) as $role_array) {
            $roles[] = $role_array['obj_id'];
        }
 
        $view = new self();
 
        $hasRefId = $http->wrapper()->query()->has('ref_id');
 
        if ($hasRefId) {
            global $DIC;
            $rbacreview = $DIC['rbacreview'];
 
            $ref_id = $http->wrapper()->query()->retrieve('ref_id', $refinery->kindlyTo()->int());
 
            $roles = [];
            foreach ($rbacreview->getParentRoleIds($ref_id) as $role_array) {
                $roles[] = $role_array['obj_id'];
            }
            $view->setRoles(array_merge($roles, $rbacreview->getLocalRoles($ref_id)));
        }
        $view->setTableId($table_id);
        // bugfix mantis 0023307
        $lng = $DIC['lng'];
        $view->setTitle($lng->txt('dcl_title_standardview'));
        $view->create();
 
        return $view;
    }

References $DIC, $http, $lng, $ref_id, ILIAS\UI\examples\Layout\Page\Mail\$refinery, $roles, $table_id, and ActiveRecord\first().

Referenced by ilDclTable\doCreate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ delete()

ilDclTableView::delete ( )

Reimplemented from ActiveRecord.

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

                            : void
    {
        //Delete settings
        foreach ($this->getFieldSettings() as $setting) {
            $setting->delete();
        }
        parent::delete();
    }

References getFieldSettings().

Here is the call graph for this function:

◆ findOrGetInstance()

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

static

Returns: ActiveRecord|ilDclTableView

Reimplemented from ActiveRecord.

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

                                                                                            : ActiveRecord
    {
        return parent::findOrGetInstance($primary_key, $add_constructor_args);
    }

Referenced by ilDclRecordEditGUI\__construct(), ilDclCreateViewDefinitionGUI\__construct(), ilDclEditViewDefinitionGUI\__construct(), and ilDclTableViewGUI\executeCommand().

Here is the caller graph for this function:

◆ getAllForTableId()

static ilDclTableView::getAllForTableId ( int $table_id )

static

Returns: ilDclTableView[]|ActiveRecord[]

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

                                                          : array
    {
        return self::where(['table_id' => $table_id])->orderBy('title')->get();
    }

References $table_id, and ActiveRecord\where().

Referenced by ilDclBaseFieldModel\addToTableViews(), and ilDclTable\getTableViews().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDescription()

ilDclTableView::getDescription ( )

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

                                    : string
    {
        return $this->description;
    }

References $description.

Referenced by cloneStructure().

Here is the caller graph for this function:

◆ getFieldSetting()

ilDclTableView::getFieldSetting ( $field_id )

Parameters

$field_id

Returns: ilDclTableViewFieldSetting|ActiveRecord

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

                                              : ActiveRecord
    {
        return ilDclTableViewFieldSetting::where([
            'tableview_id' => $this->getId(),
            'field' => $field_id
        ])->first();
    }

References getId(), and ActiveRecord\where().

Here is the call graph for this function:

◆ getFieldSettings()

ilDclTableView::getFieldSettings ( )

Returns: ilDclTableViewFieldSetting[]

Exceptions

arException

Definition at line 243 of file class.ilDclTableView.php.

                                      : array
    {
        $settings = ilDclTableViewFieldSetting::where(
            [
                'tableview_id' => $this->getId(),
                'il_dcl_tfield_set.table_id' => $this->getTableId(),
            ]
        )->innerjoin('il_dcl_tfield_set', 'field', 'field', [])->orderBy('il_dcl_tfield_set.field_order')->get();
 
        $result = [];
        foreach ($settings as $setting) {
            $datatype = $setting->getFieldObject()->getDatatypeId();
            if ($datatype === null || in_array($datatype, array_keys(ilDclDatatype::getAllDatatype()))) {
                $result[] = $setting;
            }
        }
 
        return $result;
    }

References ilDclDatatype\getAllDatatype(), getId(), getTableId(), and ActiveRecord\where().

Referenced by cloneStructure(), and delete().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFilterableFieldSettings()

ilDclTableView::getFilterableFieldSettings ( )

getFilterableFields Returns all fieldsetting-objects of this tableview which have set their filterable to true, including standard fields.

Returns: ilDclBaseFieldModel[]|ilDclTableViewFieldSetting[]

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

                                                : array
    {
        return ilDclTableViewFieldSetting::where(
            [
                "tableview_id" => $this->id,
                'in_filter' => 1,
                'il_dcl_tfield_set.table_id' => $this->getTableId(),
            ]
        )->innerjoin('il_dcl_tfield_set', 'field', 'field', [])
                                         ->orderBy('il_dcl_tfield_set.field_order')
                                         ->get();
    }

References getTableId(), and ActiveRecord\where().

Here is the call graph for this function:

◆ getId()

ilDclTableView::getId ( )

Definition at line 85 of file class.ilDclTableView.php.

                           : ?int
    {
        return $this->id;
    }

References $id.

Referenced by cloneStructure(), ilDclTableViewGUI\getActions(), getFieldSetting(), and getFieldSettings().

Here is the caller graph for this function:

◆ getRoleLimitation()

ilDclTableView::getRoleLimitation ( )

Definition at line 135 of file class.ilDclTableView.php.

                                       : bool
    {
        return $this->role_limitation;
    }

References $role_limitation.

Referenced by cloneStructure(), and ilObjDataCollectionAccess\hasAccessToTableView().

Here is the caller graph for this function:

◆ getRoles()

ilDclTableView::getRoles ( )

Definition at line 125 of file class.ilDclTableView.php.

                              : array
    {
        return $this->roles;
    }

References $roles.

Referenced by cloneStructure(), and ilObjDataCollectionAccess\hasAccessToTableView().

Here is the caller graph for this function:

◆ getTable()

ilDclTableView::getTable ( )

Definition at line 179 of file class.ilDclTableView.php.

                              : ilDclTable
    {
        return ilDclCache::getTableCache($this->table_id);
    }

References ilDclCache\getTableCache().

Here is the call graph for this function:

◆ getTableId()

ilDclTableView::getTableId ( )

Definition at line 95 of file class.ilDclTableView.php.

                                : int
    {
        return $this->table_id;
    }

References $table_id.

Referenced by getFieldSettings(), getFilterableFieldSettings(), and getVisibleFields().

Here is the caller graph for this function:

◆ getTitle()

ilDclTableView::getTitle ( )

Definition at line 105 of file class.ilDclTableView.php.

                              : string
    {
        return $this->title;
    }

References $title.

Referenced by cloneStructure().

Here is the caller graph for this function:

◆ getVisibleFields()

ilDclTableView::getVisibleFields ( )

Returns all field-objects of this tableview which have set their visibility to true, including standard fields.

Returns: ilDclBaseFieldModel[]|ilDclTableViewFieldSetting[]

Definition at line 214 of file class.ilDclTableView.php.

                                      : array
    {
        if (!$this->visible_fields_cache) {
            $visible = ilDclTableViewFieldSetting::where(
                [
                    "tableview_id" => $this->id,
                    'visible' => true,
                    'il_dcl_tfield_set.table_id' => $this->getTableId(),
                ]
            )->innerjoin(
                'il_dcl_tfield_set',
                'field',
                'field',
                []
            )->orderBy('il_dcl_tfield_set.field_order')->get();
            $fields = [];
            foreach ($visible as $field_rec) {
                $fields[] = $field_rec->getFieldObject();
            }
            $this->visible_fields_cache = $fields;
        }
 
        return $this->visible_fields_cache;
    }

References $visible_fields_cache, getTableId(), and ActiveRecord\where().

Here is the call graph for this function:

◆ returnDbTableName()

static ilDclTableView::returnDbTableName ( )

static

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

Reimplemented from ActiveRecord.

Definition at line 80 of file class.ilDclTableView.php.

                                              : string
    {
        return "il_dcl_tableview";
    }

◆ setDescription()

ilDclTableView::setDescription ( string $description )

Definition at line 120 of file class.ilDclTableView.php.

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

References $description.

Referenced by cloneStructure().

Here is the caller graph for this function:

◆ setId()

ilDclTableView::setId ( int $id )

Definition at line 90 of file class.ilDclTableView.php.

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

References $id.

◆ setRoleLimitation()

ilDclTableView::setRoleLimitation ( bool $role_limitation )

Definition at line 140 of file class.ilDclTableView.php.

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

References $role_limitation.

Referenced by cloneStructure().

Here is the caller graph for this function:

◆ setRoles()

ilDclTableView::setRoles ( array $roles )

Definition at line 130 of file class.ilDclTableView.php.

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

References $roles.

Referenced by cloneStructure().

Here is the caller graph for this function:

◆ setTableId()

ilDclTableView::setTableId ( int $table_id )

Definition at line 100 of file class.ilDclTableView.php.

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

References $table_id.

◆ setTitle()

ilDclTableView::setTitle ( string $title )

Definition at line 110 of file class.ilDclTableView.php.

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

References $title.

Referenced by cloneStructure().

Here is the caller graph for this function:

◆ sleep()

ilDclTableView::sleep ( $field_name )

Parameters

string $field_name

Reimplemented from ActiveRecord.

Definition at line 148 of file class.ilDclTableView.php.

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

◆ wakeUp()

ilDclTableView::wakeUp	(	$field_name,
		$field_value
	)

Parameters

string	$field_name
int \| string	$field_value

Reimplemented from ActiveRecord.

Definition at line 161 of file class.ilDclTableView.php.

                                                     : ?array
    {
        if ($field_name == 'roles') {
            return json_decode($field_value);
        }
 
        return null;
    }

Field Documentation

◆ $description

string ilDclTableView::$description = ''

protected

Definition at line 70 of file class.ilDclTableView.php.

Referenced by getDescription(), and setDescription().

◆ $id

int ilDclTableView::$id

protected

Definition at line 33 of file class.ilDclTableView.php.

Referenced by getId(), and setId().

◆ $role_limitation

bool ilDclTableView::$role_limitation = false

protected

Definition at line 63 of file class.ilDclTableView.php.

Referenced by getRoleLimitation(), and setRoleLimitation().

◆ $roles

array ilDclTableView::$roles = []

protected

Definition at line 56 of file class.ilDclTableView.php.

Referenced by createOrGetStandardView(), getRoles(), and setRoles().

◆ $table_id

int ilDclTableView::$table_id = 0

protected

Definition at line 41 of file class.ilDclTableView.php.

Referenced by createOrGetStandardView(), getAllForTableId(), getTableId(), and setTableId().

◆ $title

string ilDclTableView::$title = ""

protected

Definition at line 49 of file class.ilDclTableView.php.

Referenced by getTitle(), and setTitle().

◆ $visible_fields_cache

array ilDclTableView::$visible_fields_cache = []

protected

Definition at line 74 of file class.ilDclTableView.php.

Referenced by getVisibleFields().

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

components/ILIAS/DataCollection/classes/TableView/class.ilDclTableView.php

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ cloneStructure()

◆ create()

◆ createDefaultSettings()

◆ createFieldSetting()

◆ createOrGetStandardView()

◆ delete()

◆ findOrGetInstance()

◆ getAllForTableId()

◆ getDescription()

◆ getFieldSetting()

◆ getFieldSettings()

◆ getFilterableFieldSettings()

◆ getId()

◆ getRoleLimitation()

◆ getRoles()

◆ getTable()

◆ getTableId()

◆ getTitle()

◆ getVisibleFields()

◆ returnDbTableName()

◆ setDescription()

◆ setId()

◆ setRoleLimitation()

◆ setRoles()

◆ setTableId()

◆ setTitle()

◆ sleep()

◆ wakeUp()

Field Documentation

◆ $description

◆ $id

◆ $role_limitation

◆ $roles

◆ $table_id

◆ $title

◆ $visible_fields_cache