class.ilBaseViewGUI.php

Go to the documentation of this file.

<?php
/*
    +-----------------------------------------------------------------------------+
    | ILIAS open source                                                           |
    +-----------------------------------------------------------------------------+
    | Copyright (c) 1998-2001 ILIAS open source, University of Cologne            |
    |                                                                             |
    | This program is free software; you can redistribute it and/or               |
    | modify it under the terms of the GNU General Public License                 |
    | as published by the Free Software Foundation; either version 2              |
    | of the License, or (at your option) any later version.                      |
    |                                                                             |
    | This program is distributed in the hope that it will be useful,             |
    | but WITHOUT ANY WARRANTY; without even the implied warranty of              |
    | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               |
    | GNU General Public License for more details.                                |
    |                                                                             |
    | You should have received a copy of the GNU General Public License           |
    | along with this program; if not, write to the Free Software                 |
    | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA. |
    +-----------------------------------------------------------------------------+
*/

abstract class ilBaseViewGUI
{
    
    /*
     * Spacer CSS Classes
     */
    const TOP_SPACER = "ilFixedTopSpacer";
    const TOP_SPACER_BAR_ONLY = "ilFixedTopSpacerBarOnly";
    
    
    const ROOT_CONTAINER = "container";
    const ROOT_CRS = "crs";
    const ROOT_GRP = "grp";
    
    protected $allow_desktop = true; // deprecated but we should discuss concepts
    
    protected $view_nav = true;
    
    protected $use_top_bar_url = false;
    
    protected $root_type = ROOT_CONTAINER;
    
    protected $dic = null;
    
    protected $ctrl = null;
    
    protected $ilias = null;
    
    protected $link_dir = "";
    
    protected $home_id = '';
    
    protected $home_obj_id = '';
    
    protected $home_type = '';
    
    protected $home_title = '';
    
    protected $home_url = '';
    
    protected $home_items = [];
      
    protected $show_home_link = false;
    
    protected $root_folder_id = ROOT_FOLDER_ID;
    
    protected $root_folder_items = []; // deprecated
    
    public $tree_root_id = ROOT_FOLDER_ID;
    
    protected $tree_root_types = [];
    
    protected $fix_tree_id = '';
    
    protected $current_ref_id = "";
    
    protected $current_type = "";
    
    
    public function __construct()
    {
        global $DIC, $ilCtrl, $ilias, $lng;
        $this->dic = $DIC;
        $this->ctrl = $ilCtrl;
        $this->ilias = $ilias;
        $this->link_dir = (defined("ILIAS_MODULE"))
                    ? "../"
                    : "";
    }
    
    public function allowDesktop()
    {
        return $this->allow_desktop;
    }
    
    public function showViewNav()
    {
        return $this->view_nav;
    }
    
    public function spacerClass()
    {
        return ($this->topBarOnly) ? self::TOP_SPACER_BAR_ONLY : self::TOP_SPACER;
    }
    
    public function addCss()
    {
        return [];
    }
    
    public function appendInlineCss()
    {
        return [];
    }
    
    protected function getHomeLink()
    {
        return $this->link_dir . "goto.php?target=" . $this->home_type . "_" . $this->home_id;
    }
    
    protected function getCmdLink($cmd)
    {
        global $ilCtrl;
        $targetScript = ($ilCtrl->getTargetScript() !== 'ilias.php') ? "ilias.php" : "";
        return $this->link_dir . $targetScript . $ilCtrl->getLinkTargetByClass(array('illtiroutergui',strtolower(get_class($this))), $cmd) . "&baseClass=illtiroutergui";
    }
    
    public function redirectToHome($_msg_type=self::MSG_INFO, $_msg='')
    {
        //$msg = ($_msg !== '') ? '&view_msg='.$_msg.'&view_msg_type='.$_msg_type : '';
        //$link = $this->getHomeLink().$msg;
        $_SESSION[$_msg_type] = $_msg;
        $link = $this->getHomeLink();
        $this->dic->logger()->lti()->write("redirectLink: " . $link);
        ilUtil::redirect($link);
        exit;
    }
    
    public function getHomeTitle()
    {
        return ilObject::_lookupTitle($this->home_obj_id);
    }
    
    public function findEffectiveRefId()
    {
        if ((int) $_GET['ref_id']) {
            $this->current_type = ilObject::_lookupType($_GET['ref_id'], true);
            return $this->current_ref_id = (int) $_GET['ref_id'];
        }
        
        $target_arr = explode('_', (string) $_GET['target']);
        if (isset($target_arr[1]) and (int) $target_arr[1]) {
            $this->current_type = ilObject::_lookupType($target_arr[1], true);
            $this->home_title = ilObject::_lookupTitle(ilObject::_lookupObjectId($target_arr[1]));
            return $this->current_ref_id = (int) $target_arr[1];
        }
    }
    
    public function getHttpPath()
    {
        include_once './Services/Http/classes/class.ilHTTPS.php';
        $https = new ilHTTPS();

        if ($https->isDetected()) {
            $protocol = 'https://';
        } else {
            $protocol = 'http://';
        }
        $host = $_SERVER['HTTP_HOST'];
        $rq_uri = $_SERVER['REQUEST_URI'];
        return ilUtil::removeTrailingPathSeparators($protocol . $host . $rq_uri);
    }
    
    public function isContainer($obj_type)
    {
        //return true;
        return preg_match("/(crs|grp|cat|root|folder)/", $obj_type);
    }
    
    protected function log($txt)
    {
        $this->dic->logger()->lti()->write($txt);
    }
    
    public function getSessionValue($sess_key)
    {
        if (isset($_SESSION[$sess_key]) && $_SESSION[$sess_key] != '') {
            return $_SESSION[$sess_key];
        } else {
            return '';
        }
    }
}