ilBadgeHandler Class Reference

Class ilBadgeHandler. More...

Collaboration diagram for ilBadgeHandler:

Public Member Functions
	isActive ()
	setActive (bool $a_value)
	getComponents ()
	setComponents (?array $a_components=null)
	getProviderInstance (string $a_component_id)
	getComponentCaption (string $a_component_id)
	getUniqueTypeId (string $a_component_id, ilBadgeType $a_badge)
	getTypeInstanceByUniqueId (string $a_id)
	Get type instance by unique id (component, type) More...
	getInactiveTypes ()
	setInactiveTypes (?array $a_types=null)
	getAvailableTypes (bool $exclude_inactive=true)
	Get badges types. More...
	getAvailableTypesForObjType (string $a_object_type)
	Get valid badges types for object type. More...
	getAvailableManualBadges (int $a_parent_obj_id, ?string $a_parent_obj_type=null)
	Get available manual badges for object id. More...
	isObjectActive (int $a_obj_id, ?string $a_obj_type=null)
	triggerEvaluation (string $a_type_id, int $a_user_id, ?array $a_params=null)
	getUserIds (int $a_parent_ref_id, ?int $a_parent_obj_id=null, ?string $a_parent_type=null)
	getInstancePath (ilBadgeAssignment $a_ass)
	countStaticBadgeInstances (ilBadge $a_badge)
	getBadgePath (ilBadge $a_badge)
	sendNotification (array $a_user_map, ?int $a_parent_ref_id=null)

Static Public Member Functions
static	getInstance ()
static	updateFromXML (string $a_component_id)
	Import component definition. More...
static	clearFromXML (string $a_component_id)
	Remove component definition. More...

Data Fields
const	GENERAL_INFO = 'inform_about_badges'

Protected Member Functions
	__construct ()
	getComponent (string $a_id)
	getBasePath ()
	countStaticBadgeInstancesHelper (int &$a_cnt, string $a_path)

Protected Attributes
ilComponentRepository	$component_repository
ilDBInterface	$db
ilTree	$tree
ilLanguage	$lng
ilSetting	$settings

Static Protected Attributes
static ilBadgeHandler	$instance = null

Detailed Description

Class ilBadgeHandler.

Author

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

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

Constructor & Destructor Documentation

__construct()

ilBadgeHandler::__construct ( )

protected

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

    {
        global $DIC;
 
        if (isset($DIC['component.repository'])) {
            $this->component_repository = $DIC['component.repository'];
        }
        $this->db = $DIC->database();
        if (isset($DIC['tree'])) {
            $this->tree = $DIC->repositoryTree();
        }
        $this->settings = new ilSetting('bdga');
    }

References $DIC, and ILIAS\Repository\settings().

Here is the call graph for this function:

Member Function Documentation

clearFromXML()

static ilBadgeHandler::clearFromXML ( string  $a_component_id )

static

Remove component definition.

Definition at line 302 of file class.ilBadgeHandler.php.

                                                               : void
    {
        $handler = self::getInstance();
        $components = $handler->getComponents();
        foreach ($components as $idx => $component) {
            if ($component === $a_component_id) {
                unset($components[$idx]);
            }
        }
        $handler->setComponents($components);
    }

References $components, and $handler.

countStaticBadgeInstances()

ilBadgeHandler::countStaticBadgeInstances

(

ilBadge

$a_badge

)

Definition at line 444 of file class.ilBadgeHandler.php.

                                                               : int
    {
        $path = $this->getBasePath() . 'instances/' . $a_badge->getId();
        $cnt = 0;
        if (is_dir($path)) {
            $this->countStaticBadgeInstancesHelper($cnt, $path);
        }
        return $cnt;
    }

References $path, and ilBadge\getId().

Here is the call graph for this function:

countStaticBadgeInstancesHelper()

ilBadgeHandler::countStaticBadgeInstancesHelper ( int &  $a_cnt, string  $a_path  )

protected

