This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilStudyProgrammeExpandableProgressListGUI:

Collaboration diagram for ilStudyProgrammeExpandableProgressListGUI:

Public Member Functions
	__construct (ilPRGProgress $progress)

	setIndent (int $indent)

	getHTML ()

Public Member Functions inherited from ilStudyProgrammeProgressListGUI
	__construct (ilPRGProgress $a_progress)

	getHTML ()

	setShowInfoMessage (bool $show_info_message)

	setVisibleOnPDMode (string $visible_on_pd_mode)

	setOnlyRelevant (bool $only_relevant)

Protected Member Functions
	getIndent ()

	fillTemplate (ilTemplate $tpl)

	getAccordionContentHTML ()

	getAccordionContentProgressesHTML ()

	shouldShowSubProgress (ilPRGProgress $progress)

	newSubItem (ilPRGProgress $progress)

	getAccordionContentCoursesHTML ()

	configureItemGUI (ilStudyProgrammeCourseListGUI $item_gui)

	getAccordionOptions ()

	getAccordionId ()

	getExpandedImageURL ()

	getNotExpandedImageURL ()

	getTitleAndIconTarget (ilPRGProgress $progress)

	showMyProgress ()

	addJavaScript ()

	addCSS ()

Protected Member Functions inherited from ilStudyProgrammeProgressListGUI
	fillTemplate (ilTemplate $tpl)

	getTitleForItem (ilObjStudyProgramme $programme)

	getTemplate (string $component, string $file, bool $remove_unknown_vars, bool $remove_empty_blocks)

	getIconPath (int $obj_id)

	getAltIcon ()

	getTitleAndIconTarget (ilPRGProgress $progress)

	buildProgressBar (ilPRGProgress $progress)

	buildToolTip (ilPRGProgress $progress)

	buildProgressStatus (ilPRGProgress $progress)

	showMoreObjectsInfo (ilObjStudyProgramme $programme)

Protected Attributes
ilRbacSystem	$rbacsystem

ilSetting	$setting

ilAccess	$access

ILIAS HTTP Wrapper RequestWrapper	$request_wrapper

ILIAS Refinery Factory	$refinery

int	$indent = 0

bool	$js_added = false

bool	$css_added = false

string	$alert_icon

Protected Attributes inherited from ilStudyProgrammeProgressListGUI
ilLanguage	$lng

ilCtrl	$ctrl

ilAccess	$access

ilPRGProgress	$progress

ilGlobalTemplateInterface	$tpl

string	$html

bool	$show_info_message

string	$visible_on_pd_mode

bool	$only_relevant = false

Additional Inherited Members
Static Protected Attributes inherited from ilStudyProgrammeProgressListGUI
static string	$tpl_file = "tpl.progress_list_item.html"

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

Definition at line 21 of file class.ilStudyProgrammeExpandableProgressListGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilStudyProgrammeExpandableProgressListGUI::__construct ( ilPRGProgress $progress )

