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

Collaboration diagram for ilBadgeLearningHistoryProvider:

Public Member Functions
	__construct (int $user_id, ilLearningHistoryFactory $factory, ilLanguage $lng, ?ilTemplate $template=null, ?ilObjUser $current_user=null, ?\ILIAS\DI\UIServices $ui=null)
	isActive ()
	getEntries (int $ts_start, int $ts_end)
	getName ()
Public Member Functions inherited from ilAbstractLearningHistoryProvider
	__construct (int $user_id, ilLearningHistoryFactory $factory, ilLanguage $lng, ?ilTemplate $template=null)

Private Attributes
ilObjUser	$current_user
ILIAS DI UIServices	$ui

Additional Inherited Members
Protected Member Functions inherited from ilAbstractLearningHistoryProvider
	getUserId ()
	getFactory ()
	getLanguage ()
	getEmphasizedTitle (string $title)
Protected Attributes inherited from ilAbstractLearningHistoryProvider
int	$user_id
ilLearningHistoryFactory	$factory
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

Definition at line 19 of file class.ilBadgeLearningHistoryProvider.php.

Constructor & Destructor Documentation

__construct()

ilBadgeLearningHistoryProvider::__construct	(	int	$user_id,
		ilLearningHistoryFactory	$factory,
		ilLanguage	$lng,
		?ilTemplate	$template = null,
		?ilObjUser	$current_user = null,
		?\ILIAS\DI\UIServices	$ui = null
	)

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

References $DIC, ilAbstractLearningHistoryProvider\$template, ILIAS\GlobalScreen\Provider\__construct(), and ILIAS\Repository\ui().

      {
        global $DIC;

        parent::__construct($user_id, $factory, $lng, $template);

        $this->current_user = $current_user ?? $DIC->user();
        $this->ui = $ui ?? $DIC->ui();
    }

Here is the call graph for this function:

Member Function Documentation

getEntries()

ilBadgeLearningHistoryProvider::getEntries	(	int	$ts_start,
		int	$ts_end
	)

Returns

list<ilLearningHistoryEntry>

Implements ilLearningHistoryProviderInterface.

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

References $c, ilAbstractLearningHistoryProvider\$lng, $url, ilBadgeAssignment\getBadgesForUser(), ilAbstractLearningHistoryProvider\getEmphasizedTitle(), ilAbstractLearningHistoryProvider\getFactory(), ilUtil\getImagePath(), ilAbstractLearningHistoryProvider\getLanguage(), ilAbstractLearningHistoryProvider\getUserId(), ilLanguage\loadLanguageModule(), ilLanguage\txt(), and ILIAS\Repository\ui().

                                                          : array
    {
        $lng = $this->getLanguage();
        $lng->loadLanguageModule('badge');
        $completions = ilBadgeAssignment::getBadgesForUser($this->getUserId(), $ts_start, $ts_end);

        $entries = [];
        foreach ($completions as $c) {
            $title = $this->getEmphasizedTitle($c['title']);
            if ($this->current_user->getId() === $this->getUserId()) {
                $title = $this->ui->renderer()->render(
                    $this->ui->factory()->link()->standard(
                        $title,
                        $url = ilLink::_getLink($this->getUserId(), 'usr', [], '_bdg')
                    )
                );
            }
            $text1 = str_replace('$3$', $title, $lng->txt('badge_lhist_badge_completed'));
            $text2 = str_replace('$3$', $title, $lng->txt('badge_lhist_badge_completed_in'));
            $entries[] = $this->getFactory()->entry(
                $text1,
                $text2,
                ilUtil::getImagePath('standard/icon_bdga.svg'),
                $c['tstamp'],
                $c['parent_id']
            );
        }

        return $entries;
    }

Here is the call graph for this function:

getName()

ilBadgeLearningHistoryProvider::getName

(

)

Implements ilLearningHistoryProviderInterface.

Definition at line 82 of file class.ilBadgeLearningHistoryProvider.php.

References ilAbstractLearningHistoryProvider\getLanguage().

                             : string
    {
        return $this->getLanguage()->txt('obj_bdga');
    }

Here is the call graph for this function:

isActive()

ilBadgeLearningHistoryProvider::isActive

(

)

Implements ilLearningHistoryProviderInterface.

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

References ilBadgeHandler\getInstance().

                              : bool
    {
        if (ilBadgeHandler::getInstance()->isActive()) {
            return true;
        }
        return false;
    }

Here is the call graph for this function:

Field Documentation

$current_user

ilObjUser ilBadgeLearningHistoryProvider::$current_user

private

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

$ui

ILIAS DI UIServices ilBadgeLearningHistoryProvider::$ui

private

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

---

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

• components/ILIAS/Badge/LearningHistory/classes/class.ilBadgeLearningHistoryProvider.php