class.ilLearningProgressAccess.php

Go to the documentation of this file.

<?php

declare(strict_types=0);
/*
    +-----------------------------------------------------------------------------+
    | ILIAS open source                                                           |
    +-----------------------------------------------------------------------------+
    | Copyright (c) 1998-2006 ILIAS open source, University of Cologne            |
    |                                                                             |
    | This program is free software; you can redistribute it and/or               |
    | modify it under the terms of the GNU General Public License                 |
    | as published by the Free Software Foundation; either version 2              |
    | of the License, or (at your option) any later version.                      |
    |                                                                             |
    | This program is distributed in the hope that it will be useful,             |
    | but WITHOUT ANY WARRANTY; without even the implied warranty of              |
    | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               |
    | GNU General Public License for more details.                                |
    |                                                                             |
    | You should have received a copy of the GNU General Public License           |
    | along with this program; if not, write to the Free Software                 |
    | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA. |
    +-----------------------------------------------------------------------------+
*/

class ilLearningProgressAccess
{
    public static function checkPermission(
        string $a_permission,
        int $a_ref_id,
        ?int $a_user_id = null
    ): bool {
        global $DIC;

        if ($a_user_id === null) {
            $a_user_id = $DIC->user()->getId();
        }

        // position access
        if ($a_permission === 'read_learning_progress') {
            return $DIC->access()->checkRbacOrPositionPermissionAccess(
                ilOrgUnitOperation::OP_READ_LEARNING_PROGRESS,
                ilOrgUnitOperation::OP_READ_LEARNING_PROGRESS,
                $a_ref_id
            );
        }
        return $DIC->access()->checkAccessOfUser(
            $a_user_id,
            $a_permission,
            '',
            $a_ref_id
        );
    }

    public static function checkAccess(
        int $a_ref_id,
        bool $a_allow_only_read = true
    ): bool {
        global $DIC;

        if ($DIC->user()->getId() == ANONYMOUS_USER_ID) {
            return false;
        }

        if (!ilObjUserTracking::_enabledLearningProgress()) {
            return false;
        }

        $olp = ilObjectLP::getInstance(ilObject::_lookupObjId($a_ref_id));
        if (
            $olp->isActive() && (
                $DIC->access()->checkAccess(
                    'read_learning_progress',
                    '',
                    $a_ref_id
                ) ||
                $DIC->access()->checkRbacOrPositionPermissionAccess(
                    ilOrgUnitOperation::OP_READ_LEARNING_PROGRESS,
                    ilOrgUnitOperation::OP_READ_LEARNING_PROGRESS,
                    $a_ref_id
                )
            )
        ) {
            return true;
        }

        if (!$DIC->access()->checkAccess('read', '', $a_ref_id)) {
            return false;
        }
        // edit learning progress is sufficient: #0029313
        if ($DIC->access()->checkAccess(
            'edit_learning_progress',
            '',
            $a_ref_id
        )) {
            return true;
        }

        if (!ilObjUserTracking::_hasLearningProgressLearner()) {
            return false;
        }

        if (!$olp->isActive()) {
            return false;
        }

        if ($a_allow_only_read) {
            return true;
        }
        return false;
    }
}