ILIAS  release_5-3 Revision v5.3.23-19-g915713cf615
ilStudyProgrammeIndividualPlanProgressListGUI Class Reference

Class ilStudyProgrammeExpandableProgressListGUI. More...

+ Inheritance diagram for ilStudyProgrammeIndividualPlanProgressListGUI:
+ Collaboration diagram for ilStudyProgrammeIndividualPlanProgressListGUI:

Public Member Functions

 shouldShowSubProgress (ilStudyProgrammeUserProgress $a_progress)
 
 newSubItem (ilStudyProgrammeUserProgress $a_progress)
 
- Public Member Functions inherited from ilStudyProgrammeExpandableProgressListGUI
 __construct (ilStudyProgrammeUserProgress $a_progress)
 
 setIndent ($a_indent)
 
 getHTML ()
 
- Public Member Functions inherited from ilStudyProgrammeProgressListGUI
 __construct (ilStudyProgrammeUserProgress $a_progress)
 
 getHTML ()
 
 setShowInfoMessage ($show_info_mesage)
 
 setVisibleOnPDMode ($visible_on_pd_mode)
 
 setOnlyRelevant ($only_relevant)
 

Protected Member Functions

 showMyProgress ()
 
 getTitleForItem (ilObjStudyProgramme $a_programme)
 
 buildProgressStatus (ilStudyProgrammeUserProgress $a_progress)
 
 configureItemGUI (ilStudyProgrammeCourseListGUI $a_item_gui)
 
- Protected Member Functions inherited from ilStudyProgrammeExpandableProgressListGUI
 getIndent ()
 
 fillTemplate ($tpl)
 
 getAccordionContentHTML ()
 
 getAccordionContentProgressesHTML ()
 
 shouldShowSubProgress (ilStudyProgrammeUserProgress $a_progress)
 
 newSubItem (ilStudyProgrammeUserProgress $a_progress)
 
 getAccordionContentCoursesHTML ()
 
 configureItemGUI (ilStudyProgrammeCourseListGUI $a_item_gui)
 
 getAccordionOptions ()
 
 getAccordionId ()
 
 getExpandedImageURL ()
 
 getNotExpandedImageURL ()
 
 getTitleAndIconTarget (ilStudyProgrammeUserProgress $a_progress)
 
 showMyProgress ()
 
 addJavaScript ()
 
 addCSS ()
 
- Protected Member Functions inherited from ilStudyProgrammeProgressListGUI
 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)
 

Additional Inherited Members

- Data Fields inherited from ilStudyProgrammeProgressListGUI
const SUCCESSFUL_PROGRESS_CSS_CLASS = "ilCourseObjectiveProgressBarCompleted"
 
const NON_SUCCESSFUL_PROGRESS_CSS_CLASS = "ilCourseObjectiveProgressBarNeutral"
 
- Protected Attributes inherited from ilStudyProgrammeExpandableProgressListGUI
 $indent = 0
 
 $js_added = false
 
 $css_added = false
 
 $il_tpl
 
 $il_rbacsystem
 
- Protected Attributes inherited from ilStudyProgrammeProgressListGUI
 $il_lng
 
 $il_ctrl
 
 $progress
 
 $html
 
 $show_info_mesage
 
 $visible_on_pd_mode
 
 $only_relevant = false
 
- Static Protected Attributes inherited from ilStudyProgrammeProgressListGUI
static $tpl_file = "tpl.progress_list_item.html"
 

Detailed Description

Member Function Documentation

◆ buildProgressStatus()

ilStudyProgrammeIndividualPlanProgressListGUI::buildProgressStatus ( ilStudyProgrammeUserProgress  $a_progress)
protected

Definition at line 41 of file class.ilStudyProgrammeIndividualPlanProgressListGUI.php.

References ilStudyProgrammeUserProgress\canBeCompleted(), ilUtil\getImagePath(), and ilStudyProgrammeUserProgress\isSuccessful().

42  {
43  $points = parent::buildProgressStatus($a_progress);
44  if (!$a_progress->canBeCompleted() && !$a_progress->isSuccessful()) {
45  return "<img src='" . ilUtil::getImagePath("icon_alert.svg") . "' alt='" . $this->il_lng->txt("warning") . "'>" . $points;
46  } else {
47  return $points;
48  }
49  }
isSuccessful()
Check whether the user was successful on this node.
canBeCompleted()
Check whether the user can achieve enough points on the subnodes to be able to complete this node...
static getImagePath($img, $module_path="", $mode="output", $offline=false)
get image path (for images located in a template directory)
+ Here is the call graph for this function:

◆ configureItemGUI()

