Inheritance diagram for ilDclTableView:

Collaboration diagram for ilDclTableView:

Public Member Functions
	getId ()

	setId ($id)

	getTableId ()

	setTableId ($table_id)

	getTitle ()

	setTitle ($title)

	getOrder ()

	setOrder ($order)

	getDescription ()

	setDescription ($description)

	getTableviewOrder ()

	setTableviewOrder ($tableview_order)

	getRoles ()

	setRoles (array $roles)

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

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

	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	getAllForTableId ($table_id)

static	getCountForTableId ($table_id)

static	createOrGetStandardView ($table_id, $create_default_settings=true)

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

	$table_id

	$title

	$roles = array()

	$description

	$tableview_order

	$visible_fields_cache

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 ilDclTableView.

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

Definition at line 9 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 379 of file class.ilDclTableView.php.

References ilPageObject\copy(), ActiveRecord\create(), ilDclDetailedViewDefinition\exists(), getDescription(), getFieldSettings(), getId(), getOrder(), getRoles(), getTitle(), ilDclCache\setCloneOf(), setDescription(), setOrder(), setRoles(), setTitle(), and ilDclCache\TYPE_TABLEVIEW.

     {
         //clone structure
         $this->setTitle($orig->getTitle());
         $this->setOrder($orig->getOrder());
         $this->setDescription($orig->getDescription());
         $this->setRoles($orig->getRoles());
         $this->create(false); //create default setting, adjust them later
 
         //clone fieldsettings
         foreach ($orig->getFieldSettings() as $orig_fieldsetting) {
             $new_fieldsetting = new ilDclTableViewFieldSetting();
             $new_fieldsetting->setTableviewId($this->getId());
             if ($new_fields[$orig_fieldsetting->getField()]) {
                 //normal fields
                 $new_fieldsetting->setField($new_fields[$orig_fieldsetting->getField()]->getId());
             } else {
                 //standard fields
                 $new_fieldsetting->setField($orig_fieldsetting->getField());
             }
             $new_fieldsetting->cloneStructure($orig_fieldsetting);
         }
 
         //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 ( $create_default_settings = true )

Parameters

bool $create_default_settings

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

References createDefaultSettings().

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

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

Referenced by create().

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

$field_id

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

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

Referenced by createDefaultSettings().

     {
         if (!ilDclTableViewFieldSetting::where(
             array(
                 '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->create();
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createOrGetStandardView()

static ilDclTableView::createOrGetStandardView	(	$table_id,
		$create_default_settings = `true`
	)

static

Parameters

	$table_id
bool	$create_default_settings

Returns: ilDclTableView

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

References $_GET, $DIC, $lng, $roles, $table_id, ActiveRecord\first(), and ActiveRecord\orderBy().

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

     {
         if ($standardview = self::where(array('table_id' => $table_id))->orderBy('tableview_order')->first()) {
             return $standardview;
         }
 
         global $DIC;
         $rbacreview = $DIC['rbacreview'];
         $roles = array();
         foreach ($rbacreview->getParentRoleIds($_GET['ref_id']) as $role_array) {
             $roles[] = $role_array['obj_id'];
         }
 
         $view = new self();
 
         if ($_GET['ref_id']) {
             global $DIC;
             $rbacreview = $DIC['rbacreview'];
             $roles = array();
             foreach ($rbacreview->getParentRoleIds($_GET['ref_id']) as $role_array) {
                 $roles[] = $role_array['obj_id'];
             }
             $view->setRoles(array_merge($roles, $rbacreview->getLocalRoles($_GET['ref_id'])));
         }
         $view->setTableId($table_id);
         // bugfix mantis 0023307
         $lng = $DIC['lng'];
         $view->setTitle($lng->txt('dcl_title_standardview'));
         $view->setTableviewOrder(10);
         $view->create($create_default_settings);
 
         return $view;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ delete()

ilDclTableView::delete ( )

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

References getFieldSettings().

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

Here is the call graph for this function:

◆ getAllForTableId()

static ilDclTableView::getAllForTableId ( $table_id )

static

Parameters

$table_id

Returns: ilDclTableView[]

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

References $table_id.

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

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

Here is the caller graph for this function:

◆ getCountForTableId()

static ilDclTableView::getCountForTableId ( $table_id )

static

Parameters

$table_id

Returns: int

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

References $table_id.

Referenced by ilDclTable\getNewTableviewOrder().

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

Here is the caller graph for this function:

◆ getDescription()

ilDclTableView::getDescription ( )

Returns: string

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

References $description.

Referenced by cloneStructure().

     {
         return $this->description;
     }

Here is the caller graph for this function:

◆ getFieldSettings()

ilDclTableView::getFieldSettings ( )

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

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

Referenced by cloneStructure(), and delete().

     {
         return ilDclTableViewFieldSetting::where(
             array(
                 'tableview_id' => $this->getId(),
                 'il_dcl_tfield_set.table_id' => $this->getTableId(),
             )
         )->innerjoin('il_dcl_tfield_set', 'field', 'field', array('field_order'))->orderBy('field_order')->get();
     }

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

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

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

Here is the call graph for this function:

◆ getId()

ilDclTableView::getId ( )

Returns: int

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

References $id.

Referenced by cloneStructure(), and getFieldSettings().

     {
         return $this->id;
     }

Here is the caller graph for this function:

◆ getOrder()

ilDclTableView::getOrder ( )

Returns: int

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

References $tableview_order.

Referenced by cloneStructure().

     {
         return $this->tableview_order;
     }

Here is the caller graph for this function:

◆ getRoles()

ilDclTableView::getRoles ( )

Returns: array

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

References $roles.

Referenced by cloneStructure().

     {
         return (array) $this->roles;
     }

Here is the caller graph for this function:

◆ getTable()

ilDclTableView::getTable ( )

Returns: ilDclTable

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

References ilDclCache\getTableCache().

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

Here is the call graph for this function:

◆ getTableId()

ilDclTableView::getTableId ( )

Returns: int

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

References $table_id.

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

     {
         return $this->table_id;
     }

Here is the caller graph for this function:

◆ getTableviewOrder()

ilDclTableView::getTableviewOrder ( )

Returns: int

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

References $tableview_order.

     {
         return $this->tableview_order;
     }

◆ getTitle()

ilDclTableView::getTitle ( )

Returns: string

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

References $title.

Referenced by cloneStructure().

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

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

     {
         if (!$this->visible_fields_cache) {
             $visible = ilDclTableViewFieldSetting::
             where(
                 array(
                     "tableview_id" => $this->id,
                     'visible' => true,
                     'il_dcl_tfield_set.table_id' => $this->getTableId(),
                 )
             )->innerjoin('il_dcl_tfield_set', 'field', 'field', array())->orderBy('il_dcl_tfield_set.field_order')->get();
             $fields = array();
             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 77 of file class.ilDclTableView.php.

     {
         return "il_dcl_tableview";
     }

◆ setDescription()

ilDclTableView::setDescription ( $description )

Parameters

string $description

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

References $description.

Referenced by cloneStructure().

     {
         $this->description = $description;
     }

Here is the caller graph for this function:

◆ setId()

ilDclTableView::setId ( $id )

Parameters

int $id

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

References $id.

     {
         $this->id = $id;
     }

◆ setOrder()

ilDclTableView::setOrder ( $order )

Parameters

int $order

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

Referenced by cloneStructure().

     {
         $this->tableview_order = $order;
     }

Here is the caller graph for this function:

◆ setRoles()

ilDclTableView::setRoles ( array $roles )

Parameters

array $roles

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

References $roles.

Referenced by cloneStructure().

     {
         $this->roles = $roles;
     }

Here is the caller graph for this function:

◆ setTableId()

ilDclTableView::setTableId ( $table_id )

Parameters

int $table_id

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

References $table_id.

     {
         $this->table_id = $table_id;
     }

◆ setTableviewOrder()

ilDclTableView::setTableviewOrder ( $tableview_order )

Parameters

int $tableview_order

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

References $tableview_order.

     {
         $this->tableview_order = $tableview_order;
     }

◆ setTitle()

ilDclTableView::setTitle ( $title )

Parameters

string $title

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

References $title.

Referenced by cloneStructure().

     {
         $this->title = $title;
     }

Here is the caller graph for this function:

◆ sleep()

ilDclTableView::sleep ( $field_name )

Parameters

$field_name

Returns: null|string

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

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

◆ wakeUp()

ilDclTableView::wakeUp	(	$field_name,
		$field_value
	)

Parameters

$field_name
$field_value

Returns: mixed|null

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

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

Field Documentation

◆ $description

ilDclTableView::$description

protected

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

Referenced by getDescription(), and setDescription().

◆ $id

ilDclTableView::$id

protected

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

Referenced by getId(), and setId().

◆ $roles

ilDclTableView::$roles = array()

protected

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

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

◆ $table_id

ilDclTableView::$table_id

protected

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

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

◆ $tableview_order

ilDclTableView::$tableview_order

protected

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

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

◆ $title

ilDclTableView::$title

protected

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

Referenced by getTitle(), and setTitle().

◆ $visible_fields_cache

ilDclTableView::$visible_fields_cache

protected

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

Referenced by getVisibleFields().

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

Modules/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()

◆ getAllForTableId()

◆ getCountForTableId()

◆ getDescription()

◆ getFieldSettings()

◆ getFilterableFieldSettings()

◆ getId()

◆ getOrder()

◆ getRoles()

◆ getTable()

◆ getTableId()

◆ getTableviewOrder()

◆ getTitle()

◆ getVisibleFields()

◆ returnDbTableName()

◆ setDescription()

◆ setId()

◆ setOrder()

◆ setRoles()

◆ setTableId()

◆ setTableviewOrder()

◆ setTitle()

◆ sleep()

◆ wakeUp()

Field Documentation

◆ $description

◆ $id

◆ $roles

◆ $table_id

◆ $tableview_order

◆ $title

◆ $visible_fields_cache