class.ilObjDataCollectionGUI.php

Go to the documentation of this file.

<?php

/* Copyright (c) 1998-2009 ILIAS open source, Extended GPL, see docs/LICENSE */

require_once("./Services/Rating/classes/class.ilRatingGUI.php");
require_once('./Services/Object/classes/class.ilObject2GUI.php');
require_once('./Services/Export/classes/class.ilExportGUI.php');
require_once('./Services/YUI/classes/class.ilYuiUtil.php');
require_once('./Services/UIComponent/Overlay/classes/class.ilOverlayGUI.php');
require_once('./Modules/DataCollection/classes/class.ilDclExportGUI.php');

class ilObjDataCollectionGUI extends ilObject2GUI {

        /*
         * __construct
         */
        const GET_DCL_GTR = "dcl_gtr";
        const GET_REF_ID = "ref_id";
        const GET_VIEW_ID = "tableview_id";


        public function __construct($a_id = 0, $a_id_type = self::REPOSITORY_NODE_ID, $a_parent_node_id = 0) {
                global $DIC;
                $lng = $DIC['lng'];
                $ilCtrl = $DIC['ilCtrl'];
                $tpl = $DIC['tpl'];

                parent::__construct($a_id, $a_id_type, $a_parent_node_id);

                $lng->loadLanguageModule("dcl");

                if (isset($_GET['table_id'])) {
                        $this->table_id = $_GET['table_id'];
                } elseif (isset($_GET['tableview_id'])) {
                        $this->table_id = ilDclTableView::find($_GET['tableview_id'])->getTableId();
                } elseif ($a_id > 0) {
                        $this->table_id = $this->object->getFirstVisibleTableId();
                }
                if (!$ilCtrl->isAsynch()) {
                        ilYuiUtil::initConnection();
                        ilOverlayGUI::initJavascript();
                        $tpl->addJavaScript('Modules/DataCollection/js/ilDataCollection.js');
                        $tpl->addJavaScript("Modules/DataCollection/js/datacollection.js");
                        $this->tpl->addOnLoadCode("ilDataCollection.setEditUrl('" . $ilCtrl->getLinkTargetByClass(array(
                                                'ilrepositorygui',
                                                'ilobjdatacollectiongui',
                                                'ildclrecordeditgui'
                                        ), 'edit', '', true) . "');");
                        $this->tpl->addOnLoadCode("ilDataCollection.setCreateUrl('" . $ilCtrl->getLinkTargetByClass(array(
                                                'ilrepositorygui',
                                                'ilobjdatacollectiongui',
                                                'ildclrecordeditgui'
                                        ), 'create', '', true) . "');");
                        $this->tpl->addOnLoadCode("ilDataCollection.setSaveUrl('" . $ilCtrl->getLinkTargetByClass(array(
                                                'ilrepositorygui',
                                                'ilobjdatacollectiongui',
                                                'ildclrecordeditgui'
                                        ), 'save', '', true) . "');");
                        $this->tpl->addOnLoadCode("ilDataCollection.setDataUrl('" . $ilCtrl->getLinkTargetByClass(array(
                                                'ilrepositorygui',
                                                'ilobjdatacollectiongui',
                                                'ildclrecordeditgui'
                                        ), 'getRecordData', '', true) . "');");
                }
                $ilCtrl->saveParameter($this, "table_id");
        }


        public function getStandardCmd() {
                return "render";
        }


        public function getType() {
                return "dcl";
        }


