class.ilContainerSessionsContentGUI.php

Go to the documentation of this file.

<?php
/*
    +-----------------------------------------------------------------------------+
    | ILIAS open source                                                           |
    +-----------------------------------------------------------------------------+
    | Copyright (c) 1998-2008 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. |
    +-----------------------------------------------------------------------------+
*/

include_once("./Services/Container/classes/class.ilContainerContentGUI.php");

class ilContainerSessionsContentGUI extends ilContainerContentGUI
{
    protected $tabs;

    protected $force_details = array();
    
    public function __construct($container_gui_obj)
    {
        global $DIC;

        $this->tabs = $DIC->tabs();
        $this->user = $DIC->user();
        $this->ctrl = $DIC->ctrl();
        $lng = $DIC->language();
        
        parent::__construct($container_gui_obj);
        $this->lng = $lng;
        $this->initDetails();
    }
    

    public function getDetailsLevel($a_session_id)
    {
        if ($this->getContainerGUI()->isActiveAdministrationPanel()) {
            return self::DETAILS_DEACTIVATED;
        }
        if (isset($_SESSION['sess']['expanded'][$a_session_id])) {
            return $_SESSION['sess']['expanded'][$a_session_id];
        }
        if (in_array($a_session_id, $this->force_details)) {
            return self::DETAILS_ALL;
        } else {
            return self::DETAILS_TITLE;
        }
    }


    public function getMainContent()
    {
        $lng = $this->lng;
        $ilTabs = $this->tabs;

        // see bug #7452
        //              $ilTabs->setSubTabActive($this->getContainerObject()->getType().'_content');


        include_once 'Services/Object/classes/class.ilObjectListGUIFactory.php';

        $tpl = new ilTemplate(
            "tpl.container_page.html",
            true,
            true,
            "Services/Container"
        );

        $this->__showMaterials($tpl);
            
        return $tpl->get();
    }

    public function __showMaterials($a_tpl)
    {
        $lng = $this->lng;

        $this->items = $this->getContainerObject()->getSubItems($this->getContainerGUI()->isActiveAdministrationPanel());
        $this->clearAdminCommandsDetermination();
        
        $this->initRenderer();
        
        $output_html = $this->getContainerGUI()->getContainerPageHTML();
        
        // get embedded blocks
        if ($output_html != "") {
            $output_html = $this->insertPageEmbeddedBlocks($output_html);
        }

        $prefix = $postfix = '';
        if (is_array($this->items["sess"]) ||
            $this->items['sess_link']['prev']['value'] ||
            $this->items['sess_link']['next']['value']) {
            $this->items['sess'] = ilUtil::sortArray($this->items['sess'], 'start', 'asc', true, false);
            
            if ($this->items['sess_link']['prev']['value']) {
                $prefix = $this->renderSessionLimitLink(true);
            }
            if ($this->items['sess_link']['next']['value']) {
                $postfix = $this->renderSessionLimitLink(false);
            }
            
            $this->renderer->addTypeBlock("sess", $prefix, $postfix);
            $this->renderer->setBlockPosition("sess", 1);
            
            $position = 1;
            foreach ($this->items["sess"] as $item_data) {
                if (!$this->renderer->hasItem($item_data["child"])) {
                    $html = $this->renderItem($item_data, $position++, true);
                    if ($html != "") {
                        $this->renderer->addItemToBlock("sess", $item_data["type"], $item_data["child"], $html);
                    }
                }
            }
            #22328 render session block if previous or next session link is available
            if (
                !count($this->items['sess'] ?? []) &&
                ($prefix !== '' || $postfix !== '')
            ) {
                $this->renderer->addItemToBlock('sess', '', 0, '&nbsp;');
            }
        }
        $pos = $this->getItemGroupsHTML(1);
        if (is_array($this->items["_all"])) {
            $this->renderer->addCustomBlock("_all", $lng->txt("content"));
            $this->renderer->setBlockPosition("_all", ++$pos);
                        
            $position = 1;
            
            foreach ($this->items["_all"] as $item_data) {
                // #14599
                if ($item_data["type"] == "sess" || $item_data["type"] == "itgr") {
                    continue;
                }
                
                if (!$this->renderer->hasItem($item_data["child"])) {
                    $html = $this->renderItem($item_data, $position++, true);
                    if ($html != "") {
                        $this->renderer->addItemToBlock("_all", $item_data["type"], $item_data["child"], $html);
                    }
                }
            }
        }

        $output_html .= $this->renderer->getHTML();
        
        $a_tpl->setVariable("CONTAINER_PAGE_CONTENT", $output_html);
    }

