class.ilStudyProgrammeExpandableProgressListGUI.php

Go to the documentation of this file.

<?php

/* Copyright (c) 2015 Richard Klees <richard.klees@concepts-and-training.de> Extended GPL, see docs/LICENSE */

require_once("Modules/StudyProgramme/classes/class.ilStudyProgrammeProgressListGUI.php");
require_once('./Modules/StudyProgramme/classes/class.ilObjStudyProgrammeAdmin.php');

class ilStudyProgrammeExpandableProgressListGUI extends ilStudyProgrammeProgressListGUI
{
    protected $indent = 0;

    protected $js_added = false;

    protected $css_added = false;

    protected $il_tpl;

    protected $il_rbacsystem;

    public function __construct(ilStudyProgrammeProgress $a_progress)
    {
        parent::__construct($a_progress);

        global $DIC;
        $tpl = $DIC['tpl'];
        $rbacsystem = $DIC['rbacsystem'];
        $ilSetting = $DIC['ilSetting'];
        $ilAccess = $DIC['ilAccess'];
        $this->il_tpl = $tpl;
        $this->il_rbacsystem = $rbacsystem;
        $this->il_setting = $ilSetting;
        $this->il_access = $ilAccess;
    }

    protected function getIndent()
    {
        return $this->indent;
    }

    public function setIndent($a_indent)
    {
        assert(is_int($a_indent));
        assert($a_indent >= 0);
        $this->indent = $a_indent;
    }

    public function getHTML()
    {
        $this->addJavaScript();
        $this->addCSS();
        return parent::getHTML();
    }

    protected function fillTemplate($tpl)
    {
        require_once("./Services/JSON/classes/class.ilJsonUtil.php");

        parent::fillTemplate($tpl);

        if ($this->showMyProgress()) {
            $tpl->setVariable("ACTIVE_HEAD", "il_PrgAccordionHeadActive");
        }

        $tpl->setVariable("ACCORDION_ID", 'id="' . $this->getAccordionId() . '"');
        $tpl->setVariable("HREF_TITLE", "");

        $content = $this->getAccordionContentHTML();

        if (trim($content)) {
            $tpl->setCurrentBlock("expand");
            $tpl->setVariable("EXP_ALT", $this->il_lng->txt("expand"));
            $tpl->setVariable("EXP_IMG", $this->getExpandedImageURL());
            $tpl->setVariable("NOT_EXP_ALT", $this->il_lng->txt("expanded"));
            $tpl->setVariable("NOT_EXP_IMG", $this->getNotExpandedImageURL());
            $tpl->parseCurrentBlock();
        } else {
            $tpl->touchBlock("indent");
        }

        for ($i = 0; $i < $this->getIndent(); $i++) {
            $tpl->touchBlock("indent");
        }

        $tpl->setCurrentBlock("accordion");
        if ($this->showMyProgress()) {
            $tpl->setVariable("ACCORDION_HIDE_CONTENT", "");
        } else {
            $tpl->setVariable("ACCORDION_HIDE_CONTENT", "ilAccHideContent");
        }
        $tpl->setVariable("ACCORDION_CONTENT", $content);
        $this->il_tpl->addOnloadCode("il.Accordion.add(" . ilJsonUtil::encode($this->getAccordionOptions()) . ");");
        $tpl->parseCurrentBlock();
    }

    protected function getAccordionContentHTML()
    {
        $programme = ilObjStudyProgramme::getInstanceByObjId($this->progress->getNodeId());

        if (!$programme->hasLPChildren()) {
            return $this->getAccordionContentProgressesHTML();
        } else {
            return $this->getAccordionContentCoursesHTML();
        }
    }

    protected function getAccordionContentProgressesHTML()
    {
        // Make shouldShowSubProgress and newSubItem protected again afterwards, do
        // the same in the derived class ilStudyProgrammeIndividualPlanProgressListGUI.
        $programme = ilObjStudyProgramme::getInstanceByObjId($this->progress->getNodeId());
        $child_progresses = $programme->getChildrenProgress($this->progress);

        return implode("\n", array_map(function (ilStudyProgrammeProgress $progress) {
            if (!$this->shouldShowSubProgress($progress)) {
                return "";
            }
            $gui = $this->newSubItem($progress);
            $gui->setIndent($this->getIndent() + 1);
            return $gui->getHTML();
        }, $child_progresses));
    }

    protected function shouldShowSubProgress(ilStudyProgrammeProgress $a_progress)
    {
        if ($a_progress->isRelevant()) {
            $prg = ilObjStudyProgramme::getInstanceByObjId($a_progress->getNodeId());

            $can_read = $this->il_access->checkAccess("read", "", $prg->getRefId(), "prg", $prg->getId());
            if ($this->visible_on_pd_mode == ilObjStudyProgrammeAdmin::SETTING_VISIBLE_ON_PD_READ && !$can_read) {
                return false;
            }

            return true;
        }

        return false;
    }