Definition at line 454 of file class.ilBadgeHandler.php.

     : void {
        foreach (glob($a_path . '/*') as $item) {
            if (is_dir($item)) {
                $this->countStaticBadgeInstancesHelper($a_cnt, $item);
            } elseif (str_ends_with($item, '.json')) {
                $a_cnt++;
            }
        }
    }

getAvailableManualBadges()

ilBadgeHandler::getAvailableManualBadges	(	int	$a_parent_obj_id,
		?string	$a_parent_obj_type = null
	)

Get available manual badges for object id.

Returns

array<int, string>

Definition at line 256 of file class.ilBadgeHandler.php.

     : array {
        $res = [];
 
        if (!$a_parent_obj_type) {
            $a_parent_obj_type = ilObject::_lookupType($a_parent_obj_id);
        }
 
        $badges = ilBadge::getInstancesByParentId($a_parent_obj_id);
        foreach (self::getInstance()->getAvailableTypesForObjType($a_parent_obj_type) as $type_id => $type) {
            if (!$type instanceof ilBadgeAuto) {
                foreach ($badges as $badge) {
                    if ($badge->getTypeId() === $type_id &&
                        $badge->isActive()) {
                        $res[$badge->getId()] = $badge->getTitle();
                    }
                }
            }
        }
 
        asort($res);
        return $res;
    }

References ilObject\_lookupType().

Here is the call graph for this function:

getAvailableTypes()

ilBadgeHandler::getAvailableTypes

(

bool

$exclude_inactive = true

)

Get badges types.

Returns

array<string, ilBadgeType>

Definition at line 215 of file class.ilBadgeHandler.php.

                                                                    : array
    {
        $res = [];
 
        $inactive = $this->getInactiveTypes();
        foreach ($this->getComponents() as $component_id) {
            $provider = $this->getProviderInstance($component_id);
            if ($provider) {
                foreach ($provider->getBadgeTypes() as $type) {
                    $id = $this->getUniqueTypeId($component_id, $type);
                    if (!$exclude_inactive || !in_array($id, $inactive, true)) {
                        $res[$id] = $type;
                    }
                }
            }
        }
 
        return $res;
    }

References $id, $provider, and $res.

getAvailableTypesForObjType()

ilBadgeHandler::getAvailableTypesForObjType

(

string

$a_object_type

)

Get valid badges types for object type.

Returns

array<string, ilBadgeType>

Definition at line 239 of file class.ilBadgeHandler.php.

                                                                      : array
    {
        $res = [];
 
        foreach ($this->getAvailableTypes() as $id => $type) {
            if (in_array($a_object_type, $type->getValidObjectTypes(), true)) {
                $res[$id] = $type;
            }
        }
 
        return $res;
    }

References $id, and $res.

getBadgePath()

ilBadgeHandler::getBadgePath

(

ilBadge

$a_badge

)

Definition at line 467 of file class.ilBadgeHandler.php.

                                                  : string
    {
        $hash = md5($a_badge->getId());
 
        $path = $this->getBasePath() . 'badges/' .
            floor($a_badge->getId() / 100) . '/' .
            $hash . '/';
 
        ilFileUtils::makeDirParents($path);
 
        return $path;
    }

References $path, ilBadge\getId(), and ilFileUtils\makeDirParents().

Here is the call graph for this function:

getBasePath()

ilBadgeHandler::getBasePath ( )

protected

Definition at line 424 of file class.ilBadgeHandler.php.

                                    : string
    {
        return ilFileUtils::getWebspaceDir() . '/pub_badges/';
    }

References ilFileUtils\getWebspaceDir().

Here is the call graph for this function:

getComponent()

ilBadgeHandler::getComponent ( string  $a_id )

protected

Definition at line 112 of file class.ilBadgeHandler.php.

                                                 : ?array
    {
        if (!$this->component_repository->hasComponentId($a_id)) {
            return null;
        }
        $component = $this->component_repository->getComponentById($a_id);
        return [
            'type' => $component->getType(),
            'name' => $component->getName()
        ];
    }

