ilCourseLPBadgeGUI 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 ilCourseLPBadgeGUI:

Collaboration diagram for ilCourseLPBadgeGUI:

Public Member Functions
	__construct ()
	initConfigForm (ilPropertyFormGUI $a_form, int $a_parent_ref_id)
	Add custom fields to form. More...
	importConfigToForm (ilPropertyFormGUI $a_form, array $a_config)
	Set form values. More...
	getConfigFromForm (ilPropertyFormGUI $a_form)
	Export values to DB. More...
	validateForm (ilPropertyFormGUI $a_form)
	Custom form validation. More...

Static Public Member Functions
static	getInvalidLPModes ()

Protected Member Functions
	getLPTypes (int $a_parent_ref_id)

Protected Attributes
int	$parent_ref_id = 0
ilTree	$tree
ilCtrlInterface	$ctrl
ilLanguage	$lng

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 Course LP badge gui

Author

Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version

$Id:$

Definition at line 24 of file class.ilCourseLPBadgeGUI.php.

Constructor & Destructor Documentation

__construct()

ilCourseLPBadgeGUI::__construct

(

)

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

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

    {
        global $DIC;

        $this->tree = $DIC->repositoryTree();
        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->lng->loadLanguageModule('trac');
    }

Here is the call graph for this function:

Member Function Documentation

getConfigFromForm()

ilCourseLPBadgeGUI::getConfigFromForm

(

ilPropertyFormGUI

$a_form

)

Export values to DB.

Implements ilBadgeTypeGUI.

Definition at line 102 of file class.ilCourseLPBadgeGUI.php.

References ilPropertyFormGUI\getInput().

                                                                : array
    {
        return ["subitems" => $a_form->getInput("subitems")];
    }

Here is the call graph for this function:

getInvalidLPModes()

static ilCourseLPBadgeGUI::getInvalidLPModes ( )

static

Definition at line 107 of file class.ilCourseLPBadgeGUI.php.

References ilObjUserTracking\_enabledLearningProgress(), ilLPObjSettings\LP_MODE_COLLECTION, ilLPObjSettings\LP_MODE_COLLECTION_MANUAL, ilLPObjSettings\LP_MODE_COLLECTION_MOBS, ilLPObjSettings\LP_MODE_COLLECTION_TLT, ilLPObjSettings\LP_MODE_DEACTIVATED, ilLPObjSettings\LP_MODE_MANUAL, ilLPObjSettings\LP_MODE_MANUAL_BY_TUTOR, ilLPObjSettings\LP_MODE_SCORM, ilLPObjSettings\LP_MODE_UNDEFINED, and ilLPObjSettings\LP_MODE_VISITS.

