Class ilStudyProgrammeProgressListGUI. More...

Inheritance diagram for ilStudyProgrammeProgressListGUI:

Collaboration diagram for ilStudyProgrammeProgressListGUI:

Public Member Functions
	__construct (ilStudyProgrammeUserProgress $a_progress)

	getHTML ()

	setShowInfoMessage ($show_info_mesage)

	setVisibleOnPDMode ($visible_on_pd_mode)

	setOnlyRelevant ($only_relevant)

Data Fields
const	SUCCESSFUL_PROGRESS_CSS_CLASS = "ilCourseObjectiveProgressBarCompleted"

const	NON_SUCCESSFUL_PROGRESS_CSS_CLASS = "ilCourseObjectiveProgressBarNeutral"

Protected Member Functions
	fillTemplate ($tpl)

	getTitleForItem (ilObjStudyProgramme $a_programme)

	getTemplate ($a_component, $a_file, $a_remove_unknown_vars, $a_remove_empty_blocks)

	getIconPath ($a_obj_id)

	getAltIcon ($a_obj_id)

	getTitleAndIconTarget (ilStudyProgrammeUserProgress $a_progress)

	buildProgressBar (ilStudyProgrammeUserProgress $a_progress)

	buildToolTip (ilStudyProgrammeUserProgress $a_progress)

	buildProgressStatus (ilStudyProgrammeUserProgress $a_progress)

	showMoreObjectsInfo ($programme)

Protected Attributes
	$il_lng

	$il_ctrl

	$progress

	$html

	$show_info_mesage

	$visible_on_pd_mode

	$only_relevant = false

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

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 13 of file class.ilStudyProgrammeProgressListGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilStudyProgrammeProgressListGUI::__construct ( ilStudyProgrammeUserProgress $a_progress )

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

References $DIC, $ilCtrl, and $lng.

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

Member Function Documentation

◆ buildProgressBar()

ilStudyProgrammeProgressListGUI::buildProgressBar ( ilStudyProgrammeUserProgress $a_progress )

protected

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

References buildProgressStatus(), buildToolTip(), ilStudyProgrammeUserProgress\getAmountOfPoints(), ilStudyProgrammeUserProgress\getCurrentAmountOfPoints(), ilStudyProgrammeUserProgress\getMaximumPossibleAmountOfPoints(), ilStudyProgrammeUserProgress\isSuccessful(), and ilContainerObjectiveGUI\renderProgressBar().

