ilStudyProgrammeIndividualPlanProgressListGUI Class Reference

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

Inheritance diagram for ilStudyProgrammeIndividualPlanProgressListGUI:

Collaboration diagram for ilStudyProgrammeIndividualPlanProgressListGUI:

Protected Member Functions
	showMyProgress ()
	shouldShowSubProgress (ilPRGProgress $progress)
	newSubItem (ilPRGProgress $progress)
	getTitleForItem (ilObjStudyProgramme $programme)
	buildProgressStatus (ilPRGProgress $progress)
	configureItemGUI (ilStudyProgrammeCourseListGUI $item_gui)
Protected Member Functions inherited from ilStudyProgrammeExpandableProgressListGUI
	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)

Additional Inherited Members
Public Member Functions inherited from ilStudyProgrammeExpandableProgressListGUI
	__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 Attributes inherited from ilStudyProgrammeExpandableProgressListGUI
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
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.ilStudyProgrammeIndividualPlanProgressListGUI.php.

Member Function Documentation

buildProgressStatus()

ilStudyProgrammeIndividualPlanProgressListGUI::buildProgressStatus ( ilPRGProgress  $progress )

protected

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

References ilObjStudyProgramme\getInstanceByObjId(), ilPRGProgress\getNodeId(), and ilPRGProgress\isSuccessful().

                                                                   : string
    {
        $programme = ilObjStudyProgramme::getInstanceByObjId($progress->getNodeId());
        $can_be_completed = $programme->canBeCompleted($progress);

        $points = parent::buildProgressStatus($progress);
        if (!$can_be_completed && !$progress->isSuccessful()) {
            return $this->alert_icon . $points;
        }

        return $points;
    }

Here is the call graph for this function:

configureItemGUI()

ilStudyProgrammeIndividualPlanProgressListGUI::configureItemGUI ( ilStudyProgrammeCourseListGUI  $item_gui )

protected

Definition at line 63 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().

                                                                                : 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(false);
        $item_gui->enableSubscribe(false);
        $item_gui->enableCheckbox(false);
        $item_gui->enableDescription(true);
        $item_gui->enableProperties(false);
        $item_gui->enablePreconditions(false);
        $item_gui->enableNoticeProperties(false);
        $item_gui->enableCommands(false, true);
        $item_gui->enableProgressInfo(false);
        $item_gui->setIndent($this->getIndent() + 2);
    }

Here is the call graph for this function:

getTitleForItem()

ilStudyProgrammeIndividualPlanProgressListGUI::getTitleForItem ( ilObjStudyProgramme  $programme )

protected

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

References ilObjStudyProgramme\getStatus(), ilObject\getTitle(), and ilStudyProgrammeSettings\STATUS_OUTDATED.

                                                                      : string
    {
        $title = $programme->getTitle();
        if (!$this->progress->isRelevant()
            || $programme->getStatus() === ilStudyProgrammeSettings::STATUS_OUTDATED
        ) {
            return "<s>" . $title . "</s>";
        }
        return $title;
    }

Here is the call graph for this function:

newSubItem()

ilStudyProgrammeIndividualPlanProgressListGUI::newSubItem ( ilPRGProgress  $progress )

protected

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

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

shouldShowSubProgress()

ilStudyProgrammeIndividualPlanProgressListGUI::shouldShowSubProgress ( ilPRGProgress  $progress )

protected

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

                                                                     : bool
    {
        return true;
    }

showMyProgress()

ilStudyProgrammeIndividualPlanProgressListGUI::showMyProgress ( )

protected

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

                                       : bool
    {
        // expand tree completely on start
        return $this->progress->isRelevant();
    }

---

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

• Modules/StudyProgramme/classes/class.ilStudyProgrammeIndividualPlanProgressListGUI.php