class.arDisplayGUI.php

Go to the documentation of this file.

<?php
require_once('./Services/Form/classes/class.ilPropertyFormGUI.php');
require_once('./Services/ActiveRecord/Views/Display/class.arDisplayField.php');
require_once('./Services/ActiveRecord/Views/Display/class.arDisplayFields.php');

class arDisplayGUI {

        protected $record;
        protected $parent_gui;
        protected $ctrl;
        protected $tpl;
        protected $title = "";
        protected $fields = array();
        protected $data = array();
        protected $back_button_name = "";
        protected $back_button_target = "";
        protected $template;


        public function __construct(arGUI $parent_gui, ActiveRecord $ar) {
                global $ilCtrl, $tpl;
                $this->ctrl = $ilCtrl;
                $this->tpl = $tpl;
                $this->ar = $ar;
                $this->parent_gui = $parent_gui;

                $this->ctrl->saveParameter($parent_gui, 'ar_id');

                $this->init();
        }


        protected function init() {
                $this->initTitle();
                $this->initFields();
                $this->initBackButton();
                $this->initTemplate();
        }


        protected function initTitle() {
                $this->setTitle(strtolower(str_replace("Record", "", get_class($this->ar))));
        }


        protected function initFields() {
                $this->fields = new arDisplayFields($this->ar);
                $this->customizeFields();
                $this->fields->sortFields();
        }


        protected function customizeFields() {
        }


        protected function initBackButton() {
                $this->setBackButtonName($this->txt("back", false));
                $this->setBackButtonTarget($this->ctrl->getLinkTarget($this->parent_gui, "index"));
        }


        protected function initTemplate() {
                $this->setTemplate(new ilTemplate("tpl.display.html", true, true, "Services/ActiveRecord"));
        }


        public function getHtml() {

                $this->getTemplate()->setVariable("TITLE", $this->title);
                $this->setArFieldsData();
                $this->getTemplate()->setVariable("BACK_BUTTON_NAME", $this->getBackButtonName());
                $this->getTemplate()->setVariable("BACK_BUTTON_TARGET", $this->getBackButtonTarget());

                return $this->getTemplate()->get();
        }


        protected function setArFieldsData() {
                foreach ($this->fields->getFields() as $field) {
                        if ($field->getVisible()) {
                                $get_function = $field->getGetFunctionName();
                                $value = $this->ar->$get_function();
                                $this->getTemplate()->setCurrentBlock("entry");
                                $this->getTemplate()->setVariable("ITEM", $this->txt($field->getTxt()));
                                $this->getTemplate()->setVariable("VALUE", $this->setArFieldData($field, $value));
                                $this->getTemplate()->parseCurrentBlock();
                        }
                }
        }


        protected function setArFieldData(arDisplayField $field, $value) {
                if ($field->getCustomField()) {
                        return $this->setCustomFieldData($field);
                } else {
                        if ($value == NULL) {
                                return $this->setEmptyFieldData($field);
                        } else {
                                if ($field->getIsCreatedByField()) {
                                        return $this->setCreatedByData($field, $value);
                                } else {
                                        if ($field->getIsModifiedByField()) {
                                                return $this->setModifiedByData($field, $value);
                                        } else {
                                                switch ($field->getFieldType()) {
                                                        case 'integer':
                                                        case 'float':
                                                                return $this->setNumericData($field, $value);
                                                        case 'text':
                                                                return $this->setTextData($field, $value);
                                                        case 'date':
                                                        case 'time':
                                                        case 'timestamp':
                                                                return $this->setDateTimeData($field, $value);
                                                        case 'clob':
                                                                return $this->setClobData($field, $value);
                                                }
                                        }
                                }
                        }
                }
        }


        protected function setEmptyFieldData(arDisplayField $field) {
                return $this->txt("", false);
        }


        protected function setCustomFieldData(arDisplayField $field) {
                return "CUSTOM-OVERRIDE: setCustomFieldData";
        }


        protected function setModifiedByData(arDisplayField $field, $value) {
                $user = new ilObjUser($value);

                return $user->getPublicName();
        }


        protected function setCreatedByData(arDisplayField $field, $value) {
                $user = new ilObjUser($value);

                return $user->getPublicName();
        }


        protected function setNumericData(arDisplayField $field, $value) {
                return $value;
        }


        protected function setTextData(arDisplayField $field, $value) {
                return $value;
        }


        protected function setDateTimeData(arDisplayField $field, $value) {
                $datetime = new ilDateTime($value, IL_CAL_DATETIME);

                return ilDatePresentation::formatDate($datetime, IL_CAL_DATETIME);
        }


        protected function setClobData(arDisplayField $field, $value) {
                return $value;
        }


        public function setBackButtonName($back_button_name) {
                $this->back_button_name = $back_button_name;
        }


        public function getBackButtonName() {
                return $this->back_button_name;
        }


        public function setBackButtonTarget($back_button_target) {
                $this->back_button_target = $back_button_target;
        }


        public function getBackButtonTarget() {
                return $this->back_button_target;
        }


        function setFields(arDisplayFields $fields) {
                $this->fields = $fields;
        }


        public function getFields() {
                return $this->fields;
        }


        public function getFieldsAsArray() {
                return $this->getFields()->getFields();
        }


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


        public function addField(arDisplayField $field) {
                $this->getFields()->addField($field);
        }


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


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


        public function setTemplate($template) {
                $this->template = $template;
        }


        public function getTemplate() {
                return $this->template;
        }


        protected function txt($txt, $plugin_txt = true) {
                return $this->parent_gui->txt($txt, $plugin_txt);
        }
}