        public function executeCommand() {
                global $DIC;
                $ilCtrl = $DIC['ilCtrl'];
                $ilTabs = $DIC['ilTabs'];
                $ilNavigationHistory = $DIC['ilNavigationHistory'];
                $tpl = $DIC['tpl'];
                // Navigation History
                $link = $ilCtrl->getLinkTarget($this, "render");

                if ($this->object != NULL) {
                        $ilNavigationHistory->addItem($this->object->getRefId(), $link, "dcl");
                }

                // Direct-Link Resource, redirect to viewgui
                if ($_GET[self::GET_DCL_GTR]) {
                        $ilCtrl->setParameterByClass('ilDclDetailedViewGUI', 'tableview_id', $_GET[self::GET_VIEW_ID]);
                        $ilCtrl->setParameterByClass('ilDclDetailedViewGUI', 'record_id', $_GET[self::GET_DCL_GTR]);
                        $ilCtrl->redirectByClass('ilDclDetailedViewGUI', 'renderRecord');
                }


                $next_class = $ilCtrl->getNextClass($this);

                if (!$this->getCreationMode() AND $next_class != "ilinfoscreengui" AND !$this->checkPermissionBool("read")) {
                        $tpl->getStandardTemplate();
                        $tpl->setContent("Permission Denied.");

                        return;
                }

                switch ($next_class) {
                        case "ilinfoscreengui":
                                $this->prepareOutput();
                                $ilTabs->activateTab("id_info");
                                $this->infoScreenForward();
                                break;

                        case "ilcommonactiondispatchergui":
                                require_once('./Services/Object/classes/class.ilCommonActionDispatcherGUI.php');
                                $gui = ilCommonActionDispatcherGUI::getInstanceFromAjaxCall();
                                $gui->enableCommentsSettings(false);
                                $this->ctrl->forwardCommand($gui);
                                break;

                        case "ilpermissiongui":
                                $this->prepareOutput();
                                $ilTabs->activateTab("id_permissions");
                                require_once('./Services/AccessControl/classes/class.ilPermissionGUI.php');
                                $perm_gui = new ilPermissionGUI($this);
                                $this->ctrl->forwardCommand($perm_gui);
                                break;

                        case "ilobjectcopygui":
                                require_once('./Services/Object/classes/class.ilObjectCopyGUI.php');
                                $cp = new ilObjectCopyGUI($this);
                                $cp->setType("dcl");
                                $tpl->getStandardTemplate();
                                $this->ctrl->forwardCommand($cp);
                                break;

                        case "ildcltablelistgui":
                                $this->prepareOutput();
                                $ilTabs->setTabActive("id_tables");
                                require_once('./Modules/DataCollection/classes/Table/class.ilDclTableListGUI.php');
                                $tablelist_gui = new ilDclTableListGUI($this);
                                $this->ctrl->forwardCommand($tablelist_gui);
                                break;

                        case "ildclrecordlistgui":
                                $this->addHeaderAction(false);
                                $this->prepareOutput();
                                $ilTabs->activateTab("id_records");
                                $this->ctrl->setParameterByClass('ilDclRecordListGUI', 'tableview_id', $_REQUEST['tableview_id']);
                                require_once('./Modules/DataCollection/classes/Content/class.ilDclRecordListGUI.php');
                                $recordlist_gui = new ilDclRecordListGUI($this, $this->table_id);
                                $this->ctrl->forwardCommand($recordlist_gui);
                                break;

                        case "ildclrecordeditgui":
                                $this->prepareOutput();
                                $ilTabs->activateTab("id_records");
                                require_once('./Modules/DataCollection/classes/Content/class.ilDclRecordEditGUI.php');
                                $recordedit_gui = new ilDclRecordEditGUI($this);
                                $this->ctrl->forwardCommand($recordedit_gui);
                                break;

                        case "ildclrecordlistviewdefinitiongui":
                                $this->prepareOutput();
                                $this->addListFieldsTabs("list_viewdefinition");
                                $ilTabs->setTabActive("id_fields");
                                require_once('./Modules/DataCollection/classes/Content/class.ilDclRecordListViewdefinitionGUI.php');
                                $recordlist_gui = new ilDclRecordListViewdefinitionGUI($this, $this->table_id);
                                $this->ctrl->forwardCommand($recordlist_gui);
                                break;

                        case "ilobjfilegui":
                                $this->prepareOutput();
                                $ilTabs->setTabActive("id_records");
                                require_once('./Modules/File/classes/class.ilObjFile.php');
                                $file_gui = new ilObjFile($this);
                                $this->ctrl->forwardCommand($file_gui);
                                break;

                        case "ilratinggui":
                                $rgui = new ilRatingGUI();
                                $rgui->setObject($_GET['record_id'], "dcl_record", $_GET["field_id"], "dcl_field");
                                $rgui->executeCommand();
                                $ilCtrl->redirectByClass("ilDclRecordListGUI", "listRecords");
                                break;

                        case "ildcldetailedviewgui":
                                $this->prepareOutput();
                                require_once('./Modules/DataCollection/classes/DetailedView/class.ilDclDetailedViewGUI.php');
                                $recordview_gui = new ilDclDetailedViewGUI($this);
                                $this->ctrl->forwardCommand($recordview_gui);
                                $ilTabs->clearTargets();
                                $ilTabs->setBackTarget($this->lng->txt("back"), $ilCtrl->getLinkTargetByClass(ilDclRecordListGUI::class, ilDclRecordListGUI::CMD_LIST_RECORDS));
                                break;

                        case 'ilnotegui':
                                $this->prepareOutput();
                                require_once('./Modules/DataCollection/classes/DetailedView/class.ilDclDetailedViewGUI.php'); //Forward the command to recordViewGUI
                                $recordviewGui = new ilDclDetailedViewGUI($this);
                                $this->ctrl->forwardCommand($recordviewGui);
                                $ilTabs->clearTargets();
                                $ilTabs->setBackTarget($this->lng->txt("back"), $ilCtrl->getLinkTargetByClass("ilObjDataCollectionGUI", ""));
                                break;
                        case "ildclexportgui":
                                $this->prepareOutput();
                                $ilTabs->setTabActive("export");
//                              $this->setLocator();
                                $exp_gui = new ilDclExportGUI($this);
                                $exp_gui->addFormat("xml");

                                require_once 'Modules/DataCollection/classes/Content/class.ilDclContentExporter.php';
                                $exporter = new ilDclContentExporter($this->object->getRefId());
                                $exp_gui->addFormat("xlsx", $this->lng->txt('dlc_xls_async_export'), $exporter, 'exportAsync');

                                $this->ctrl->forwardCommand($exp_gui);
                                break;

                        case strtolower(ilDclPropertyFormGUI::class):
                                require_once './Modules/DataCollection/classes/Content/class.ilDclRecordEditGUI.php';
                                $recordedit_gui = new ilDclRecordEditGUI($this);
                                $recordedit_gui->getRecord();
                                $recordedit_gui->initForm();
                                $form = $recordedit_gui->getForm();
                                $this->ctrl->forwardCommand($form);
                                break;

                        default:
                                return parent::executeCommand();
                }

                return true;
        }