Referenced by getComponentCaption(), and getProviderInstance().

Here is the caller graph for this function:

getComponentCaption()

ilBadgeHandler::getComponentCaption

(

string

$a_component_id

)

Definition at line 140 of file class.ilBadgeHandler.php.

                                                               : string
    {
        $comp = $this->getComponent($a_component_id);
        if ($comp) {
            return $comp['type'] . '/' . $comp['name'];
        }
        return '';
    }

References getComponent().

Here is the call graph for this function:

getComponents()

ilBadgeHandler::getComponents

(

)

Returns

string[]

Definition at line 80 of file class.ilBadgeHandler.php.

                                   : array
    {
        $components = $this->settings->get('components', null);
        if ($components) {
            return unserialize($components, ['allowed_classes' => false]);
        }
 
        return [];
    }

References $components, and ILIAS\Repository\settings().

Here is the call graph for this function:

getInactiveTypes()

ilBadgeHandler::getInactiveTypes

(

)

Returns

string[]

Definition at line 184 of file class.ilBadgeHandler.php.

                                      : array
    {
        $types = $this->settings->get('inactive_types', null);
        if ($types) {
            return unserialize($types, ['allowed_classes' => false]);
        }
 
        return [];
    }

References ILIAS\Repository\settings().

Here is the call graph for this function:

getInstance()

static ilBadgeHandler::getInstance ( )

static

Definition at line 54 of file class.ilBadgeHandler.php.

                                        : self
    {
        if (!self::$instance) {
            self::$instance = new self();
        }
        return self::$instance;
    }

References $instance.

Referenced by ilBadgeManagementGUI\__construct(), ilObjBadgeAdministrationGUI\activateTypes(), ilBadgeManagementGUI\addBadge(), ilObjBadgeAdministrationGUI\assertActive(), ilBadgeManagementGUI\assignBadge(), ilBadgeManagementGUI\awardBadgeUserSelection(), ilObjBadgeAdministrationGUI\deactivateTypes(), ilBadge\deleteStaticFiles(), ilBadgeAssignment\deleteStaticFiles(), ilBadgeManagementGUI\editBadge(), ilBadgeManagementGUI\executeCommand(), ilObjBadgeAdministrationGUI\getAdminTabs(), ILIAS\Badge\ilBadgeTypesTableGUI\getRecords(), ILIAS\Badge\ilObjectBadgeTableGUI\getRecords(), ILIAS\Badge\Provider\BadgeMainBarProvider\getStaticSubItems(), ilObjCourseGUI\getTabs(), ilObjGroupGUI\getTabs(), ilBadge\getTypeInstance(), ilBadgeManagementGUI\getValidBadgesFromClipboard(), ilBadgeAppEventListener\handleEvent(), ilObjBadgeAdministrationGUI\initFormSettings(), ilBadgeLearningHistoryProvider\isActive(), ilAchievements\isActive(), ilBadgeManagementGUI\listBadges(), ilBadgeManagementGUI\listUsers(), ilBadgeDefinitionProcessor\purge(), ilBadgeManagementGUI\saveBadge(), ILIAS\User\Profile\PersonalProfileGUI\savePublicProfile(), ilObjBadgeAdministrationGUI\saveSettings(), ilBadgeManagementGUI\splitBadgeAndUserIdsFromString(), and ilObjectServiceSettingsGUI\updateServiceSettingsForm().

Here is the caller graph for this function:

getInstancePath()

ilBadgeHandler::getInstancePath

(

ilBadgeAssignment

$a_ass

)

Definition at line 429 of file class.ilBadgeHandler.php.

                                                             : string
    {
        $hash = md5($a_ass->getBadgeId() . '_' . $a_ass->getUserId());
 
        $path = $this->getBasePath() . 'instances/' .
            $a_ass->getBadgeId() . '/' .
            floor($a_ass->getUserId() / 1000) . '/';
 
        ilFileUtils::makeDirParents($path);
 
        $path .= $hash . '.json';
 
        return $path;
    }