ilStudyProgrammeIndividualPlanProgressListGUI::configureItemGUI ( ilStudyProgrammeCourseListGUI  $a_item_gui)
protected

Definition at line 51 of file class.ilStudyProgrammeIndividualPlanProgressListGUI.php.

References ilObjectListGUI\enableCheckbox(), ilObjectListGUI\enableCommands(), ilObjectListGUI\enableComments(), ilObjectListGUI\enableCopy(), ilObjectListGUI\enableCut(), ilObjectListGUI\enableDelete(), ilObjectListGUI\enableDescription(), ilObjectListGUI\enableIcon(), ilObjectListGUI\enableInfoScreen(), ilObjectListGUI\enableLink(), ilObjectListGUI\enableNoticeProperties(), ilObjectListGUI\enablePreconditions(), ilObjectListGUI\enableProgressInfo(), ilObjectListGUI\enableProperties(), ilObjectListGUI\enableSubscribe(), ilObjectListGUI\enableTags(), ilStudyProgrammeExpandableProgressListGUI\getIndent(), and ilStudyProgrammeCourseListGUI\setIndent().

52  {
53  $a_item_gui->enableComments(false);
54  $a_item_gui->enableTags(false);
55  $a_item_gui->enableIcon(true);
56  $a_item_gui->enableDelete(false);
57  $a_item_gui->enableCut(false);
58  $a_item_gui->enableCopy(false);
59  $a_item_gui->enableLink(false);
60  $a_item_gui->enableInfoScreen(false);
61  $a_item_gui->enableSubscribe(false);
62  $a_item_gui->enableCheckbox(false);
63  $a_item_gui->enableDescription(true);
64  $a_item_gui->enableProperties(false);
65  $a_item_gui->enablePreconditions(false);
66  $a_item_gui->enableNoticeProperties(false);
67  $a_item_gui->enableCommands(false, true);
68  $a_item_gui->enableProgressInfo(false);
69  $a_item_gui->setIndent($this->getIndent() + 2);
70  }
enableInfoScreen($a_info_screen)
En/disable path.
enableDelete($a_status)
En/disable delete.
enableProperties($a_status)
En/disable properties.
enableCut($a_status)
En/disable cut.
enableSubscribe($a_status)
En/disable subscribe.
enablePreconditions($a_status)
En/disable preconditions.
enableDescription($a_status)
En/disable description.
enableProgressInfo($a_status)
enable progress info
enableNoticeProperties($a_status)
En/disable notices.
enableCommands($a_status, $a_std_only=false)
En/disable commands.
enableCopy($a_status)
En/disable copy.
enableComments($a_value, $a_enable_comments_settings=true)
Toogle comments action status.
enableIcon($a_status)
En/Dis-able icons.
enableCheckbox($a_status)
En/Dis-able checkboxes.
enableTags($a_value)
Toogle tags action status.
enableLink($a_status)
En/disable link.
+ Here is the call graph for this function:

◆ getTitleForItem()

ilStudyProgrammeIndividualPlanProgressListGUI::getTitleForItem ( ilObjStudyProgramme  $a_programme)
protected

Definition at line 32 of file class.ilStudyProgrammeIndividualPlanProgressListGUI.php.

References $title, ilObject\getTitle(), and ilStudyProgramme\STATUS_OUTDATED.

33  {
34  $title = $a_programme->getTitle();
35  if (!$this->progress->isRelevant() || $this->progress->getStudyProgramme()->getStatus() == ilStudyProgramme::STATUS_OUTDATED) {
36  return "<s>" . $title . "</s>";
37  }
38  return $title;
39  }
getTitle()
get object title public
+ Here is the call graph for this function:

◆ newSubItem()

ilStudyProgrammeIndividualPlanProgressListGUI::newSubItem ( ilStudyProgrammeUserProgress  $a_progress)

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

28  {
29  return new ilStudyProgrammeIndividualPlanProgressListGUI($a_progress);
30  }

◆ shouldShowSubProgress()

ilStudyProgrammeIndividualPlanProgressListGUI::shouldShowSubProgress ( ilStudyProgrammeUserProgress  $a_progress)

Definition at line 22 of file class.ilStudyProgrammeIndividualPlanProgressListGUI.php.

23  {
24  return true;
25  }

◆ showMyProgress()

ilStudyProgrammeIndividualPlanProgressListGUI::showMyProgress ( )
protected

Definition at line 16 of file class.ilStudyProgrammeIndividualPlanProgressListGUI.php.

17  {
18  // expand tree completely on start
19  return $this->progress->isRelevant();
20  }

The documentation for this class was generated from the following file: