Class ilStudyProgrammeProgressListGUI. More...

Inheritance diagram for ilStudyProgrammeProgressListGUI:

Collaboration diagram for ilStudyProgrammeProgressListGUI:

Public Member Functions
	__construct (ilPRGProgress $a_progress)

	getHTML ()

	setShowInfoMessage (bool $show_info_message)

	setVisibleOnPDMode (string $visible_on_pd_mode)

	setOnlyRelevant (bool $only_relevant)

Protected Member Functions
	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
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

Static Protected Attributes
static string	$tpl_file = "tpl.progress_list_item.html"

Private Attributes
const	SUCCESSFUL_PROGRESS_CSS_CLASS = "ilCourseObjectiveProgressBarCompleted"

const	NON_SUCCESSFUL_PROGRESS_CSS_CLASS = "ilCourseObjectiveProgressBarNeutral"

Detailed Description

Class ilStudyProgrammeProgressListGUI.

Author: : Richard Klees richa.nosp@m.rd.k.nosp@m.lees@.nosp@m.conc.nosp@m.epts-.nosp@m.and-.nosp@m.train.nosp@m.ing..nosp@m.de; : Stefan Hecken stefa.nosp@m.n.he.nosp@m.cken@.nosp@m.conc.nosp@m.epts-.nosp@m.and-.nosp@m.train.nosp@m.ing..nosp@m.de

Definition at line 27 of file class.ilStudyProgrammeProgressListGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilStudyProgrammeProgressListGUI::__construct ( ilPRGProgress $a_progress )

Definition at line 44 of file class.ilStudyProgrammeProgressListGUI.php.

References $DIC, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\Repository\html(), ILIAS\Repository\lng(), and null.

     {
         global $DIC;
         $this->lng = $DIC['lng'];
         $this->lng->loadLanguageModule("prg");
         $this->ctrl = $DIC['ilCtrl'];
         $this->access = $DIC['ilAccess'];
 
         $this->progress = $a_progress;
         $this->tpl = null;
         $this->html = null;
         $this->show_info_message = false;
         $this->visible_on_pd_mode = "read";
     }

Here is the call graph for this function:

Member Function Documentation

◆ buildProgressBar()

ilStudyProgrammeProgressListGUI::buildProgressBar ( ilPRGProgress $progress )

protected

Definition at line 137 of file class.ilStudyProgrammeProgressListGUI.php.

References buildProgressStatus(), buildToolTip(), ilPRGProgress\getAmountOfPoints(), ilPRGProgress\getCurrentAmountOfPoints(), ILIAS\StudyProgramme\Assignment\Node\getId(), ilPRGProgress\getPossiblePointsOfRelevantChildren(), ILIAS\Repository\int(), ilPRGProgress\isSuccessful(), null, and ilContainerObjectiveGUI\renderProgressBar().