Referenced by initConfigForm().

                                              : array
    {

        /* supported modes
            LP_MODE_TLT
            LP_MODE_OBJECTIVES
            LP_MODE_TEST_FINISHED
            LP_MODE_TEST_PASSED
            LP_MODE_EXERCISE_RETURNED
            LP_MODE_EVENT
            LP_MODE_SCORM_PACKAGE
            LP_MODE_PLUGIN
            LP_MODE_QUESTIONS
            LP_MODE_SURVEY_FINISHED
            LP_MODE_VISITED_PAGES
            LP_MODE_DOWNLOADED
            LP_MODE_STUDY_PROGRAMME ?!
         */

        $invalid_modes = array(ilLPObjSettings::LP_MODE_DEACTIVATED,
                               ilLPObjSettings::LP_MODE_UNDEFINED
        );

        // without active LP the following modes cannot be supported
        if (!ilObjUserTracking::_enabledLearningProgress()) {
            // status cannot be set without active LP
            $invalid_modes[] = ilLPObjSettings::LP_MODE_MANUAL;
            $invalid_modes[] = ilLPObjSettings::LP_MODE_MANUAL_BY_TUTOR;
            $invalid_modes[] = ilLPObjSettings::LP_MODE_COLLECTION_MANUAL;

            // mode cannot be configured without active LP
            $invalid_modes[] = ilLPObjSettings::LP_MODE_COLLECTION;
            $invalid_modes[] = ilLPObjSettings::LP_MODE_COLLECTION_MOBS;
            $invalid_modes[] = ilLPObjSettings::LP_MODE_COLLECTION_TLT;
            $invalid_modes[] = ilLPObjSettings::LP_MODE_SCORM;
            $invalid_modes[] = ilLPObjSettings::LP_MODE_VISITS; // ?
        }
        return $invalid_modes;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getLPTypes()

ilCourseLPBadgeGUI::getLPTypes ( int  $a_parent_ref_id )

protected

PhpUndefinedMethodInspection

Definition at line 74 of file class.ilCourseLPBadgeGUI.php.

References $res, ilObjUserTracking\_enabledLearningProgress(), ilObjectLP\getTypeClass(), and ilObjectLP\isSupportedObjectType().

Referenced by initConfigForm().

                                                       : array
    {
        $res = [];
        $root = $this->tree->getNodeData($a_parent_ref_id);
        $sub_items = $this->tree->getSubTree($root);
        array_shift($sub_items); // remove root

        foreach ($sub_items as $node) {
            if (ilObjectLP::isSupportedObjectType($node["type"])) {
                $class = ilObjectLP::getTypeClass($node["type"]);
                $modes = $class::getDefaultModes(ilObjUserTracking::_enabledLearningProgress());
                if (count($modes) > 1) {
                    $res[] = $node["type"];
                }
            }
        }
        return $res;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

importConfigToForm()

ilCourseLPBadgeGUI::importConfigToForm	(	ilPropertyFormGUI	$a_form,
		array	$a_config
	)

Set form values.

Implements ilBadgeTypeGUI.

Definition at line 94 of file class.ilCourseLPBadgeGUI.php.

References ilPropertyFormGUI\getItemByPostVar().

                                                                                  : void
    {
        if (is_array($a_config["subitems"])) {
            $items = $a_form->getItemByPostVar("subitems");
            $items->setValue($a_config["subitems"]);
        }
    }

Here is the call graph for this function:

initConfigForm()

ilCourseLPBadgeGUI::initConfigForm	(	ilPropertyFormGUI	$a_form,
		int	$a_parent_ref_id
	)

Add custom fields to form.

Implements ilBadgeTypeGUI.

Definition at line 42 of file class.ilCourseLPBadgeGUI.php.

References ilObject\_lookupObjId(), ilObject\_lookupTitle(), ilPropertyFormGUI\addItem(), ilRepositorySelector2InputGUI\getExplorerGUI(), ilObjectLP\getInstance(), getInvalidLPModes(), getLPTypes(), ILIAS\Repository\int(), ILIAS\Repository\lng(), and ilRepositorySelector2InputGUI\setTitleModifier().

                                                                                   : void
    {
        $this->parent_ref_id = $a_parent_ref_id;

        $subitems = new ilRepositorySelector2InputGUI($this->lng->txt("objects"), "subitems", true);

        $exp = $subitems->getExplorerGUI();
        $exp->setSkipRootNode(true);
        $exp->setRootId($this->parent_ref_id);
        $white = $this->getLPTypes($this->parent_ref_id);
        $exp->setSelectableTypes($white);
        if (!in_array("fold", $white)) {
            $white[] = "fold";
        }
        $exp->setTypeWhiteList($white);
        $subitems->setTitleModifier(function ($a_id): string {
            $a_id = (int) $a_id;

            $obj_id = ilObject::_lookupObjId($a_id);
            $olp = ilObjectLP::getInstance($obj_id);
            $invalid_modes = ilCourseLPBadgeGUI::getInvalidLPModes();
            $mode = $olp->getModeText($olp->getCurrentMode());
            if (in_array($olp->getCurrentMode(), $invalid_modes)) {
                $mode = "<strong>$mode</strong>";
            }
            return ilObject::_lookupTitle(ilObject::_lookupObjId($a_id)) . " (" . $mode . ")";
        });

        $subitems->setRequired(true);
        $a_form->addItem($subitems);
    }

Here is the call graph for this function:

validateForm()

ilCourseLPBadgeGUI::validateForm

(

ilPropertyFormGUI

$a_form

)

Custom form validation.

Implements ilBadgeTypeGUI.

Definition at line 147 of file class.ilCourseLPBadgeGUI.php.

References $ref_id, ilObject\_lookupObjId(), ilObject\_lookupTitle(), ilPropertyFormGUI\getInput(), ilObjectLP\getInstance(), ilPropertyFormGUI\getItemByPostVar(), and ILIAS\Repository\lng().

                                                           : bool
    {
        $invalid = array();
        $invalid_modes = self::getInvalidLPModes();
        foreach ($a_form->getInput("subitems") as $ref_id) {
            $obj_id = ilObject::_lookupObjId((int) $ref_id);
            $olp = ilObjectLP::getInstance($obj_id);
            if (in_array($olp->getCurrentMode(), $invalid_modes)) {
                $invalid[] = ilObject::_lookupTitle($obj_id);
            }
        }
        if ($invalid !== []) {
            $mess = sprintf($this->lng->txt("badge_course_lp_invalid"), implode(", ", $invalid));
            $a_form->getItemByPostVar("subitems")->setAlert($mess);
            return false;
        }
        return true;
    }

Here is the call graph for this function:

Field Documentation

$ctrl

ilCtrlInterface ilCourseLPBadgeGUI::$ctrl

protected

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

$lng

ilLanguage ilCourseLPBadgeGUI::$lng

protected

Definition at line 30 of file class.ilCourseLPBadgeGUI.php.

$parent_ref_id

int ilCourseLPBadgeGUI::$parent_ref_id = 0

protected

Definition at line 26 of file class.ilCourseLPBadgeGUI.php.

$tree

ilTree ilCourseLPBadgeGUI::$tree

protected

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

---

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

• Modules/Course/classes/Badges/class.ilCourseLPBadgeGUI.php