References $path, ilBadgeAssignment\getBadgeId(), ilBadgeAssignment\getUserId(), and ilFileUtils\makeDirParents().

Here is the call graph for this function:

getProviderInstance()

ilBadgeHandler::getProviderInstance

(

string

$a_component_id

)

Definition at line 124 of file class.ilBadgeHandler.php.

                                                               : ?ilBadgeProvider
    {
        $comp = $this->getComponent($a_component_id);
        if ($comp) {
            $class = 'il' . $comp['name'] . 'BadgeProvider';
            $file = '../' . $comp['type'] . '/' . $comp['name'] . '/classes/class.' . $class . '.php';
            if (file_exists($file)) {
                $obj = new $class();
                if ($obj instanceof ilBadgeProvider) {
                    return $obj;
                }
            }
        }
        return null;
    }

References getComponent().

Here is the call graph for this function:

getTypeInstanceByUniqueId()

ilBadgeHandler::getTypeInstanceByUniqueId

(

string

$a_id

)

Get type instance by unique id (component, type)

Definition at line 163 of file class.ilBadgeHandler.php.

     : ?ilBadgeType {
        $parts = explode('/', $a_id);
        $comp_id = $parts[0];
        $type_id = $parts[1];
 
        $provider = $this->getProviderInstance($comp_id);
        if ($provider) {
            foreach ($provider->getBadgeTypes() as $type) {
                if ($type->getId() === $type_id) {
                    return $type;
                }
            }
        }
        return null;
    }

getUniqueTypeId()

ilBadgeHandler::getUniqueTypeId	(	string	$a_component_id,
		ilBadgeType	$a_badge
	)

Definition at line 153 of file class.ilBadgeHandler.php.

     : string {
        return $a_component_id . '/' . $a_badge->getId();
    }

getUserIds()

ilBadgeHandler::getUserIds	(	int	$a_parent_ref_id,
		?int	$a_parent_obj_id = null,
		?string	$a_parent_type = null
	)

Parameters

int | null	$a_parent_obj_id
string | null	$a_parent_type

Returns

int[]

Definition at line 379 of file class.ilBadgeHandler.php.

     : array {
        $tree = $this->tree;
 
        if (!$a_parent_obj_id) {
            $a_parent_obj_id = ilObject::_lookupObjectId($a_parent_ref_id);
        }
        if (!$a_parent_type) {
            $a_parent_type = ilObject::_lookupType($a_parent_obj_id);
        }
 
        // try to get participants from (parent) course/group
        switch ($a_parent_type) {
            case 'crs':
                $member_obj = ilCourseParticipants::_getInstanceByObjId($a_parent_obj_id);
                return $member_obj->getMembers();
 
            case 'grp':
                $member_obj = ilGroupParticipants::_getInstanceByObjId($a_parent_obj_id);
                return $member_obj->getMembers();
 
            default:
                // walk path to find course or group object and use members of that object
                /* this does not work since getParticipantsForObject does not exist
                $path = $tree->getPathId($a_parent_ref_id);
                array_pop($path);
                foreach (array_reverse($path) as $path_ref_id) {
                    $type = ilObject::_lookupType($path_ref_id, true);
                    if ($type == "crs" || $type == "grp") {
                        return $this->getParticipantsForObject($path_ref_id, null, $type);
                    }
                }*/
                break;
        }
        return [];
    }

References ilObject\_lookupObjectId().

Here is the call graph for this function:

isActive()

ilBadgeHandler::isActive

(

)

Definition at line 67 of file class.ilBadgeHandler.php.

                              : bool
    {
        return (bool) $this->settings->get('active', '');
    }

References ILIAS\Repository\settings().

Here is the call graph for this function:

isObjectActive()

