ilAchievements Class Reference

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

Collaboration diagram for ilAchievements:

Public Member Functions
	isActive (int $service)
	Is sub-service active? More...
	isAnyActive ()
	Is any sub-service active? More...
	getActiveServices ()
	Get active services. More...

Data Fields
const	SERV_LEARNING_HISTORY = 1
const	SERV_COMPETENCES = 2
const	SERV_LEARNING_PROGRESS = 3
const	SERV_BADGES = 4
const	SERV_CERTIFICATES = 5

Protected Attributes
ilLearningHistoryService	$learing_history
array	$services
ilSetting	$setting
ilSetting	$skmg_setting

Private Attributes
ilCertificateActiveValidator	$validator

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 19 of file class.ilAchievements.php.

Member Function Documentation

getActiveServices()

ilAchievements::getActiveServices

(

)

Get active services.

Returns

int[]

Definition at line 98 of file class.ilAchievements.php.

References isActive().

                                       : array
    {
        return array_filter($this->services, function ($s) {
            return $this->isActive($s);
        });
    }

Here is the call graph for this function:

isActive()

ilAchievements::isActive

(

int

$service

)

Is sub-service active?

Definition at line 57 of file class.ilAchievements.php.

References ilObjUserTracking\_enabledLearningProgress(), ilObjUserTracking\_hasLearningProgressLearner(), ilObjUserTracking\_hasLearningProgressOtherUsers(), and ilBadgeHandler\getInstance().

Referenced by getActiveServices(), and isAnyActive().

                                          : bool
    {
        switch ($service) {
            case self::SERV_LEARNING_HISTORY:
                return $this->learing_history->isActive();

            case self::SERV_COMPETENCES:
                return (bool) $this->skmg_setting->get("enable_skmg");

            case self::SERV_LEARNING_PROGRESS:
                return ilObjUserTracking::_enabledLearningProgress() &&
                    (ilObjUserTracking::_hasLearningProgressOtherUsers() ||
                        ilObjUserTracking::_hasLearningProgressLearner());

            case self::SERV_BADGES:
                return ilBadgeHandler::getInstance()->isActive();

            case self::SERV_CERTIFICATES:
                return $this->validator->validate();

        }
        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isAnyActive()

ilAchievements::isAnyActive

(

)

Is any sub-service active?

Definition at line 84 of file class.ilAchievements.php.

References isActive().

                                 : bool
    {
        foreach ($this->services as $s) {
            if ($this->isActive($s)) {
                return true;
            }
        }
        return false;
    }

Here is the call graph for this function:

Field Documentation

$learing_history

ilLearningHistoryService ilAchievements::$learing_history

protected

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

$services

array ilAchievements::$services

protected

Initial value:

= [
        self::SERV_LEARNING_HISTORY,
        self::SERV_COMPETENCES,
        self::SERV_LEARNING_PROGRESS,
        self::SERV_BADGES,
        self::SERV_CERTIFICATES
    ]

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

$setting

ilSetting ilAchievements::$setting

protected

Definition at line 40 of file class.ilAchievements.php.

$skmg_setting

ilSetting ilAchievements::$skmg_setting

protected

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

$validator

ilCertificateActiveValidator ilAchievements::$validator

private

Definition at line 21 of file class.ilAchievements.php.

SERV_BADGES

const ilAchievements::SERV_BADGES = 4

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

Referenced by ilAchievementsGUI\getGUIClasses(), and ilAchievementsGUI\getLinks().

SERV_CERTIFICATES

const ilAchievements::SERV_CERTIFICATES = 5

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

Referenced by ilAchievementsGUI\getGUIClasses(), and ilAchievementsGUI\getLinks().

SERV_COMPETENCES

const ilAchievements::SERV_COMPETENCES = 2

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

Referenced by ilAchievementsGUI\getGUIClasses(), and ilAchievementsGUI\getLinks().

SERV_LEARNING_HISTORY

const ilAchievements::SERV_LEARNING_HISTORY = 1

Definition at line 25 of file class.ilAchievements.php.

Referenced by ilAchievementsGUI\getGUIClasses(), and ilAchievementsGUI\getLinks().

SERV_LEARNING_PROGRESS

const ilAchievements::SERV_LEARNING_PROGRESS = 3

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

Referenced by ilAchievementsGUI\getGUIClasses(), and ilAchievementsGUI\getLinks().

---

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

• Services/Dashboard/Achievements/classes/class.ilAchievements.php