        public function infoScreen() {
                $this->ctrl->setCmd("showSummary");
                $this->ctrl->setCmdClass("ilinfoscreengui");
                $this->infoScreenForward();
        }


        public function render() {
                global $DIC;
                $ilCtrl = $DIC['ilCtrl'];
                $this->ctrl->setParameterByClass('ilDclRecordListGUI', 'tableview_id', $_GET['tableview_id']);
                $ilCtrl->redirectByClass("ildclrecordlistgui", "show");
        }


        public function infoScreenForward() {
                global $DIC;
                $ilTabs = $DIC['ilTabs'];
                $ilErr = $DIC['ilErr'];

                $ilTabs->activateTab("id_info");

                if (!$this->checkPermissionBool("visible") && !$this->checkPermissionBool("read")) {
                        $ilErr->raiseError($this->lng->txt("msg_no_perm_read"));
                }

                require_once('./Services/InfoScreen/classes/class.ilInfoScreenGUI.php');
                $info = new ilInfoScreenGUI($this);
                $info->enablePrivateNotes();
                $info->addMetaDataSections($this->object->getId(), 0, $this->object->getType());

                $this->ctrl->forwardCommand($info);
        }


        public function addLocatorItems() {
                global $DIC;
                $ilLocator = $DIC['ilLocator'];

                if (is_object($this->object)) {
                        $ilLocator->addItem($this->object->getTitle(), $this->ctrl->getLinkTarget($this, ""), "", $this->node_id);
                }
        }


        public static function _goto($a_target) {
                $id = explode("_", $a_target);

                $_GET["baseClass"] = "ilRepositoryGUI";
                $_GET[self::GET_REF_ID] = $id[0];
                $_GET[self::GET_VIEW_ID] = $id[1];
                $_GET[self::GET_DCL_GTR] = $id[2]; //recordID
                $_GET["cmd"] = "listRecords";
                require_once('./ilias.php');
                exit;
        }