    protected function newSubItem(ilStudyProgrammeProgress $a_progress)
    {
        return new ilStudyProgrammeExpandableProgressListGUI($a_progress);
    }

    protected function getAccordionContentCoursesHTML()
    {
        include_once("./Services/Object/classes/class.ilObjectListGUIPreloader.php");
        $preloader = new ilObjectListGUIPreloader(ilObjectListGUI::CONTEXT_PERSONAL_DESKTOP);

        $crs = array();
        $prg = ilObjStudyProgramme::getInstanceByObjId($this->progress->getNodeId());
        foreach ($prg->getLPChildren() as $il_obj_crs_ref) {
            if (ilObject::_exists($il_obj_crs_ref, true) &&
                is_null(ilObject::_lookupDeletedDate($il_obj_crs_ref))
            ) {
                continue;
            }

            $course = ilObjectFactory::getInstanceByRefId($il_obj_crs_ref->getTargetRefId());
            $preloader->addItem($course->getId(), $course->getType(), $course->getRefId());
            $crs[] = $course;
        }
        $preloader->preload();

        return implode("\n", array_map(function (ilObjCourse $course) {
            require_once("Modules/StudyProgramme/classes/class.ilStudyProgrammeCourseListGUI.php");
            require_once("Modules/StudyProgramme/classes/class.ilStudyProgrammeContainerObjectMock.php");

            $item_gui = new ilStudyProgrammeCourseListGUI();
            $this->configureItemGUI($item_gui);
            $item_gui->setContainerObject(new ilStudyProgrammeContainerObjectMock($course));
            return $item_gui->getListItemHTML(
                $course->getRefId(),
                $course->getId(),
                $course->getTitle(),
                $course->getDescription()
            );
        }, $crs));
    }
    
    protected function configureItemGUI(ilStudyProgrammeCourseListGUI $a_item_gui)
    {
        $a_item_gui->enableComments(false);
        $a_item_gui->enableTags(false);
        $a_item_gui->enableIcon(true);
        $a_item_gui->enableDelete(false);
        $a_item_gui->enableCut(false);
        $a_item_gui->enableCopy(false);
        $a_item_gui->enableLink(false);
        $a_item_gui->enableInfoScreen(true);
        $a_item_gui->enableSubscribe(true);
        $a_item_gui->enableCheckbox(false);
        $a_item_gui->enableDescription(true);
        $a_item_gui->enableProperties(true);
        $a_item_gui->enablePreconditions(true);
        $a_item_gui->enableNoticeProperties(true);
        $a_item_gui->enableCommands(true, true);
        $a_item_gui->enableProgressInfo(true);
        $a_item_gui->setIndent($this->getIndent() + 2);
    }

    protected function getAccordionOptions()
    {
        return array( "orientation" => "horizontal"
            // Most propably we don't need this. Or do we want to call ilAccordion.initById?
            , "int_id" => "prg_progress_" . $this->progress->getId()
            , "initial_opened" => null
            //, "save_url" => "./ilias.php?baseClass=ilaccordionpropertiesstorage&cmd=setOpenedTab&accordion_id=".$this->getId()."&user_id=".$ilUser->getId();
            , "behaviour" => "AllClosed" // or "FirstOpen"
            , "toggle_class" => 'il_PrgAccordionToggle'
            , "toggle_act_class" => 'foo'
            , "content_class" => 'il_PrgAccordionContent'
            , "width" => "auto"
            , "active_head_class" => "il_PrgAccordionHeadActive"
            , "height" => "auto"
            , "id" => $this->getAccordionId()
            , "multi" => true
            , "show_all_element" => null
            , "hide_all_element" => null
            , "reset_width" => true
            );
    }

    protected function getAccordionId()
    {
        return "prg_progress_" . $this->progress->getId() . "_" . $this->getIndent();
    }

    protected function getExpandedImageURL()
    {
        require_once("Services/Utilities/classes/class.ilUtil.php");
        return ilUtil::getImagePath("tree_exp.svg");
    }

    protected function getNotExpandedImageURL()
    {
        require_once("Services/Utilities/classes/class.ilUtil.php");
        return ilUtil::getImagePath("tree_col.svg");
    }

    protected function getTitleAndIconTarget(ilStudyProgrammeProgress $a_progress)
    {
        return null;
    }

    protected function showMyProgress()
    {
        return $_GET["prg_progress_id"] == $this->progress->getId();
    }

    protected function addJavaScript()
    {
        if ($this->js_added) {
            return false;
        }

        include_once("./Services/jQuery/classes/class.iljQueryUtil.php");
        iljQueryUtil::initjQueryUI();
        $this->il_tpl->addJavaScript("./Services/Accordion/js/accordion.js", true, 3);
        $this->js_added = true;
    }

    protected function addCSS()
    {
        if ($this->css_added) {
            return false;
        }

        $this->il_tpl->addCSS("Modules/StudyProgramme/templates/css/ilStudyProgramme.css");
        $this->css_added = true;
    }
}