    protected function renderSessionLimitLink($a_previous = true)
    {
        $lng = $this->lng;
        $ilUser = $this->user;
        $ilCtrl = $this->ctrl;
        
        $lng->loadLanguageModule('crs');

        $tpl = new ilTemplate(
            'tpl.container_list_item.html',
            true,
            true,
            "Services/Container"
        );
        $tpl->setVariable('DIV_CLASS', 'ilContainerListItemOuter');
        $tpl->setCurrentBlock('item_title_linked');

        if ($a_previous) {
            $prefp = $ilUser->getPref('crs_sess_show_prev_' . $this->getContainerObject()->getId());
            
            if ($prefp) {
                $tpl->setVariable('TXT_TITLE_LINKED', $lng->txt('crs_link_hide_prev_sessions'));
                $ilCtrl->setParameterByClass(get_class($this->getContainerGUI()), 'crs_prev_sess', (int) !$prefp);
                $tpl->setVariable('HREF_TITLE_LINKED', $ilCtrl->getLinkTargetByClass(get_class($this->getContainerGUI()), 'view'));
            } else {
                $tpl->setVariable('TXT_TITLE_LINKED', $lng->txt('crs_link_show_all_prev_sessions'));
                $ilCtrl->setParameterByClass(get_class($this->getContainerGUI()), 'crs_prev_sess', (int) !$prefp);
                $tpl->setVariable('HREF_TITLE_LINKED', $ilCtrl->getLinkTargetByClass(get_class($this->getContainerGUI()), 'view'));
            }
            $ilCtrl->clearParametersByClass(get_class($this->getContainerGUI()));
        } else {
            $prefn = $ilUser->getPref('crs_sess_show_next_' . $this->getContainerObject()->getId());

            if ($prefn) {
                $tpl->setVariable('TXT_TITLE_LINKED', $lng->txt('crs_link_hide_next_sessions'));
            } else {
                $tpl->setVariable('TXT_TITLE_LINKED', $lng->txt('crs_link_show_all_next_sessions'));
            }
            $ilCtrl->setParameterByClass(get_class($this->getContainerGUI()), 'crs_next_sess', (int) !$prefn);
            $tpl->setVariable('HREF_TITLE_LINKED', $ilCtrl->getLinkTargetByClass(get_class($this->getContainerGUI()), 'view'));
            $ilCtrl->clearParametersByClass(get_class($this->getContainerGUI()));
        }
        $tpl->parseCurrentBlock();

        return $tpl->get();
    }
    
    
    public function addFooterRow($tpl)
    {
        $ilCtrl = $this->ctrl;

        $ilCtrl->setParameterByClass("ilrepositorygui", "ref_id", $_GET["ref_id"]);
        
        $tpl->setCurrentBlock('container_details_row');
        $tpl->setVariable('TXT_DETAILS', $this->lng->txt('details'));
        $tpl->parseCurrentBlock();
    }
    
    protected function initDetails()
    {
        $ilUser = $this->user;
        
        if ($_GET['expand']) {
            if ($_GET['expand'] > 0) {
                $_SESSION['sess']['expanded'][abs((int) $_GET['expand'])] = self::DETAILS_ALL;
            } else {
                $_SESSION['sess']['expanded'][abs((int) $_GET['expand'])] = self::DETAILS_TITLE;
            }
        }

        include_once('./Modules/Session/classes/class.ilSessionAppointment.php');
        if ($session = ilSessionAppointment::lookupNextSessionByCourse($this->getContainerObject()->getRefId())) {
            $this->force_details = $session;
        } elseif ($session = ilSessionAppointment::lookupLastSessionByCourse($this->getContainerObject()->getRefId())) {
            $this->force_details = array($session);
        }
    }

