ilBadgeLearningHistoryProvider Class Reference

Learning history provider: Badges. More...

Inheritance diagram for ilBadgeLearningHistoryProvider:

Collaboration diagram for ilBadgeLearningHistoryProvider:

Public Member Functions
	__construct ( $user_id, ilLearningHistoryFactory $factory, ilLanguage $lng, ilTemplate $template=null, ilObjUser $current_user=null, \ILIAS\DI\UIServices $ui=null)
	Constructor. More...
	isActive ()
	Is active? Returns bool More...
	getEntries ($ts_start, $ts_end)
	Get entries. Parameters int $ts_start int $ts_end Returns ilLearningHistoryEntry[] More...
	getName ()
	Get name of provider (in user language) Returns string More...
Public Member Functions inherited from ilAbstractLearningHistoryProvider
	__construct ( $user_id, ilLearningHistoryFactory $factory, ilLanguage $lng, ilTemplate $template=null)
	Constructor. More...

Protected Attributes
	$current_user
	$ui
Protected Attributes inherited from ilAbstractLearningHistoryProvider
	$user_id
	$factory
	$lng

Additional Inherited Members
Protected Member Functions inherited from ilAbstractLearningHistoryProvider
	getUserId ()
	Get user id. More...
	getFactory ()
	Get factory. More...
	getLanguage ()
	Get language object. More...
	getEmphasizedTitle ($title)
	Get emphasized title. More...

Detailed Description

Learning history provider: Badges.

Author

killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

__construct()

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

Constructor.

Parameters

int	$user_id
ilLearningHistoryFactory	$factory
ilLanguage	$lng
ilTemplate | null	$template

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

References $current_user, $DIC, ilAbstractLearningHistoryProvider\$template, $ui, and ilAbstractLearningHistoryProvider\$user_id.

      {
        global $DIC;

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

        if (is_null($current_user)) {
            $current_user = $DIC->user();
        }
        $this->current_user = $current_user;

        if (is_null($ui)) {
            $ui = $DIC->ui();
        }
        $this->ui = $ui;
    }

Member Function Documentation

getEntries()

ilBadgeLearningHistoryProvider::getEntries	(		$ts_start,
			$ts_end
	)

Get entries.

Parameters

int	$ts_start
int	$ts_end

Returns

ilLearningHistoryEntry[]

Implements ilLearningHistoryProviderInterface.

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

References $c, ilAbstractLearningHistoryProvider\$lng, $title, $url, ilLink\_getLink(), ilBadgeAssignment\getBadgesForUser(), ilAbstractLearningHistoryProvider\getEmphasizedTitle(), ilAbstractLearningHistoryProvider\getFactory(), ilUtil\getImagePath(), ilAbstractLearningHistoryProvider\getLanguage(), and ilAbstractLearningHistoryProvider\getUserId().

    {
        $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", array(), "_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("icon_bdga.svg"),
                $c["tstamp"],
                $c["parent_id"]
            );
        }
        return $entries;
    }

Here is the call graph for this function:

getName()

ilBadgeLearningHistoryProvider::getName

(

)

Get name of provider (in user language)

Returns

string

Implements ilLearningHistoryProviderInterface.

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

References ilAbstractLearningHistoryProvider\$lng, and ilAbstractLearningHistoryProvider\getLanguage().

                              : string
    {
        $lng = $this->getLanguage();

        return $lng->txt("obj_bdga");
    }

Here is the call graph for this function:

isActive()

ilBadgeLearningHistoryProvider::isActive

(

)

Is active?

Returns

bool

Implements ilLearningHistoryProviderInterface.

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

References ilBadgeHandler\getInstance().

    {
        require_once 'Services/Badge/classes/class.ilBadgeHandler.php';
        if (ilBadgeHandler::getInstance()->isActive()) {
            return true;
        }
        return false;
    }

Here is the call graph for this function:

Field Documentation

$current_user

ilBadgeLearningHistoryProvider::$current_user

protected

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

Referenced by __construct().

$ui

ilBadgeLearningHistoryProvider::$ui

protected

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

Referenced by __construct().

---

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

• Services/Badge/LearningHistory/classes/class.ilBadgeLearningHistoryProvider.php