class.ilDclTableViewFieldSetting.php

Go to the documentation of this file.

<?php

class ilDclTableViewFieldSetting extends ActiveRecord
{

    protected $id;
    protected $tableview_id;
    protected $field;
    protected $visible;
    protected $in_filter;
    protected $filter_value;
    protected $filter_changeable;
    protected $required_create;
    protected $locked_create;
    protected $default_value;
    protected $visible_create;
    protected $visible_edit;
    protected $required_edit;
    protected $locked_edit;


    public static function returnDbTableName()
    {
        return "il_dcl_tview_set";
    }


    public function getTableviewId()
    {
        return $this->tableview_id;
    }


    public function setTableviewId($tableview_id)
    {
        $this->tableview_id = $tableview_id;
    }


    public function getField()
    {
        return $this->field;
    }


    public function setField($field)
    {
        $this->field = $field;
    }


    public function isVisibleInList()
    {
        return $this->visible;
    }


    public function setVisible($visible)
    {
        $this->visible = $visible;
    }


    public function isInFilter()
    {
        return $this->in_filter;
    }


    public function setInFilter($in_filter)
    {
        $this->in_filter = $in_filter;
    }


    public function getFilterValue()
    {
        return $this->filter_value;
    }


    public function setFilterValue($filter_value)
    {
        $this->filter_value = $filter_value;
    }


    public function isFilterChangeable()
    {
        return $this->filter_changeable;
    }


    public function setFilterChangeable($filter_changeable)
    {
        $this->filter_changeable = $filter_changeable;
    }


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


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


    public function isRequiredCreate()
    {
        return $this->required_create;
    }


    public function setRequiredCreate($required_create)
    {
        $this->required_create = $required_create;
    }


    public function isLockedCreate()
    {
        return $this->locked_create;
    }


    public function setLockedCreate($locked_create)
    {
        $this->locked_create = $locked_create;
    }


    public function isRequiredEdit()
    {
        return $this->required_edit;
    }


    public function setRequiredEdit($required_edit)
    {
        $this->required_edit = $required_edit;
    }


    public function isLockedEdit()
    {
        return $this->locked_edit;
    }


    public function setLockedEdit($locked_edit)
    {
        $this->locked_edit = $locked_edit;
    }


    public function getDefaultValue()
    {
        return $this->default_value;
    }


    public function setDefaultValue($default_value)
    {
        $this->default_value = $default_value;
    }


    public function isVisibleCreate()
    {
        return $this->visible_create;
    }


    public function setVisibleCreate($visible_create)
    {
        $this->visible_create = $visible_create;
    }


    public function setNotVisibleCreate(bool $not_visible_create) : void
    {
        $this->visible_create = !$not_visible_create;
    }


    public function isNotVisibleCreate() : bool
    {
        return !$this->visible_create;
    }


    public function isVisibleEdit()
    {
        return $this->visible_edit;
    }


    public function setVisibleEdit($visible_edit)
    {
        $this->visible_edit = $visible_edit;
    }

    public function setNotVisibleEdit(bool $not_visible) : void
    {
        $this->visible_edit = !$not_visible;
    }

    public function isNotVisibleEdit() : bool
    {
        return !$this->visible_edit;
    }

    public function isVisibleInForm(bool $creation_mode) : bool
    {
        return $creation_mode ? $this->isVisibleCreate() : $this->isVisibleEdit();
    }

    public function isLocked(bool $creation_mode) : bool
    {
        return $creation_mode ? $this->isLockedCreate() : $this->isLockedEdit();
    }

    public function isRequired(bool $creation_mode) : bool
    {
        return $creation_mode ? $this->isRequiredCreate() : $this->isRequiredEdit();
    }

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

        return null;
    }


    public function wakeUp($field_name, $field_value)
    {
        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;
    }


    public function cloneStructure(ilDclTableViewFieldSetting $orig)
    {
        $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();
    }


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


    public static function getInstance($tableview_id, $field_id)
    {
        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;
        }
    }
}