class.ilDclTableView.php

Go to the documentation of this file.

<?php
require_once('./Services/ActiveRecord/class.ActiveRecord.php');
require_once('./Modules/DataCollection/classes/TableView/class.ilDclTableViewFieldSetting.php');
class ilDclTableView extends ActiveRecord {

        protected $id;
        protected $table_id;
        protected $title;
        protected $roles = array();
        protected $description;
        protected $tableview_order;
        protected $visible_fields_cache;


        static function returnDbTableName() {
                return "il_dcl_tableview";
        }


        public function getId() {
                return $this->id;
        }


        public function setId($id) {
                $this->id = $id;
        }


        public function getTableId() {
                return $this->table_id;
        }


        public function setTableId($table_id) {
                $this->table_id = $table_id;
        }


        public function getTitle() {
                return $this->title;
        }


        public function setTitle($title) {
                $this->title = $title;
        }


        public function getOrder() {
                return $this->tableview_order;
        }


        public function setOrder($order) {
                $this->tableview_order = $order;
        }


        public function getDescription() {
                return $this->description;
        }


        public function setDescription($description) {
                $this->description = $description;
        }


        public function getTableviewOrder() {
                return $this->tableview_order;
        }


        public function setTableviewOrder($tableview_order) {
                $this->tableview_order = $tableview_order;
        }


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


        public function setRoles(array $roles) {
                $this->roles = $roles;
        }


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

                return null;
        }


        public function wakeUp($field_name, $field_value) {
                if ($field_name == 'roles') {
                        return json_decode($field_value);
                }

                return null;
        }


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


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


        public function getFilterableFieldSettings() {
                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();
        }


        public function getVisibleFields() {
                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;
        }


        public function getFieldSettings() {
                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();
        }


        public function create($create_default_settings = true) {
                parent::create();
                if ($create_default_settings) {
                        $this->createDefaultSettings();
                }
        }


        public function createDefaultSettings() {
                $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');
                }
        }


        public function createFieldSetting($field_id) {
                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();
                }
        }


        public function cloneStructure(ilDclTableView $orig, array $new_fields) {
                //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);
        }


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


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


        public static function createOrGetStandardView($table_id, $create_default_settings = true) {
                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;
        }
}