ilBadgeHandler::isObjectActive	(	int	$a_obj_id,
		?string	$a_obj_type = null
	)

Definition at line 319 of file class.ilBadgeHandler.php.

     : bool {
        if (!$this->isActive()) {
            return false;
        }
 
        if (!$a_obj_type) {
            $a_obj_type = ilObject::_lookupType($a_obj_id);
        }
 
        if ($a_obj_type !== 'bdga' && !ilContainer::_lookupContainerSetting(
            $a_obj_id,
            ilObjectServiceSettingsGUI::BADGES,
            false
        )) {
            return false;
        }
 
        return true;
    }

sendNotification()

ilBadgeHandler::sendNotification	(	array	$a_user_map,
		?int	$a_parent_ref_id = null
	)

Definition at line 485 of file class.ilBadgeHandler.php.

     : void {
        $badges = [];
 
        foreach ($a_user_map as $user_id => $badge_ids) {
            $user_badges = [];
 
            foreach ($badge_ids as $badge_id) {
                // making extra sure
                if (!ilBadgeAssignment::exists($badge_id, $user_id)) {
                    continue;
                }
 
                if (!array_key_exists($badge_id, $badges)) {
                    $badges[$badge_id] = new ilBadge($badge_id);
                }
 
                $badge = $badges[$badge_id];
 
                $user_badges[] = $badge->getTitle();
            }
 
            if (count($user_badges)) {
                // compose and send mail
 
                $ntf = new ilSystemNotification(false);
                $ntf->setLangModules(['badge']);
 
                if (isset($a_parent_ref_id)) {
                    $ntf->setRefId($a_parent_ref_id);
                }
                $ntf->setGotoLangId('badge_notification_parent_goto');
 
                // user specific language
                $lng = $ntf->getUserLanguage($user_id);
 
                $ntf->setIntroductionLangId('badge_notification_body');
 
                $ntf->addAdditionalInfo('badge_notification_badges', implode("\n", $user_badges), true);
 
                $url = ilLink::_getLink($user_id, 'usr', [], '_bdg');
                $ntf->addAdditionalInfo('badge_notification_badges_goto', $url);
 
                $ntf->setReasonLangId('badge_notification_reason');
 
                // force email
                $mail = new ilMail(ANONYMOUS_USER_ID);
                $mail->enqueue(
                    ilObjUser::_lookupEmail($user_id),
                    '',
                    '',
                    $lng->txt('badge_notification_subject'),
                    $ntf->composeAndGetMessage($user_id, null, 'read', true),
                    []
                );
 
 
                // osd
                // bug #24562
                if (ilContext::hasHTML()) {
                    $url = new ilNotificationLink(new ilNotificationParameter('badge_notification_badges_goto', [], 'badge'), $url);
                    $osd_params = ['badge_list' => implode(', ', $user_badges)];
 
                    $notification = new ilNotificationConfig(BadgeNotificationProvider::NOTIFICATION_TYPE);
                    $notification->setTitleVar('badge_notification_subject', [], 'badge');
                    $notification->setShortDescriptionVar('badge_notification_osd', $osd_params, 'badge');
                    $notification->setLongDescriptionVar('');
                    $notification->setLinks([$url]);
                    $notification->setIconPath(ilUtil::getImagePath('standard/icon_bdga.svg'));
                    $notification->setValidForSeconds(ilNotificationConfig::TTL_SHORT);
                    $notification->setVisibleForSeconds(ilNotificationConfig::DEFAULT_TTS);
                    $notification->setIdentification(new NotificationIdentification(
                        BadgeNotificationProvider::NOTIFICATION_TYPE,
                        self::GENERAL_INFO
                    ));
                    $notification->notifyByUsers([$user_id]);
                }
            }
        }
    }

References $lng, $url, $user_id, ilObjUser\_lookupEmail(), ANONYMOUS_USER_ID, ilBadgeAssignment\exists(), ilUtil\getImagePath(), and ilContext\hasHTML().

Here is the call graph for this function:

