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

Collaboration diagram for ilBadgeWAC:

Public Member Functions
	canBeDelivered (ilWACPath $ilWACPath)

Private Member Functions
	hasAccessToBadgeParentIdNode (\ILIAS\DI\Container $DIC, int $badge_id, bool $has_global_badge_administration_access)
	isAssignedBadge (\ILIAS\DI\Container $DIC, int $badge_id)
	isAssignedBadgeOfPublishedUserProfile (\ILIAS\DI\Container $DIC, int $badge_id)

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

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 22 of file class.ilBadgeWAC.php.

Member Function Documentation

canBeDelivered()

ilBadgeWAC::canBeDelivered

(

ilWACPath

$ilWACPath

)

Implements ilWACCheckingClass.

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

References $DIC, ilObject\_getAllReferences(), ilObject\_getObjectsByType(), ilWACPath\getPath(), hasAccessToBadgeParentIdNode(), ILIAS\Repository\int(), isAssignedBadge(), and isAssignedBadgeOfPublishedUserProfile().

                                                        : bool
    {
        global $DIC;

        if (strpos($ilWACPath->getPath(), '..') !== false) {
            return false;
        }

        if (!preg_match('@ilBadge\/(\d+\/)*?badge(tmpl)?_(\d+)\/@ui', $ilWACPath->getPath())) {
            return false;
        }

        $obj_id = array_keys(ilObject::_getObjectsByType('bdga'))[0] ?? null;
        $admin_ref_id = null;
        if ($obj_id > 0) {
            $admin_ref_id = array_values(ilObject::_getAllReferences($obj_id))[0] ?? null;
        }

        $has_global_badge_administration_access = (
            $admin_ref_id > 0 &&
            $DIC->rbac()->system()->checkAccessOfUser($DIC->user()->getId(), 'read', $admin_ref_id)
        );

        if (preg_match('@\/badgetmpl_(\d+)\/@ui', $ilWACPath->getPath())) {
            // Badge template images must only be accessible for accounts with `read` permission on the badge administration node
            return $has_global_badge_administration_access;
        }

        if (preg_match('@\/badge_(\d+)\/@ui', $ilWACPath->getPath(), $matches)) {
            if ($has_global_badge_administration_access) {
                return true;
            }

            $badge_id = (int) $matches[1];

            return (
                $this->isAssignedBadge($DIC, $badge_id) ||
                $this->isAssignedBadgeOfPublishedUserProfile($DIC, $badge_id) ||
                $this->hasAccessToBadgeParentIdNode($DIC, $badge_id, $has_global_badge_administration_access)
            );
        }

        return false;
    }

Here is the call graph for this function:

hasAccessToBadgeParentIdNode()

ilBadgeWAC::hasAccessToBadgeParentIdNode ( \ILIAS\DI\Container  $DIC, int  $badge_id, bool  $has_global_badge_administration_access  )

private

Definition at line 69 of file class.ilBadgeWAC.php.

References ilObject\_getAllReferences(), ilBadgeHandler\getInstance(), ILIAS\Repository\int(), and SYSTEM_FOLDER_ID.

Referenced by canBeDelivered().

      : bool {
        // If the acting user still does not have access, check if the image is used in an object badge type
        $badge = new ilBadge($badge_id);
        if ($badge->getParentId() > 0) {
            return false;
        }

        $badge_handler = ilBadgeHandler::getInstance();
        if (!$badge_handler->isObjectActive((int) $badge->getParentId())) {
            return false;
        }

        $context_ref_id = array_values(ilObject::_getAllReferences((int) $badge->getParentId()))[0] ?? null;
        if (!($context_ref_id > 0)) {
            return false;
        }

        $context_ref_id = (int) $context_ref_id;
        if ($DIC->repositoryTree()->isGrandChild((int) SYSTEM_FOLDER_ID, $context_ref_id)) {
            $has_access = $has_global_badge_administration_access;
        } else {
            $has_access = $DIC->access()->checkAccessOfUser(
                $DIC->user()->getId(),
                'write',
                '',
                $context_ref_id
            );
        }

        return $has_access;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isAssignedBadge()

ilBadgeWAC::isAssignedBadge ( \ILIAS\DI\Container  $DIC, int  $badge_id  )

private

Definition at line 105 of file class.ilBadgeWAC.php.

References ilBadgeAssignment\getInstancesByUserId().

Referenced by canBeDelivered().

                                                                              : bool
    {
        // First, check all badge assignments of the current user for a match
        $badges_of_user = ilBadgeAssignment::getInstancesByUserId($DIC->user()->getId());
        foreach ($badges_of_user as $user_badge) {
            if ((int) $user_badge->getBadgeId() === $badge_id) {
                return true;
            }
        }

        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isAssignedBadgeOfPublishedUserProfile()

ilBadgeWAC::isAssignedBadgeOfPublishedUserProfile ( \ILIAS\DI\Container  $DIC, int  $badge_id  )

private

Definition at line 118 of file class.ilBadgeWAC.php.

References ilObjectFactory\getInstanceByObjId(), and ilBadgeAssignment\getInstancesByBadgeId().

Referenced by canBeDelivered().

                                                                                                    : bool
    {
        // It seems the badge is not  assigned to the curent user, so check if the profile of the badge user is made visible
        $assignments = ilBadgeAssignment::getInstancesByBadgeId($badge_id);
        foreach ($assignments as $assignment) {
            if (!$assignment->getPosition()) {
                continue;
            }

            $user = ilObjectFactory::getInstanceByObjId((int) $assignment->getUserId(), false);
            if (!$user instanceof ilObjUser) {
                continue;
            }

            $profile_visibility = $user->getPref('public_profile');
            if ($profile_visibility === 'g' || ($profile_visibility === 'y' && !$DIC->user()->isAnonymous())) {
                return true;
            }
        }

        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• Services/Badge/classes/class.ilBadgeWAC.php