    public static function prepareSessionPresentationLimitation(
        array $items,
        ilContainer $container,
        bool $admin_panel_enabled = false,
        bool $include_side_block = false
    ) : array {
        global $DIC;

        $user = $DIC->user();
        $access = $DIC->access();
        $tree = $DIC->repositoryTree();

        $limit_sessions = false;
        if (
            !$admin_panel_enabled &&
            !$include_side_block &&
            $items['sess'] &&
            is_array($items['sess']) &&
            (($container->getViewMode() == ilContainer::VIEW_SESSIONS) || ($container->getViewMode() == ilContainer::VIEW_INHERIT)) &&
            $container->isSessionLimitEnabled()
        ) {
            $limit_sessions = true;
        }

        if ($container->getViewMode() == ilContainer::VIEW_INHERIT) {
            $parent = $tree->checkForParentType($container->getRefId(), 'crs');
            $crs = ilObjectFactory::getInstanceByRefId($parent, false);
            if (!$crs instanceof ilObjCourse) {
                return $items;
            }

            if (!$container->isSessionLimitEnabled()) {
                $limit_sessions = false;
            }
            $limit_next = $crs->getNumberOfNextSessions();
            $limit_prev = $crs->getNumberOfPreviousSessions();
        } else {
            $limit_next = $container->getNumberOfNextSessions();
            $limit_prev = $container->getNumberOfPreviousSessions();
        }

        if (!$limit_sessions) {
            return  $items;
        }



        // do session limit
        if (isset($_GET['crs_prev_sess'])) {
            $user->writePref('crs_sess_show_prev_' . $container->getId(), (string) (int) $_GET['crs_prev_sess']);
        }
        if (isset($_GET['crs_next_sess'])) {
            $user->writePref('crs_sess_show_next_' . $container->getId(), (string) (int) $_GET['crs_next_sess']);
        }

        $session_rbac_checked = [];
        foreach ($items['sess'] as $session_tree_info) {
            if ($access->checkAccess('visible', '', $session_tree_info['ref_id'])) {
                $session_rbac_checked[] = $session_tree_info;
            }
        }
        $sessions = ilUtil::sortArray($session_rbac_checked, 'start', 'ASC', true, false);
        //$sessions = ilUtil::sortArray($this->items['sess'],'start','ASC',true,false);
        $today = new ilDate(date('Ymd', time()), IL_CAL_DATE);
        $previous = $current = $next = array();
        foreach ($sessions as $key => $item) {
            $start = new ilDateTime($item['start'], IL_CAL_UNIX);
            $end = new ilDateTime($item['end'], IL_CAL_UNIX);

            if (ilDateTime::_within($today, $start, $end, IL_CAL_DAY)) {
                $current[] = $item;
            } elseif (ilDateTime::_before($start, $today, IL_CAL_DAY)) {
                $previous[] = $item;
            } elseif (ilDateTime::_after($start, $today, IL_CAL_DAY)) {
                $next[] = $item;
            }
        }
        $num_previous_remove = max(
            count($previous) - $limit_prev,
            0
        );
        while ($num_previous_remove--) {
            if (!$user->getPref('crs_sess_show_prev_' . $container->getId())) {
                array_shift($previous);
            }
            $items['sess_link']['prev']['value'] = 1;
        }

        $num_next_remove = max(
            count($next) - $limit_next,
            0
        );
        while ($num_next_remove--) {
            if (!$user->getPref('crs_sess_show_next_' . $container->getId())) {
                array_pop($next);
            }
            // @fixme
            $items['sess_link']['next']['value'] = 1;
        }

        $sessions = array_merge($previous, $current, $next);
        $items['sess'] = $sessions;

        // #15389 - see ilContainer::getSubItems()
        $sort = ilContainerSorting::_getInstance($container->getId());
        $items[(int) $admin_panel_enabled][(int) $include_side_block] = $sort->sortItems($items);
        return $items;
    }
} // END class.ilContainerSessionsContentGUI