Referenced by fillTemplate().

                                                                                       {
                 $tooltip_id = "prg_".$a_progress->getId();
                 
                 $required_amount_of_points = $a_progress->getAmountOfPoints();
                 $maximum_possible_amount_of_points = $a_progress->getMaximumPossibleAmountOfPoints(true);
                 $current_amount_of_points = $a_progress->getCurrentAmountOfPoints();
 
                 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);
                 }
                 else {
                         if ($a_progress->isSuccessful()) {
                                 $current_percent = 100;
                                 $required_percent = 100;
                         }
                         else {
                                 $current_percent = 0;
                                 $required_percent = 0;
                         }
                 }
                 
                 //required to dodge bug in ilContainerObjectiveGUI::renderProgressBar
                 if($required_percent == 0) {
                         $required_percent = 0.1;
                 }
                 
                 $tooltip_txt = $this->buildToolTip($a_progress);
                 $progress_status = $this->buildProgressStatus($a_progress);
                 
                 if ($a_progress->isSuccessful()) {
                         $css_class = self::SUCCESSFUL_PROGRESS_CSS_CLASS;
                 }
                 else {
                         $css_class = self::NON_SUCCESSFUL_PROGRESS_CSS_CLASS;
                 }
 
                 require_once("Services/Container/classes/class.ilContainerObjectiveGUI.php");
                 return ilContainerObjectiveGUI::renderProgressBar($current_percent, $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 ( ilStudyProgrammeUserProgress $a_progress )

protected

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

References ilStudyProgrammeUserProgress\getAmountOfPoints(), ilStudyProgrammeUserProgress\getCurrentAmountOfPoints(), ilStudyProgrammeUserProgress\getMaximumPossibleAmountOfPoints(), and ilStudyProgrammeUserProgress\getStudyProgramme().

Referenced by buildProgressBar().

                                                                                          {
                 $lang_val = "prg_progress_status";
                 $max_points = $a_progress->getAmountOfPoints();
                 $study_programm = $a_progress->getStudyProgramme();
 
                 if($study_programm->hasChildren() && !$study_programm->hasLPChildren()) {
                         $lang_val = "prg_progress_status_with_child_sp";
                 }
 
                 if($a_progress->getStudyProgramme()->hasChildren()) {
                         $max_points = $a_progress->getMaximumPossibleAmountOfPoints($this->only_relevant);
                 }
                 return sprintf( $this->il_lng->txt($lang_val)
                                           , $a_progress->getCurrentAmountOfPoints()
                                           , $max_points
                                           );
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildToolTip()

ilStudyProgrammeProgressListGUI::buildToolTip ( ilStudyProgrammeUserProgress $a_progress )

protected

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

References ilStudyProgrammeUserProgress\getAmountOfPoints(), and ilStudyProgrammeUserProgress\getCurrentAmountOfPoints().

Referenced by buildProgressBar().

                                                                                   {
                 return sprintf( $this->il_lng->txt("prg_progress_info")
                                           , $a_progress->getCurrentAmountOfPoints()
                                           , $a_progress->getAmountOfPoints()
                                           );
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fillTemplate()

ilStudyProgrammeProgressListGUI::fillTemplate ( $tpl )

protected

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

References $tpl, buildProgressBar(), getAltIcon(), getIconPath(), getTitleAndIconTarget(), getTitleForItem(), and showMoreObjectsInfo().

Referenced by getHTML().

                                               {
                 $programme = $this->progress->getStudyProgramme();
                 $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_mesage) {
                         if($this->showMoreObjectsInfo($programme)) {
                                 $tpl->setVariable("MORE_OBJECTS",$this->il_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 ( $a_obj_id )

protected

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

Referenced by fillTemplate().

                                                  {
                 return $this->il_lng->txt("icon")." ".$this->il_lng->txt("obj_prg");
         }

Here is the caller graph for this function:

◆ getHTML()

ilStudyProgrammeProgressListGUI::getHTML ( )

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

References $html, $tpl, fillTemplate(), and getTemplate().

                                   {
                 if ($this->html === null) {
                         $tpl = $this->getTemplate("Modules/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 ( $a_obj_id )

protected

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

References ilObject\_getIcon().

Referenced by fillTemplate().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTemplate()

ilStudyProgrammeProgressListGUI::getTemplate	(	$a_component,
		$a_file,
		$a_remove_unknown_vars,
		$a_remove_empty_blocks
	)

protected

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

Referenced by getHTML().

                                                                                                               {
                 return new ilTemplate($a_file, $a_remove_unknown_vars, $a_remove_empty_blocks, $a_component);
         }

Here is the caller graph for this function:

◆ getTitleAndIconTarget()

ilStudyProgrammeProgressListGUI::getTitleAndIconTarget ( ilStudyProgrammeUserProgress $a_progress )

protected

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

References ilStudyProgrammeUserProgress\getId().

Referenced by fillTemplate().

                                                                                            {
                 $this->il_ctrl->setParameterByClass("ilPersonalDesktopGUI", "prg_progress_id", $a_progress->getId());
                 $this->il_ctrl->setParameterByClass("ilPersonalDesktopGUI", "expand", 1);
                 $link = $this->il_ctrl->getLinkTargetByClass("ilPersonalDesktopGUI", "jumpToSelectedItems");
                 $this->il_ctrl->setParameterByClass("ilPersonalDesktopGUI", "prg_progress_id", null);
                 $this->il_ctrl->setParameterByClass("ilPersonalDesktopGUI", "expand", null);
                 return $link;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTitleForItem()

ilStudyProgrammeProgressListGUI::getTitleForItem ( ilObjStudyProgramme $a_programme )

protected

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

References ilObject\getTitle().

Referenced by fillTemplate().

                                                                              {
                 return $a_programme->getTitle();
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setOnlyRelevant()

ilStudyProgrammeProgressListGUI::setOnlyRelevant ( $only_relevant )

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

References $only_relevant.

                                                         {
                 $this->only_relevant = $only_relevant;
         }

◆ setShowInfoMessage()

ilStudyProgrammeProgressListGUI::setShowInfoMessage ( $show_info_mesage )

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

References $show_info_mesage.

                                                               {
                 $this->show_info_mesage = $show_info_mesage;
         }

◆ setVisibleOnPDMode()

ilStudyProgrammeProgressListGUI::setVisibleOnPDMode ( $visible_on_pd_mode )

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

References $visible_on_pd_mode.

                                                                 {
                 $this->visible_on_pd_mode = $visible_on_pd_mode;
         }

◆ showMoreObjectsInfo()

ilStudyProgrammeProgressListGUI::showMoreObjectsInfo ( $programme )

protected

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

References $read, and ilObjStudyProgrammeAdmin\SETTING_VISIBLE_ON_PD_ALLWAYS.

Referenced by fillTemplate().

                                                            {
                 $children = $programme->getChildren();
                 foreach ($children as $key => $child) {
                         $read = $this->il_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;
         }