Definition at line 34 of file class.ilStudyProgrammeExpandableProgressListGUI.php.

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\access(), ilUtil\getImagePath(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

     {
         parent::__construct($progress);
 
         global $DIC;
         $this->tpl = $DIC['tpl'];
         $this->rbacsystem = $DIC['rbacsystem'];
         $this->setting = $DIC['ilSetting'];
         $this->access = $DIC['ilAccess'];
         $this->request_wrapper = $DIC->http()->wrapper()->query();
         $this->refinery = $DIC->refinery();
 
         $ui_factory = $DIC['ui.factory'];
         $ui_renderer = $DIC['ui.renderer'];
         $this->alert_icon = $ui_renderer->render(
             $ui_factory->symbol()->icon()
                 ->custom(ilUtil::getImagePath("icon_alert.svg"), $this->lng->txt("warning"))
                 ->withSize('medium')
         );
     }

Here is the call graph for this function:

Member Function Documentation

◆ addCSS()

ilStudyProgrammeExpandableProgressListGUI::addCSS ( )

protected

Returns: false|void

Definition at line 278 of file class.ilStudyProgrammeExpandableProgressListGUI.php.

Referenced by getHTML().

     {
         if ($this->css_added) {
             return false;
         }
 
         $this->tpl->addCSS("Modules/StudyProgramme/templates/css/ilStudyProgramme.css");
         $this->css_added = true;
     }

Here is the caller graph for this function:

◆ addJavaScript()

ilStudyProgrammeExpandableProgressListGUI::addJavaScript ( )

protected

Returns: false|void

Definition at line 264 of file class.ilStudyProgrammeExpandableProgressListGUI.php.

References iljQueryUtil\initjQueryUI().

Referenced by getHTML().

     {
         if ($this->js_added) {
             return false;
         }
 
         iljQueryUtil::initjQueryUI();
         $this->tpl->addJavaScript("./Services/Accordion/js/accordion.js", true, 3);
         $this->js_added = true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ configureItemGUI()

ilStudyProgrammeExpandableProgressListGUI::configureItemGUI ( ilStudyProgrammeCourseListGUI $item_gui )

protected

Definition at line 192 of file class.ilStudyProgrammeExpandableProgressListGUI.php.

Referenced by getAccordionContentCoursesHTML().

                                                                                 : void
     {
         $item_gui->enableComments(false);
         $item_gui->enableTags(false);
         $item_gui->enableIcon(true);
         $item_gui->enableDelete(false);
         $item_gui->enableCut(false);
         $item_gui->enableCopy(false);
         $item_gui->enableLink(false);
         $item_gui->enableInfoScreen(true);
         $item_gui->enableSubscribe(true);
         $item_gui->enableCheckbox(false);
         $item_gui->enableDescription(true);
         $item_gui->enableProperties(true);
         $item_gui->enablePreconditions(true);
         $item_gui->enableNoticeProperties(true);
         $item_gui->enableCommands(true, true);
         $item_gui->enableProgressInfo(true);
         $item_gui->setIndent($this->getIndent() + 2);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fillTemplate()

ilStudyProgrammeExpandableProgressListGUI::fillTemplate ( ilTemplate $tpl )

protected

Definition at line 73 of file class.ilStudyProgrammeExpandableProgressListGUI.php.

References $i, getAccordionContentHTML(), getAccordionId(), getAccordionOptions(), getExpandedImageURL(), getIndent(), getNotExpandedImageURL(), ILIAS\Repository\lng(), ilTemplate\parseCurrentBlock(), ilTemplate\setCurrentBlock(), HTML_Template_IT\setVariable(), showMyProgress(), and ilTemplate\touchBlock().

                                                     : void
     {
         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->lng->txt("expand"));
             $tpl->setVariable("EXP_IMG", $this->getExpandedImageURL());
             $tpl->setVariable("NOT_EXP_ALT", $this->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->tpl->addOnloadCode("il.Accordion.add(" . json_encode($this->getAccordionOptions(), JSON_THROW_ON_ERROR) . ");");
         $tpl->parseCurrentBlock();
     }

Here is the call graph for this function:

◆ getAccordionContentCoursesHTML()

ilStudyProgrammeExpandableProgressListGUI::getAccordionContentCoursesHTML ( )

protected

Definition at line 160 of file class.ilStudyProgrammeExpandableProgressListGUI.php.

References ilObject\_exists(), ilObject\_lookupDeletedDate(), configureItemGUI(), ilObjectListGUI\CONTEXT_PERSONAL_DESKTOP, ilObject\getDescription(), ilObject\getId(), ilObjStudyProgramme\getInstanceByObjId(), ilObjectFactory\getInstanceByRefId(), ilObject\getRefId(), and ilObject\getTitle().

Referenced by getAccordionContentHTML().

                                                        : string
     {
         $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->getRefId(), true) &&
                 is_null(ilObject::_lookupDeletedDate($il_obj_crs_ref->getRefId()))
             ) {
                 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) {
             $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));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAccordionContentHTML()

ilStudyProgrammeExpandableProgressListGUI::getAccordionContentHTML ( )

protected

Definition at line 112 of file class.ilStudyProgrammeExpandableProgressListGUI.php.

References getAccordionContentCoursesHTML(), getAccordionContentProgressesHTML(), and ilObjStudyProgramme\getInstanceByObjId().

Referenced by fillTemplate().

                                                 : string
     {
         $programme = ilObjStudyProgramme::getInstanceByObjId($this->progress->getNodeId());
 
         if (!$programme->hasLPChildren()) {
             return $this->getAccordionContentProgressesHTML();
         }
 
         return $this->getAccordionContentCoursesHTML();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAccordionContentProgressesHTML()

ilStudyProgrammeExpandableProgressListGUI::getAccordionContentProgressesHTML ( )

protected

Definition at line 123 of file class.ilStudyProgrammeExpandableProgressListGUI.php.

References ilStudyProgrammeProgressListGUI\$progress, getIndent(), newSubItem(), and shouldShowSubProgress().

Referenced by getAccordionContentHTML().

                                                           : string
     {
         // Make shouldShowSubProgress and newSubItem protected again afterwards, do
         // the same in the derived class ilStudyProgrammeIndividualPlanProgressListGUI.
         $child_progresses = $this->progress->getSubnodes();
 
         return implode("\n", array_map(function (ilPRGProgress $progress) {
             if (!$this->shouldShowSubProgress($progress)) {
                 return "";
             }
             $gui = $this->newSubItem($progress);
             $gui->setIndent($this->getIndent() + 1);
             return $gui->getHTML();
         }, $child_progresses));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAccordionId()

ilStudyProgrammeExpandableProgressListGUI::getAccordionId ( )

protected

Definition at line 235 of file class.ilStudyProgrammeExpandableProgressListGUI.php.

References getIndent().

Referenced by fillTemplate(), and getAccordionOptions().

                                        : string
     {
         return "prg_progress_" . $this->progress->getId() . "_" . $this->getIndent();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAccordionOptions()

ilStudyProgrammeExpandableProgressListGUI::getAccordionOptions ( )

protected

Definition at line 213 of file class.ilStudyProgrammeExpandableProgressListGUI.php.

References getAccordionId().

Referenced by fillTemplate().

                                             : array
     {
         return [
             "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,
             "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,
         ];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getExpandedImageURL()

ilStudyProgrammeExpandableProgressListGUI::getExpandedImageURL ( )

protected

Definition at line 240 of file class.ilStudyProgrammeExpandableProgressListGUI.php.

References ilUtil\getImagePath().

Referenced by fillTemplate().

                                             : string
     {
         return ilUtil::getImagePath("tree_exp.svg");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getHTML()

ilStudyProgrammeExpandableProgressListGUI::getHTML ( )

Definition at line 66 of file class.ilStudyProgrammeExpandableProgressListGUI.php.

References addCSS(), and addJavaScript().

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

Here is the call graph for this function:

◆ getIndent()

ilStudyProgrammeExpandableProgressListGUI::getIndent ( )

protected

Definition at line 55 of file class.ilStudyProgrammeExpandableProgressListGUI.php.

References $indent.

Referenced by ilStudyProgrammeIndividualPlanProgressListGUI\configureItemGUI(), configureItemGUI(), fillTemplate(), getAccordionContentProgressesHTML(), and getAccordionId().

                                   : int
     {
         return $this->indent;
     }

Here is the caller graph for this function:

◆ getNotExpandedImageURL()

ilStudyProgrammeExpandableProgressListGUI::getNotExpandedImageURL ( )

protected

Definition at line 245 of file class.ilStudyProgrammeExpandableProgressListGUI.php.

References ilUtil\getImagePath().

Referenced by fillTemplate().

                                                : string
     {
         return ilUtil::getImagePath("tree_col.svg");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTitleAndIconTarget()

ilStudyProgrammeExpandableProgressListGUI::getTitleAndIconTarget ( ilPRGProgress $progress )

protected

Definition at line 250 of file class.ilStudyProgrammeExpandableProgressListGUI.php.

                                                                      : ?string
     {
         return null;
     }

◆ newSubItem()

ilStudyProgrammeExpandableProgressListGUI::newSubItem ( ilPRGProgress $progress )

protected

Definition at line 155 of file class.ilStudyProgrammeExpandableProgressListGUI.php.

Referenced by getAccordionContentProgressesHTML().

                                                           : ilStudyProgrammeExpandableProgressListGUI
     {
         return new ilStudyProgrammeExpandableProgressListGUI($progress);
     }

Here is the caller graph for this function:

◆ setIndent()

ilStudyProgrammeExpandableProgressListGUI::setIndent ( int $indent )

Definition at line 60 of file class.ilStudyProgrammeExpandableProgressListGUI.php.

References $indent.

                                           : void
     {
         assert($indent >= 0);
         $this->indent = $indent;
     }

◆ shouldShowSubProgress()

ilStudyProgrammeExpandableProgressListGUI::shouldShowSubProgress ( ilPRGProgress $progress )

protected

Definition at line 139 of file class.ilStudyProgrammeExpandableProgressListGUI.php.

References ILIAS\Repository\access(), ilObjStudyProgramme\getInstanceByObjId(), ilPRGProgress\getNodeId(), ilPRGProgress\isRelevant(), and ilObjStudyProgrammeAdmin\SETTING_VISIBLE_ON_PD_READ.

Referenced by getAccordionContentProgressesHTML().

                                                                      : bool
     {
         if ($progress->isRelevant()) {
             $prg = ilObjStudyProgramme::getInstanceByObjId($progress->getNodeId());
 
             $can_read = $this->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;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showMyProgress()

ilStudyProgrammeExpandableProgressListGUI::showMyProgress ( )

protected

Definition at line 255 of file class.ilStudyProgrammeExpandableProgressListGUI.php.

References ILIAS\Repository\refinery().

Referenced by fillTemplate().

                                        : bool
     {
         $prg_progress_id = $this->request_wrapper->retrieve("prg_progress_id", $this->refinery->kindlyTo()->int());
         return  $prg_progress_id === $this->progress->getId();
     }