setActive()

ilBadgeHandler::setActive

(

bool

$a_value

)

Definition at line 72 of file class.ilBadgeHandler.php.

                                            : void
    {
        $this->settings->set('active', (string) $a_value);
    }

References ILIAS\Repository\settings().

Here is the call graph for this function:

setComponents()

ilBadgeHandler::setComponents

(

?array

$a_components = null

)

Parameters

string[] | null

$a_components

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

                                                              : void
    {
        if (isset($a_components) && count($a_components) === 0) {
            $a_components = null;
        }
        $this->settings->set(
            'components',
            $a_components !== null
            ? serialize(array_unique($a_components))
            : ''
        );
    }

References ILIAS\Repository\settings().

Here is the call graph for this function:

setInactiveTypes()

ilBadgeHandler::setInactiveTypes

(

?array

$a_types = null

)

Parameters

string[] | null

$a_types

Definition at line 197 of file class.ilBadgeHandler.php.

                                                            : void
    {
        if (is_array($a_types) &&
            !count($a_types)) {
            $a_types = null;
        }
        $this->settings->set(
            'inactive_types',
            $a_types !== null
            ? serialize(array_unique($a_types))
            : ''
        );
    }

References ILIAS\Repository\settings().

Here is the call graph for this function:

triggerEvaluation()

ilBadgeHandler::triggerEvaluation	(	string	$a_type_id,
		int	$a_user_id,
		?array	$a_params = null
	)

Definition at line 342 of file class.ilBadgeHandler.php.

     : void {
        if (!$this->isActive() || in_array($a_type_id, $this->getInactiveTypes(), true)) {
            return;
        }
 
        $type = $this->getTypeInstanceByUniqueId($a_type_id);
        if (!$type instanceof ilBadgeAuto) {
            return;
        }
 
        $new_badges = [];
        foreach (ilBadge::getInstancesByType($a_type_id) as $badge) {
            if ($badge->isActive()) {
                // already assigned?
                if (!ilBadgeAssignment::exists($badge->getId(), $a_user_id)) {
                    if ($type->evaluate($a_user_id, (array) $a_params, $badge->getConfiguration())) {
                        $ass = new ilBadgeAssignment($badge->getId(), $a_user_id);
                        $ass->store();
 
                        $new_badges[$a_user_id][] = $badge->getId();
                    }
                }
            }
        }
 
        $this->sendNotification($new_badges);
    }

updateFromXML()

static ilBadgeHandler::updateFromXML ( string  $a_component_id )

static

Import component definition.

Definition at line 291 of file class.ilBadgeHandler.php.

                                                                : void
    {
        $handler = self::getInstance();
        $components = $handler->getComponents();
        $components[] = $a_component_id;
        $handler->setComponents($components);
    }

References $components, and $handler.

Referenced by ilBadgeDefinitionProcessor\beginTag().

Here is the caller graph for this function:

Field Documentation

$component_repository

ilComponentRepository ilBadgeHandler::$component_repository

protected

Definition at line 33 of file class.ilBadgeHandler.php.

$db

ilDBInterface ilBadgeHandler::$db

protected

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

$instance

ilBadgeHandler ilBadgeHandler::$instance = null

staticprotected

Definition at line 38 of file class.ilBadgeHandler.php.

Referenced by getInstance().

$lng

ilLanguage ilBadgeHandler::$lng

protected

Definition at line 36 of file class.ilBadgeHandler.php.

$settings

ilSetting ilBadgeHandler::$settings

protected

Definition at line 37 of file class.ilBadgeHandler.php.

$tree

ilTree ilBadgeHandler::$tree

protected

Definition at line 35 of file class.ilBadgeHandler.php.

GENERAL_INFO

const ilBadgeHandler::GENERAL_INFO = 'inform_about_badges'

Definition at line 31 of file class.ilBadgeHandler.php.

---

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

• components/ILIAS/Badge/classes/class.ilBadgeHandler.php