Referenced by fillTemplate().

                                                                 : string
     {
         $tooltip_id = "prg_" . $progress->getId();
         $required_amount_of_points = $progress->getAmountOfPoints();
 
         $maximum_possible_amount_of_points = $progress->getPossiblePointsOfRelevantChildren();
 
         $current_amount_of_points = $progress->getCurrentAmountOfPoints();
         $current_percent = 0;
         $required_percent = 0;
 
         if ($maximum_possible_amount_of_points > 0) {
             $current_percent = (int) ($current_amount_of_points * 100 / $maximum_possible_amount_of_points);
             $required_percent = (int) ($required_amount_of_points * 100 / $maximum_possible_amount_of_points);
         } elseif ($progress->isSuccessful()) {
             $current_percent = 100;
             $required_percent = 100;
         }
 
         //required to dodge bug in ilContainerObjectiveGUI::renderProgressBar
         if ($required_percent === 0) {
             $required_percent = 0.1;
         }
 
         $tooltip_txt = $this->buildToolTip($progress);
         $progress_status = $this->buildProgressStatus($progress);
 
         if ($progress->isSuccessful()) {
             $css_class = self::SUCCESSFUL_PROGRESS_CSS_CLASS;
         } else {
             $css_class = self::NON_SUCCESSFUL_PROGRESS_CSS_CLASS;
         }
 
         return ilContainerObjectiveGUI::renderProgressBar(
             (int)$current_percent,
             (int)$required_percent,
             $css_class,
             $progress_status,
             null,
             $tooltip_id,
             $tooltip_txt
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildProgressStatus()

ilStudyProgrammeProgressListGUI::buildProgressStatus ( ilPRGProgress $progress )

protected

Definition at line 190 of file class.ilStudyProgrammeProgressListGUI.php.

References ilPRGProgress\getAmountOfPoints(), ilPRGProgress\getCurrentAmountOfPoints(), ilObjStudyProgramme\getInstanceByObjId(), ilPRGProgress\getNodeId(), ilPRGProgress\getPossiblePointsOfRelevantChildren(), and ILIAS\Repository\lng().

Referenced by buildProgressBar().

                                                                    : string
     {
         $lang_val = "prg_progress_status";
         $max_points = $progress->getAmountOfPoints();
         $programme = ilObjStudyProgramme::getInstanceByObjId($progress->getNodeId());
 
         if ($programme->hasChildren() && !$programme->hasLPChildren()) {
             $lang_val = "prg_progress_status_with_child_sp";
         }
 
         if ($programme->hasChildren()) {
             $max_points = $progress->getPossiblePointsOfRelevantChildren($progress);
         }
 
         return sprintf(
             $this->lng->txt($lang_val),
             $progress->getCurrentAmountOfPoints(),
             $max_points
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildToolTip()

ilStudyProgrammeProgressListGUI::buildToolTip ( ilPRGProgress $progress )

protected

Definition at line 181 of file class.ilStudyProgrammeProgressListGUI.php.

References ilPRGProgress\getAmountOfPoints(), ilPRGProgress\getCurrentAmountOfPoints(), and ILIAS\Repository\lng().

Referenced by buildProgressBar().

                                                             : string
     {
         return sprintf(
             $this->lng->txt("prg_progress_info"),
             $progress->getCurrentAmountOfPoints(),
             $progress->getAmountOfPoints()
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fillTemplate()

ilStudyProgrammeProgressListGUI::fillTemplate ( ilTemplate $tpl )

protected

Definition at line 69 of file class.ilStudyProgrammeProgressListGUI.php.

References buildProgressBar(), getAltIcon(), getIconPath(), ilObjStudyProgramme\getInstanceByObjId(), getTitleAndIconTarget(), getTitleForItem(), ILIAS\Repository\lng(), ilTemplate\parseCurrentBlock(), ilTemplate\setCurrentBlock(), HTML_Template_IT\setVariable(), and showMoreObjectsInfo().

Referenced by getHTML().

                                                     : void
     {
         $programme = ilObjStudyProgramme::getInstanceByObjId($this->progress->getNodeId());
         $title_and_icon_target = $this->getTitleAndIconTarget($this->progress);
 
         if ($title_and_icon_target) {
             $tpl->setCurrentBlock("linked_icon");
             $tpl->setVariable("SRC_ICON", $this->getIconPath($programme->getId()));
             $tpl->setVariable("ALT_ICON", $this->getAltIcon($programme->getId()));
             $tpl->setVariable("ICON_HREF", $title_and_icon_target);
             $tpl->parseCurrentBlock();
 
             $tpl->setCurrentBlock("linked_title");
             $tpl->setVariable("TXT_TITLE", $this->getTitleForItem($programme));
             $tpl->setVariable("HREF_TITLE", $title_and_icon_target);
             $tpl->parseCurrentBlock();
         } else {
             $tpl->setCurrentBlock("not_linked_icon");
             $tpl->setVariable("SRC_ICON", $this->getIconPath($programme->getId()));
             $tpl->setVariable("ALT_ICON", $this->getAltIcon($programme->getId()));
             $tpl->parseCurrentBlock();
 
             $tpl->setCurrentBlock("not_linked_title");
             $tpl->setVariable("TXT_TITLE", $this->getTitleForItem($programme));
             $tpl->parseCurrentBlock();
         }
 
         if ($this->show_info_message && $this->showMoreObjectsInfo($programme)) {
             $tpl->setVariable("MORE_OBJECTS", $this->lng->txt("prg_more_objects_without_read_permission"));
         }
         $tpl->setVariable("TXT_DESC", $programme->getDescription());
         $tpl->setVariable("PROGRESS_BAR", $this->buildProgressBar($this->progress));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAltIcon()

ilStudyProgrammeProgressListGUI::getAltIcon ( )

protected

Definition at line 122 of file class.ilStudyProgrammeProgressListGUI.php.

References ILIAS\Repository\lng().

Referenced by fillTemplate().

                                    : string
     {
         return $this->lng->txt("icon") . " " . $this->lng->txt("obj_prg");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getHTML()

ilStudyProgrammeProgressListGUI::getHTML ( )

Definition at line 59 of file class.ilStudyProgrammeProgressListGUI.php.

References $html, fillTemplate(), ILIAS\UICore\GlobalTemplate\get(), getTemplate(), ILIAS\Repository\html(), and null.

                              : string
     {
         if ($this->html === null) {
             $tpl = $this->getTemplate("components/ILIAS/StudyProgramme", static::$tpl_file, true, true);
             $this->fillTemplate($tpl);
             $this->html = $tpl->get();
         }
         return $this->html;
     }

Here is the call graph for this function:

◆ getIconPath()

ilStudyProgrammeProgressListGUI::getIconPath ( int $obj_id )

protected

Definition at line 117 of file class.ilStudyProgrammeProgressListGUI.php.

References ilObject\_getIcon().

Referenced by fillTemplate().

                                                : string
     {
         return ilObject::_getIcon($obj_id, "small", "prg");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTemplate()

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

protected

Definition at line 108 of file class.ilStudyProgrammeProgressListGUI.php.

Referenced by getHTML().

      : ilTemplate {
         return new ilTemplate($file, $remove_unknown_vars, $remove_empty_blocks, $component);
     }

Here is the caller graph for this function:

◆ getTitleAndIconTarget()

ilStudyProgrammeProgressListGUI::getTitleAndIconTarget ( ilPRGProgress $progress )

protected

Definition at line 127 of file class.ilStudyProgrammeProgressListGUI.php.

References ILIAS\Repository\ctrl(), ILIAS\StudyProgramme\Assignment\Node\getId(), and null.

Referenced by fillTemplate().

                                                                      : ?string
     {
         $this->ctrl->setParameterByClass("ilDashboardGUI", "prg_progress_id", $progress->getId());
         $this->ctrl->setParameterByClass("ilDashboardGUI", "expand", 1);
         $link = $this->ctrl->getLinkTargetByClass("ilDashboardGUI", "jumpToSelectedItems");
         $this->ctrl->setParameterByClass("ilDashboardGUI", "prg_progress_id", null);
         $this->ctrl->setParameterByClass("ilDashboardGUI", "expand", null);
         return $link;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTitleForItem()

ilStudyProgrammeProgressListGUI::getTitleForItem ( ilObjStudyProgramme $programme )

protected

Definition at line 103 of file class.ilStudyProgrammeProgressListGUI.php.

References ilObject\getTitle().

Referenced by fillTemplate().

                                                                       : string
     {
         return $programme->getTitle();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setOnlyRelevant()

ilStudyProgrammeProgressListGUI::setOnlyRelevant ( bool $only_relevant )

Definition at line 221 of file class.ilStudyProgrammeProgressListGUI.php.

References $only_relevant.

                                                         : void
     {
         $this->only_relevant = $only_relevant;
     }

◆ setShowInfoMessage()

ilStudyProgrammeProgressListGUI::setShowInfoMessage ( bool $show_info_message )

Definition at line 211 of file class.ilStudyProgrammeProgressListGUI.php.

References $show_info_message.

                                                                : void
     {
         $this->show_info_message = $show_info_message;
     }

◆ setVisibleOnPDMode()

ilStudyProgrammeProgressListGUI::setVisibleOnPDMode ( string $visible_on_pd_mode )

Definition at line 216 of file class.ilStudyProgrammeProgressListGUI.php.

References $visible_on_pd_mode.

                                                                   : void
     {
         $this->visible_on_pd_mode = $visible_on_pd_mode;
     }

◆ showMoreObjectsInfo()

ilStudyProgrammeProgressListGUI::showMoreObjectsInfo ( ilObjStudyProgramme $programme )

protected

Definition at line 226 of file class.ilStudyProgrammeProgressListGUI.php.

References ILIAS\Repository\access(), ilObjStudyProgramme\getChildren(), and ilObjStudyProgrammeAdmin\SETTING_VISIBLE_ON_PD_ALLWAYS.

Referenced by fillTemplate().

                                                                           : bool
     {
         $children = $programme->getChildren();
         foreach ($children as $child) {
             $read = $this->access->checkAccess("read", "", $child->getRefId(), "prg", $child->getId());
             if (!$read && $this->visible_on_pd_mode !== ilObjStudyProgrammeAdmin::SETTING_VISIBLE_ON_PD_ALLWAYS) {
                 return true;
             }
         }
 
         return false;
     }