        protected function initCreationForms($a_new_type) {
                $forms = parent::initCreationForms($a_new_type);

                return $forms;
        }


        protected function afterSave(ilObject $a_new_object) {
                ilUtil::sendSuccess($this->lng->txt("object_added"), true);
                $this->ctrl->redirectByClass("ilDclTableListGUI", "listTables");
        }


        public function setTabs() {
                global $DIC;
                $ilAccess = $DIC['ilAccess'];
                $ilTabs = $DIC['ilTabs'];
                $lng = $DIC['lng'];
                $ilHelp = $DIC['ilHelp'];

                $ilHelp->setScreenIdComponent("dcl");

                // list records
                if ($ilAccess->checkAccess('read', "", $this->object->getRefId())) {
                        $ilTabs->addTab("id_records", $lng->txt("content"), $this->ctrl->getLinkTargetByClass("ildclrecordlistgui", "show"));
                }

                // info screen
                if ($ilAccess->checkAccess('visible', "", $this->object->getRefId()) || $ilAccess->checkAccess('read', "", $this->object->getRefId())) {
                        $ilTabs->addTab("id_info", $lng->txt("info_short"), $this->ctrl->getLinkTargetByClass("ilinfoscreengui", "showSummary"));
                }

                // settings
                if ($ilAccess->checkAccess('write', "", $this->object->getRefId())) {
                        $ilTabs->addTab("id_settings", $lng->txt("settings"), $this->ctrl->getLinkTarget($this, "editObject"));
                }

                // list tables
                if ($ilAccess->checkAccess('write', "", $this->object->getRefId())) {
                        $ilTabs->addTab("id_tables", $lng->txt("dcl_tables"), $this->ctrl->getLinkTargetByClass("ildcltablelistgui", "listTables"));
                }

                // export
                if ($ilAccess->checkAccess("write", "", $this->object->getRefId())) {
                        $ilTabs->addTab("export", $lng->txt("export"), $this->ctrl->getLinkTargetByClass("ildclexportgui", ""));
                }

                // edit permissions
                if ($ilAccess->checkAccess('edit_permission', "", $this->object->getRefId())) {
                        $ilTabs->addTab("id_permissions", $lng->txt("perm_settings"), $this->ctrl->getLinkTargetByClass("ilpermissiongui", "perm"));
                }
        }

        protected function initEditCustomForm(ilPropertyFormGUI $a_form) {
                global $DIC;
                $ilTabs = $DIC['ilTabs'];

                $ilTabs->activateTab("id_settings");

                // is_online
                $cb = new ilCheckboxInputGUI($this->lng->txt("online"), "is_online");
                $cb->setInfo($this->lng->txt("dcl_online_info"));
                $a_form->addItem($cb);

                // Notification
                $cb = new ilCheckboxInputGUI($this->lng->txt("dcl_activate_notification"), "notification");
                $cb->setInfo($this->lng->txt("dcl_notification_info"));
                $a_form->addItem($cb);

                //table order
                $order_options = array();
                foreach($this->getDataCollectionObject()->getTables() as $table) {
                        $order_options[$table->getId()] = $table->getTitle();
                }
        }


        public function listRecords() {
                global $DIC;
                $ilCtrl = $DIC['ilCtrl'];
                $ilCtrl->setParameterByClass("ildclrecordlistgui", "tableview_id", $_GET["tableview_id"]);
                $ilCtrl->redirectByClass("ildclrecordlistgui", "show");
        }


        public function getDataCollectionObject() {
                $obj = new ilObjDataCollection($this->ref_id, true);

                return $obj;
        }


        public function getEditFormCustomValues(array &$a_values) {
                $a_values["is_online"] = $this->object->getOnline();
                $a_values["rating"] = $this->object->getRating();
                $a_values["public_notes"] = $this->object->getPublicNotes();
                $a_values["approval"] = $this->object->getApproval();
                $a_values["notification"] = $this->object->getNotification();

                return $a_values;
        }


        public function updateCustom(ilPropertyFormGUI $a_form) {
                $this->object->setOnline($a_form->getInput("is_online"));
                $this->object->setRating($a_form->getInput("rating"));
                $this->object->setPublicNotes($a_form->getInput("public_notes"));
                $this->object->setApproval($a_form->getInput("approval"));
                $this->object->setNotification($a_form->getInput("notification"));

                $this->emptyInfo();
        }


