Inheritance diagram for ilDclTableView:

Collaboration diagram for ilDclTableView:

Public Member Functions
	getId ()

	setId (int $id)

	getTableId ()

	setTableId (int $table_id)

	getTitle ()

	setTitle (string $title)

	getOrder ()

	setOrder (int $order)

	getDescription ()

	setDescription (string $description)

	getTableviewOrder ()

	setTableviewOrder (int $tableview_order)

	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 ()
	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	getCountForTableId (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 ()
	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 = ''

int	$tableview_order = 0

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 ()
	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.ilDclTableView.php.

Member Function Documentation

◆ cloneStructure()

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

Parameters

ilDclTableView	$orig
array	$new_fields	fields mapping

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

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

                                                                            : void
     {
         global $DIC;
         //clone structure
         $this->setTitle($orig->getTitle() . ' ' . $DIC->language()->txt('copy_of_suffix'));
         $this->setOrder($orig->getOrder());
         $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);
     }

Here is the call graph for this function:

◆ create()

ilDclTableView::create ( bool $create_default_settings = true )

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

References createDefaultSettings().

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

Here is the call graph for this function:

◆ createDefaultSettings()

ilDclTableView::createDefaultSettings ( )

create default ilDclTableViewFieldSetting entries

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

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

Referenced by create().

                                            : 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');
         }
     }

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 332 of file class.ilDclTableView.php.

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

Referenced by cloneStructure(), and createDefaultSettings().

                                                  : 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();
         }
     }

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 427 of file class.ilDclTableView.php.

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

Referenced by ilDclTable\doCreate(), and ilDataCollectionDataSet\getXmlNamespace().

                                                                  : ActiveRecord
     {
         if ($standardview = self::where(['table_id' => $table_id])->orderBy('tableview_order')->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->setTableviewOrder(10);
         $view->create();
 
         return $view;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ delete()

ilDclTableView::delete ( )

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

References getFieldSettings().

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

Here is the call graph for this function:

◆ findOrGetInstance()

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

static

Returns: ActiveRecord|ilDclTableView

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

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

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

Here is the caller graph for this function:

◆ getAllForTableId()

static ilDclTableView::getAllForTableId ( int $table_id )

static

Returns: ilDclTableView[]|ActiveRecord[]

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

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

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

Here is the caller graph for this function:

◆ getCountForTableId()

static ilDclTableView::getCountForTableId ( int $table_id )

static

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

Referenced by ilDclTable\getNewTableviewOrder().

                                                             : int
     {
         return self::where(['table_id' => $table_id])->orderBy('tableview_order')->count();
     }

Here is the caller graph for this function:

◆ getDescription()

ilDclTableView::getDescription ( )

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

References $description.

Referenced by cloneStructure().

                                     : string
     {
         return $this->description;
     }

Here is the caller graph for this function:

◆ getFieldSetting()

ilDclTableView::getFieldSetting ( $field_id )

Parameters

$field_id

Returns: ilDclTableViewFieldSetting|ActiveRecord

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

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

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

Here is the call graph for this function:

◆ getFieldSettings()

ilDclTableView::getFieldSettings ( )

Returns: ilDclTableViewFieldSetting[]

Exceptions

arException

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

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

Referenced by cloneStructure(), and delete().

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

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 224 of file class.ilDclTableView.php.

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

                                                 : 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();
     }

Here is the call graph for this function:

◆ getId()

ilDclTableView::getId ( )

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

References $id.

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

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

Here is the caller graph for this function:

◆ getOrder()

ilDclTableView::getOrder ( )

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

References $tableview_order.

Referenced by cloneStructure().

                               : int
     {
         return $this->tableview_order;
     }

Here is the caller graph for this function:

◆ getRoleLimitation()

ilDclTableView::getRoleLimitation ( )

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

References $role_limitation.

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

                                        : bool
     {
         return $this->role_limitation;
     }

Here is the caller graph for this function:

◆ getRoles()

ilDclTableView::getRoles ( )

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

References $roles.

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

                               : array
     {
         return $this->roles;
     }

Here is the caller graph for this function:

◆ getTable()

ilDclTableView::getTable ( )

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

References ilDclCache\getTableCache().

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

Here is the call graph for this function:

◆ getTableId()

ilDclTableView::getTableId ( )

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

References $table_id.

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

                                 : int
     {
         return $this->table_id;
     }

Here is the caller graph for this function:

◆ getTableviewOrder()

ilDclTableView::getTableviewOrder ( )

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

References $tableview_order.

                                        : int
     {
         return $this->tableview_order;
     }

◆ getTitle()

ilDclTableView::getTitle ( )

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

References $title.

Referenced by cloneStructure().

                               : string
     {
         return $this->title;
     }

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 241 of file class.ilDclTableView.php.

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

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

Here is the call graph for this function:

◆ returnDbTableName()

static ilDclTableView::returnDbTableName ( )

static

Returns: string Return the Name of your Database Table

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

                                               : string
     {
         return "il_dcl_tableview";
     }

◆ setDescription()

ilDclTableView::setDescription ( string $description )

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

References $description.

Referenced by cloneStructure().

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

Here is the caller graph for this function:

◆ setId()

ilDclTableView::setId ( int $id )

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

References $id.

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

◆ setOrder()

ilDclTableView::setOrder ( int $order )

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

Referenced by cloneStructure().

                                         : void
     {
         $this->tableview_order = $order;
     }

Here is the caller graph for this function:

◆ setRoleLimitation()

ilDclTableView::setRoleLimitation ( bool $role_limitation )

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

References $role_limitation.

Referenced by cloneStructure().

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

Here is the caller graph for this function:

◆ setRoles()

ilDclTableView::setRoles ( array $roles )

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

References $roles.

Referenced by cloneStructure().

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

Here is the caller graph for this function:

◆ setTableId()

ilDclTableView::setTableId ( int $table_id )

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

References $table_id.

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

◆ setTableviewOrder()

ilDclTableView::setTableviewOrder ( int $tableview_order )

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

References $tableview_order.

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

◆ setTitle()

ilDclTableView::setTitle ( string $title )

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

References $title.

Referenced by cloneStructure().

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

Here is the caller graph for this function:

◆ sleep()

ilDclTableView::sleep ( $field_name )

Parameters

string $field_name

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

References null.

                                       : ?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

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

References null.

                                                      : ?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 getRoles(), and setRoles().

◆ $table_id

int ilDclTableView::$table_id = 0

protected

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

Referenced by getTableId(), and setTableId().

◆ $tableview_order

int ilDclTableView::$tableview_order = 0

protected

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

Referenced by getOrder(), getTableviewOrder(), and setTableviewOrder().

◆ $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 81 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()

◆ getCountForTableId()

◆ getDescription()

◆ getFieldSetting()

◆ getFieldSettings()

◆ getFilterableFieldSettings()

◆ getId()

◆ getOrder()

◆ getRoleLimitation()

◆ getRoles()

◆ getTable()

◆ getTableId()

◆ getTableviewOrder()

◆ getTitle()

◆ getVisibleFields()

◆ returnDbTableName()

◆ setDescription()

◆ setId()

◆ setOrder()

◆ setRoleLimitation()

◆ setRoles()

◆ setTableId()

◆ setTableviewOrder()

◆ setTitle()

◆ sleep()

◆ wakeUp()

Field Documentation

◆ $description

◆ $id

◆ $role_limitation

◆ $roles

◆ $table_id

◆ $tableview_order

◆ $title

◆ $visible_fields_cache