ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
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)
 
 configureItemGUI (ilStudyProgrammeCourseListGUI $a_item_gui)
 
- Public Member Functions inherited from ilStudyProgrammeExpandableProgressListGUI
 __construct (ilStudyProgrammeUserProgress $a_progress)
 
 getIndent ()
 
 setIndent ($a_indent)
 
 getHTML ()
 
 shouldShowSubProgress (ilStudyProgrammeUserProgress $a_progress)
 
 newSubItem (ilStudyProgrammeUserProgress $a_progress)
 
 configureItemGUI (ilStudyProgrammeCourseListGUI $a_item_gui)
 
- 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)
 
- Protected Member Functions inherited from ilStudyProgrammeExpandableProgressListGUI
 fillTemplate ($tpl)
 
 getAccordionContentHTML ()
 
 getAccordionContentProgressesHTML ()
 
 getAccordionContentCoursesHTML ()
 
 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

Reimplemented from ilStudyProgrammeProgressListGUI.

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

36 {
37 $points = parent::buildProgressStatus($a_progress);
38 if (!$a_progress->canBeCompleted() && !$a_progress->isSuccessful()) {
39 return "<img src='".ilUtil::getImagePath("icon_alert.svg")."' alt='".$this->il_lng->txt("warning")."'>".$points;
40 }
41 else {
42 return $points;
43 }
44 }
canBeCompleted()
Check whether the user can achieve enough points on the subnodes to be able to complete this node.
isSuccessful()
Check whether the user was successful on this node.

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

+ Here is the call graph for this function:

◆ configureItemGUI()

ilStudyProgrammeIndividualPlanProgressListGUI::configureItemGUI ( ilStudyProgrammeCourseListGUI  $a_item_gui)

Reimplemented from ilStudyProgrammeExpandableProgressListGUI.

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

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

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

+ Here is the call graph for this function:

◆ getTitleForItem()

ilStudyProgrammeIndividualPlanProgressListGUI::getTitleForItem ( ilObjStudyProgramme  $a_programme)
protected

Reimplemented from ilStudyProgrammeProgressListGUI.

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

28 {
29 $title = $a_programme->getTitle();
30 if (!$this->progress->isRelevant() || $this->progress->getStudyProgramme()->getStatus() == ilStudyProgramme::STATUS_OUTDATED) {
31 return "<s>".$title."</s>";
32 }
33 return $title;
34 }
getTitle()
get object title @access public

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

+ Here is the call graph for this function:

◆ newSubItem()

ilStudyProgrammeIndividualPlanProgressListGUI::newSubItem ( ilStudyProgrammeUserProgress  $a_progress)

◆ shouldShowSubProgress()

ilStudyProgrammeIndividualPlanProgressListGUI::shouldShowSubProgress ( ilStudyProgrammeUserProgress  $a_progress)

Reimplemented from ilStudyProgrammeExpandableProgressListGUI.

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

20 {
21 return true;
22 }

◆ showMyProgress()

ilStudyProgrammeIndividualPlanProgressListGUI::showMyProgress ( )
protected

Reimplemented from ilStudyProgrammeExpandableProgressListGUI.

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

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

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