        private function emptyInfo() {
                global $DIC;
                $lng = $DIC['lng'];
                $this->table = ilDclCache::getTableCache($this->object->getFirstVisibleTableId());
                $tables = $this->object->getTables();
                if (count($tables) == 1 AND count($this->table->getRecordFields()) == 0 AND count($this->table->getRecords()) == 0
                        AND $this->object->getOnline()
                ) {
                        ilUtil::sendInfo($lng->txt("dcl_no_content_warning"), true);
                }
        }



        public function toggleNotification() {
                global $DIC;
                $ilCtrl = $DIC['ilCtrl'];
                $ilUser = $DIC['ilUser'];

                require_once('./Services/Notification/classes/class.ilNotification.php');
                switch ($_GET["ntf"]) {
                        case 1:
                                ilNotification::setNotification(ilNotification::TYPE_DATA_COLLECTION, $ilUser->getId(), $this->obj_id, false);
                                break;
                        case 2:
                                ilNotification::setNotification(ilNotification::TYPE_DATA_COLLECTION, $ilUser->getId(), $this->obj_id, true);
                                break;
                }
                $ilCtrl->redirectByClass("ildclrecordlistgui", "show");
        }


        public function addHeaderAction($a_redraw = false) {
                global $DIC;
                $ilUser = $DIC['ilUser'];
                $ilAccess = $DIC['ilAccess'];
                $tpl = $DIC['tpl'];
                $lng = $DIC['lng'];
                $ilCtrl = $DIC['ilCtrl'];

                require_once('./Services/Object/classes/class.ilCommonActionDispatcherGUI.php');
                $dispatcher = new ilCommonActionDispatcherGUI(ilCommonActionDispatcherGUI::TYPE_REPOSITORY, $ilAccess, "dcl", $this->ref_id, $this->obj_id);

                require_once('./Services/Object/classes/class.ilObjectListGUI.php');
                ilObjectListGUI::prepareJSLinks($this->ctrl->getLinkTarget($this, "redrawHeaderAction", "", true), $ilCtrl->getLinkTargetByClass(array(
                                        "ilcommonactiondispatchergui",
                                        "ilnotegui"
                                ), "", "", true, false), $ilCtrl->getLinkTargetByClass(array( "ilcommonactiondispatchergui", "iltagginggui" ), "", "", true, false));

                $lg = $dispatcher->initHeaderAction();
                //$lg->enableNotes(true);
                //$lg->enableComments(ilObjWiki::_lookupPublicNotes($this->getPageObject()->getParentId()), false);

                // notification
                if ($ilUser->getId() != ANONYMOUS_USER_ID AND $this->object->getNotification() == 1) {
                        require_once('./Services/Notification/classes/class.ilNotification.php');
                        if (ilNotification::hasNotification(ilNotification::TYPE_DATA_COLLECTION, $ilUser->getId(), $this->obj_id)) {
                                //Command Activate Notification
                                $ilCtrl->setParameter($this, "ntf", 1);
                                $lg->addCustomCommand($ilCtrl->getLinkTarget($this, "toggleNotification"), "dcl_notification_deactivate_dcl");

                                $lg->addHeaderIcon("not_icon", ilUtil::getImagePath("notification_on.svg"), $lng->txt("dcl_notification_activated"));
                        } else {
                                //Command Deactivate Notification
                                $ilCtrl->setParameter($this, "ntf", 2);
                                $lg->addCustomCommand($ilCtrl->getLinkTarget($this, "toggleNotification"), "dcl_notification_activate_dcl");

                                $lg->addHeaderIcon("not_icon", ilUtil::getImagePath("notification_off.svg"), $lng->txt("dcl_notification_deactivated"));
                        }
                        $ilCtrl->setParameter($this, "ntf", "");
                }

                if (!$a_redraw) {
                        $tpl->setHeaderActionMenu($lg->getHeaderAction());
                } else {
                        return $lg->getHeaderAction();
                }

                $tpl->setHeaderActionMenu($lg->getHeaderAction());
        }
}

?>