ilObjCourseAccess Class Reference

Class ilObjCourseAccess. More...

Inheritance diagram for ilObjCourseAccess:

Collaboration diagram for ilObjCourseAccess:

Public Member Functions
	__construct ()
	_checkAccess (string $cmd, string $permission, int $ref_id, int $obj_id, ?int $user_id=null)
Public Member Functions inherited from ilObjectAccess
	_checkAccess (string $cmd, string $permission, int $ref_id, int $obj_id, ?int $user_id=null)
	Checks whether a user may invoke a command or not (this method is called by ilAccessHandler::checkAccess) More...
	canBeDelivered (ilWACPath $ilWACPath)

Static Public Member Functions
static	getConditionOperators ()
	Get operators. More...
static	checkCondition (int $a_trigger_obj_id, string $a_operator, string $a_value, int $a_usr_id)
static	_getCommands ()
static	_checkGoto (string $target)
static	_lookupViewMode (int $a_id)
static	_isActivated (int $a_obj_id, ?bool &$a_visible_flag=null, bool $a_mind_member_view=true)
static	_registrationEnabled (int $a_obj_id)
static	lookupRegistrationInfo (int $a_obj_id)
static	_isOffline (int $obj_id)
static	_preloadData (array $obj_ids, array $ref_ids)
	Preload data. More...
static	getBookingInfoRepo ()
static	_usingRegistrationCode ()
static	lookupPeriodInfo (int $a_obj_id)
Static Public Member Functions inherited from ilObjectAccess
static	_getCommands ()
	get commands More...
static	_checkGoto (string $target)
	check whether goto script will succeed More...
static	_isOffline (int $obj_id)
	Type-specific implementation of general status, has to be overwritten if object type does not support centralized offline handling. More...
static	_preloadData (array $obj_ids, array $ref_ids)
	Preload data. More...

Protected Member Functions
	isObjectiveResultRangeAchieved (int $user_id, int $trigger_obj_id, string $a_value)

Protected Attributes
ilAccessHandler	$access
ilObjUser	$user
ilLanguage	$lng
ilRbacSystem	$rbacSystem

Static Protected Attributes
static bool	$using_code = false
static ILIAS BookingManager Reservations ReservationDBRepository	$booking_repo = null

Detailed Description

Class ilObjCourseAccess.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

Definition at line 26 of file class.ilObjCourseAccess.php.

Constructor & Destructor Documentation

__construct()

ilObjCourseAccess::__construct

(

)

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

References $DIC, ILIAS\Repository\access(), ILIAS\Repository\lng(), and ILIAS\Repository\user().

    {
        global $DIC;

        $this->access = $DIC->access();
        $this->user = $DIC->user();
        $this->lng = $DIC->language();
        $this->rbacSystem = $DIC->rbac()->system();
    }

Here is the call graph for this function:

Member Function Documentation

_checkAccess()

ilObjCourseAccess::_checkAccess	(	string	$cmd,
		string	$permission,
		int	$ref_id,
		int	$obj_id,
		?int	$user_id = null
	)

Definition at line 103 of file class.ilObjCourseAccess.php.

References $user_id, ilCourseParticipants\_getInstanceByObjId(), ilCourseParticipant\_getInstanceByObjId(), ilWaitingList\_isOnList(), ILIAS\Repository\access(), ilDatePresentation\formatDate(), ilAccessInfo\IL_NO_OBJECT_ACCESS, ilAccessInfo\IL_STATUS_INFO, ILIAS\Repository\lng(), ilObjCourse\mayLeave(), null, and ILIAS\Repository\user().

                                                                                                                 : bool
    {
        if (is_null($user_id)) {
            $user_id = $this->user->getId();
        }
        if ($this->user->getId() === $user_id) {
            $participants = ilCourseParticipant::_getInstanceByObjId($obj_id, $user_id);
        } else {
            $participants = ilCourseParticipants::_getInstanceByObjId($obj_id);
        }

        switch ($cmd) {
            case "view":
                if ($participants->isBlocked($user_id) && $participants->isAssigned($user_id)) {
                    $this->access->addInfoItem(
                        ilAccessInfo::IL_NO_OBJECT_ACCESS,
                        $this->lng->txt("crs_status_blocked")
                    );
                    return false;
                }
                break;

            case 'leave':
                // Regular member
                if ($permission == 'leave') {
                    $limit = null;
                    if (!ilObjCourse::mayLeave($obj_id, $user_id, $limit)) {
                        $this->access->addInfoItem(
                            ilAccessInfo::IL_STATUS_INFO,
                            sprintf(
                                $this->lng->txt("crs_cancellation_end_rbac_info"),
                                ilDatePresentation::formatDate($limit)
                            )
                        );
                        return false;
                    }

                    if (!$participants->isAssigned($user_id)) {
                        return false;
                    }
                }
                break;

            case 'leaveWaitList':
                // Waiting list
                if ($permission == 'join') {
                    if (!ilCourseWaitingList::_isOnList($user_id, $obj_id)) {
                        return false;
                    }
                    return true;
                }
                break;

            case 'join':

                if (ilCourseWaitingList::_isOnList($user_id, $obj_id)) {
                    return false;
                }
                break;
        }

        switch ($permission) {
            case 'visible':
                $visible = null;
                $active = self::_isActivated($obj_id, $visible);
                $tutor = $this->rbacSystem->checkAccessOfUser($user_id, 'write', $ref_id);
                if (!$active) {
                    $this->access->addInfoItem(ilAccessInfo::IL_NO_OBJECT_ACCESS, $this->lng->txt("offline"));
                }
                if (!$tutor && !$active && !$visible) {
                    return false;
                }
                break;

            case 'read':
                $tutor = $this->rbacSystem->checkAccessOfUser($user_id, 'write', $ref_id);
                if ($tutor) {
                    return true;
                }
                $active = self::_isActivated($obj_id);
                if (!$active) {
                    $this->access->addInfoItem(ilAccessInfo::IL_NO_OBJECT_ACCESS, $this->lng->txt("offline"));
                    return false;
                }
                if ($participants->isBlocked($user_id) && $participants->isAssigned($user_id)) {
                    $this->access->addInfoItem(
                        ilAccessInfo::IL_NO_OBJECT_ACCESS,
                        $this->lng->txt("crs_status_blocked")
                    );
                    return false;
                }
                break;

            case 'join':
                if (!self::_registrationEnabled($obj_id)) {
                    return false;
                }

                if ($participants->isAssigned($user_id)) {
                    return false;
                }
                break;

            case 'leave':
                return ilObjCourse::mayLeave($obj_id, $user_id);
        }
        return true;
    }

Here is the call graph for this function:

_checkGoto()

static ilObjCourseAccess::_checkGoto ( string  $target )

static

Definition at line 244 of file class.ilObjCourseAccess.php.

References $DIC, and ANONYMOUS_USER_ID.

                                                     : bool
    {
        global $DIC;

        $ilAccess = $DIC['ilAccess'];
        $ilUser = $DIC['ilUser'];

        $t_arr = explode("_", $target);

        // registration codes
        if (isset($t_arr[2]) && substr($t_arr[2], 0, 5) == 'rcode' && $ilUser->getId() != ANONYMOUS_USER_ID) {
            self::$using_code = true;
            return true;
        }

        if ($t_arr[0] != "crs" || ((int) $t_arr[1]) <= 0) {
            return false;
        }

        // checking for read results in endless loop, if read is given
        // but visible is not given (-> see bug 5323)
        if ($ilAccess->checkAccess("read", "", $t_arr[1]) ||
            $ilAccess->checkAccess("visible", "", $t_arr[1])) {
            //if ($ilAccess->checkAccess("visible", "", $t_arr[1]))
            return true;
        }
        return false;
    }

_getCommands()

static ilObjCourseAccess::_getCommands ( )

static

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

References ilDAVActivationChecker\_isActive().

Referenced by ilObjCourseReferenceAccess\_getCommands(), and ilObjCourseListGUI\init().

                                         : array
    {
        $commands = array();
        $commands[] = array("permission" => "crs_linked", "cmd" => "", "lang_var" => "view", "default" => true);

        $commands[] = array("permission" => "join", "cmd" => "join", "lang_var" => "join");

        // on waiting list
        $commands[] = array('permission' => "join", "cmd" => "leaveWaitList", "lang_var" => "leave_waiting_list");

        // regualar users
        $commands[] = array('permission' => "leave", "cmd" => "leave", "lang_var" => "crs_unsubscribe");

        if (ilDAVActivationChecker::_isActive()) {
            $webdav_obj = new ilObjWebDAV();
            $commands[] = $webdav_obj->retrieveWebDAVCommandArrayForActionMenu();
        }

        $commands[] = array("permission" => "write",
                            "cmd" => "enableAdministrationPanel",
                            "lang_var" => "edit_content"
        );
        $commands[] = array("permission" => "write", "cmd" => "edit", "lang_var" => "settings");
        return $commands;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_isActivated()

static ilObjCourseAccess::_isActivated ( int  $a_obj_id, ?bool &  $a_visible_flag = null, bool  $a_mind_member_view = true  )

static

Definition at line 287 of file class.ilObjCourseAccess.php.

References $ref_id, ilObject\_getAllReferences(), ilMemberViewSettings\getInstance(), ilObjectActivation\getItem(), and ilObjectActivation\TIMINGS_ACTIVATION.

Referenced by ilObjCourse\_isActivated(), ilPortfolioPageGUI\getCoursesOfUser(), and ilObjCourse\register().

                                                                                                                      : bool
    {
        // #7669
        if ($a_mind_member_view) {
            if (ilMemberViewSettings::getInstance()->isActive()) {
                $a_visible_flag = true;
                return true;
            }
        }
        $ref_id = ilObject::_getAllReferences($a_obj_id);
        $ref_id = array_pop($ref_id);
        $a_visible_flag = true;

        $item = ilObjectActivation::getItem($ref_id);
        switch ($item['timing_type']) {
            case ilObjectActivation::TIMINGS_ACTIVATION:
                if (time() < $item['timing_start'] || time() > $item['timing_end']) {
                    $a_visible_flag = $item['visible'];
                    return false;
                }
                // fallthrough

                // no break
            default:
                return true;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_isOffline()

static ilObjCourseAccess::_isOffline ( int  $obj_id )

static

Definition at line 417 of file class.ilObjCourseAccess.php.

References null.

Referenced by ilObjCourse\register().

                                                  : bool
    {
        $dummy = null;
        return !self::_isActivated($obj_id, $dummy, false);
    }

Here is the caller graph for this function:

_lookupViewMode()

static ilObjCourseAccess::_lookupViewMode ( int  $a_id )

static

Definition at line 273 of file class.ilObjCourseAccess.php.

References $DIC, $ilDB, $res, ilDBConstants\FETCHMODE_OBJECT, and ilContainer\VIEW_DEFAULT.

Referenced by ilObjFolder\getViewMode(), ilObjGroup\getViewMode(), and ilObjGroupGUI\initForm().

                                                     : int
    {
        global $DIC;

        $ilDB = $DIC->database();

        $query = "SELECT view_mode FROM crs_settings WHERE obj_id = " . $ilDB->quote($a_id, 'integer') . " ";
        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            return $row->view_mode;
        }
        return ilContainer::VIEW_DEFAULT;
    }

Here is the caller graph for this function:

_preloadData()

static ilObjCourseAccess::_preloadData ( array  $obj_ids, array  $ref_ids  )

static

Preload data.

Definition at line 426 of file class.ilObjCourseAccess.php.

References $DIC, ilWaitingList\_preloadOnListInfo(), and ilLanguage\loadLanguageModule().

                                                                       : void
    {
        global $DIC;

        $ilUser = $DIC['ilUser'];
        $lng = $DIC['lng'];

        $lng->loadLanguageModule("crs");

        ilCourseWaitingList::_preloadOnListInfo([$ilUser->getId()], $obj_ids);

        $repository = new ilUserCertificateRepository();
        $coursePreload = new ilCertificateObjectsForUserPreloader($repository);
        $coursePreload->preLoad($ilUser->getId(), $obj_ids);

        self::$booking_repo = $DIC->bookingManager()->internal()->repo()->reservationWithContextObjCache($obj_ids);
    }

Here is the call graph for this function:

_registrationEnabled()

static ilObjCourseAccess::_registrationEnabled ( int  $a_obj_id )

static

Definition at line 315 of file class.ilObjCourseAccess.php.

References $DIC, $ilDB, $res, ilDBConstants\FETCHMODE_OBJECT, ilCourseConstants\IL_CRS_SUBSCRIPTION_DEACTIVATED, ilCourseConstants\IL_CRS_SUBSCRIPTION_LIMITED, ilCourseConstants\IL_CRS_SUBSCRIPTION_UNLIMITED, and null.

Referenced by ilObjCourse\_registrationEnabled().

                                                              : bool
    {
        global $DIC;

        $ilDB = $DIC->database();
        $type = null;

        $query = "SELECT * FROM crs_settings " .
            "WHERE obj_id = " . $ilDB->quote($a_obj_id, 'integer') . " ";

        $reg_start = $reg_end = 0;
        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $type = $row->sub_limitation_type;
            $reg_start = $row->sub_start;
            $reg_end = $row->sub_end;
        }

        switch ($type) {
            case ilCourseConstants::IL_CRS_SUBSCRIPTION_UNLIMITED:
                return true;

            case ilCourseConstants::IL_CRS_SUBSCRIPTION_DEACTIVATED:
                return false;

            case ilCourseConstants::IL_CRS_SUBSCRIPTION_LIMITED:
                if (time() > $reg_start && time() < $reg_end) {
                    return true;
                }
                // no break
            default:
                return false;
        }
    }

Here is the caller graph for this function:

_usingRegistrationCode()

static ilObjCourseAccess::_usingRegistrationCode ( )

static

Definition at line 449 of file class.ilObjCourseAccess.php.

Referenced by ilObjCourse\register().

                                                   : bool
    {
        return self::$using_code;
    }

Here is the caller graph for this function:

checkCondition()

static ilObjCourseAccess::checkCondition ( int  $a_trigger_obj_id, string  $a_operator, string  $a_value, int  $a_usr_id  )

static

Implements ilConditionHandling.

Definition at line 61 of file class.ilObjCourseAccess.php.

References ilParticipants\_hasPassed(), ilConditionHandler\OPERATOR_PASSED, and ilConditionHandler\OPERATOR_RESULT_RANGE_PERCENTAGE.

     : bool {
        switch ($a_operator) {
            case ilConditionHandler::OPERATOR_PASSED:
                return ilCourseParticipants::_hasPassed($a_trigger_obj_id, $a_usr_id);

            case ilConditionHandler::OPERATOR_RESULT_RANGE_PERCENTAGE:
                $self = new self();
                return $self->isObjectiveResultRangeAchieved($a_usr_id, $a_trigger_obj_id, $a_value);
        }
        return false;
    }

Here is the call graph for this function:

getBookingInfoRepo()

static ilObjCourseAccess::getBookingInfoRepo ( )

static

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

Referenced by ilObjCourseListGUI\getProperties().

                                               : ?\ILIAS\BookingManager\Reservations\ReservationDBRepository
    {
        return self::$booking_repo;
    }

Here is the caller graph for this function:

getConditionOperators()

static ilObjCourseAccess::getConditionOperators ( )

static

Get operators.

Returns

string[]

Implements ilConditionHandling.

Definition at line 50 of file class.ilObjCourseAccess.php.

References ilConditionHandler\OPERATOR_PASSED, and ilConditionHandler\OPERATOR_RESULT_RANGE_PERCENTAGE.

                                                  : array
    {
        return array(
            ilConditionHandler::OPERATOR_PASSED,
            ilConditionHandler::OPERATOR_RESULT_RANGE_PERCENTAGE
        );
    }

isObjectiveResultRangeAchieved()

ilObjCourseAccess::isObjectiveResultRangeAchieved ( int  $user_id, int  $trigger_obj_id, string  $a_value  )

protected

Definition at line 78 of file class.ilObjCourseAccess.php.

References ilLOUserResults\lookupResult(), and ilLOSettings\TYPE_TEST_QUALIFIED.

                                                                                                         : bool
    {
        $value_arr = unserialize($a_value);
        if ($value_arr === false) {
            return false;
        }
        $min_percentage = $value_arr['min_percentage'] ?? 0;
        $max_percentage = $value_arr['max_percentage'] ?? 0;
        $objective = $value_arr['objective'] ?? 0;

        $user_result = ilLOUserResults::lookupResult(
            $trigger_obj_id,
            $user_id,
            $objective,
            ilLOSettings::TYPE_TEST_QUALIFIED
        );
        $result_percentage = $user_result['result_perc'] ?? 0;
        return
            ($result_percentage >= $min_percentage) &&
            ($result_percentage <= $max_percentage);
    }

Here is the call graph for this function:

lookupPeriodInfo()

static ilObjCourseAccess::lookupPeriodInfo ( int  $a_obj_id )

static

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

References $DIC, $ilDB, $res, ilDBConstants\FETCHMODE_OBJECT, ilDatePresentation\formatPeriod(), IL_CAL_DATETIME, ilLanguage\loadLanguageModule(), null, ilDBConstants\T_INTEGER, ilLanguage\txt(), and ilTimeZone\UTC.

Referenced by ilCourseMailTemplateMemberContext\getCachedPeriodByObjId(), ilCourseMailTemplateTutorContext\getCachedPeriodByObjId(), and ilObjCourseListGUI\getProperties().

                                                          : array
    {
        global $DIC;

        $ilDB = $DIC->database();
        $lng = $DIC->language();

        $start = $end = null;
        $query = 'SELECT period_start, period_end, period_time_indication FROM crs_settings ' .
            'WHERE obj_id = ' . $ilDB->quote($a_obj_id, ilDBConstants::T_INTEGER);

        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(\ilDBConstants::FETCHMODE_OBJECT)) {
            if (!$row->period_time_indication) {
                $start = ($row->period_start
                    ? new \ilDate($row->period_start, IL_CAL_DATETIME)
                    : null);
                $end = ($row->period_end
                    ? new \ilDate($row->period_end, IL_CAL_DATETIME)
                    : null);
            } else {
                $start = ($row->period_start
                    ? new \ilDateTime($row->period_start, IL_CAL_DATETIME, \ilTimeZone::UTC)
                    : null);
                $end = ($row->period_end
                    ? new \ilDateTime($row->period_end, IL_CAL_DATETIME, \ilTimeZone::UTC)
                    : null);
            }
        }
        if ($start && $end) {
            $lng->loadLanguageModule('crs');

            return
                [
                    'crs_start' => $start,
                    'crs_end' => $end,
                    'property' => $lng->txt('crs_period'),
                    'value' => ilDatePresentation::formatPeriod($start, $end)
                ];
        }
        return [];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

lookupRegistrationInfo()

static ilObjCourseAccess::lookupRegistrationInfo ( int  $a_obj_id )

static

Definition at line 350 of file class.ilObjCourseAccess.php.

References $DIC, $ilDB, $res, ilDateTime\_before(), ilCourseParticipant\_getInstanceByObjId(), ilDBConstants\FETCHMODE_OBJECT, ilDatePresentation\formatDate(), IL_CAL_UNIX, ILIAS\Repository\int(), ilWaitingList\lookupListSize(), ilCourseConstants\SUBSCRIPTION_LIMITED, ilCourseConstants\SUBSCRIPTION_UNLIMITED, ilDBConstants\T_INTEGER, and ilLanguage\txt().

Referenced by ilCourseRegistrationGUI\fillMaxMembers(), ilObjCourseListGUI\getProperties(), and ilObjCourseGUI\infoScreen().

                                                                : array
    {
        global $DIC;

        $ilDB = $DIC->database();
        $ilUser = $DIC->user();
        $lng = $DIC->language();

        $query = 'SELECT sub_limitation_type, sub_start, sub_end, sub_mem_limit, sub_max_members FROM crs_settings ' .
            'WHERE obj_id = ' . $ilDB->quote($a_obj_id, ilDBConstants::T_INTEGER);
        $res = $ilDB->query($query);

        $info = array();
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $info['reg_info_start'] = new ilDateTime($row->sub_start, IL_CAL_UNIX);
            $info['reg_info_end'] = new ilDateTime($row->sub_end, IL_CAL_UNIX);
            $info['reg_info_type'] = (int) $row->sub_limitation_type;
            $info['reg_info_max_members'] = (int) $row->sub_max_members;
            $info['reg_info_mem_limit'] = (int) $row->sub_mem_limit;
        }

        $registration_possible = true;

        // Limited registration
        if (($info['reg_info_type'] ?? 0) == ilCourseConstants::SUBSCRIPTION_LIMITED) {
            $dt = new ilDateTime(time(), IL_CAL_UNIX);
            if (ilDateTime::_before($dt, $info['reg_info_start'])) {
                $info['reg_info_list_prop']['property'] = $lng->txt('crs_list_reg_start');
                $info['reg_info_list_prop']['value'] = ilDatePresentation::formatDate($info['reg_info_start']);
            } elseif (ilDateTime::_before($dt, $info['reg_info_end'])) {
                $info['reg_info_list_prop']['property'] = $lng->txt('crs_list_reg_end');
                $info['reg_info_list_prop']['value'] = ilDatePresentation::formatDate($info['reg_info_end']);
            } else {
                $registration_possible = false;
                $info['reg_info_list_prop']['property'] = $lng->txt('crs_list_reg_period');
                $info['reg_info_list_prop']['value'] = $lng->txt('crs_list_reg_noreg');
            }
        } elseif (($info['reg_info_type'] ?? 0) == ilCourseConstants::SUBSCRIPTION_UNLIMITED) {
            $registration_possible = true;
        } else {
            $registration_possible = false;
            $info['reg_info_list_prop']['property'] = $lng->txt('crs_list_reg');
            $info['reg_info_list_prop']['value'] = $lng->txt('crs_list_reg_noreg');
        }

        if (($info['reg_info_mem_limit'] ?? false) && $info['reg_info_max_members'] && $registration_possible) {
            // Check for free places
            $part = ilCourseParticipant::_getInstanceByObjId($a_obj_id, $ilUser->getId());

            $info['reg_info_list_size'] = ilCourseWaitingList::lookupListSize($a_obj_id);
            if ($info['reg_info_list_size']) {
                $info['reg_info_free_places'] = 0;
            } else {
                $info['reg_info_free_places'] = max(0, $info['reg_info_max_members'] - $part->getNumberOfMembers());
            }

            if ($info['reg_info_free_places']) {
                $info['reg_info_list_prop_limit']['property'] = $lng->txt('crs_list_reg_limit_places');
                $info['reg_info_list_prop_limit']['value'] = $info['reg_info_free_places'];
            } else {
                $info['reg_info_list_prop_limit']['property'] = '';
                $info['reg_info_list_prop_limit']['value'] = $lng->txt('crs_list_reg_limit_full');
            }
        }
        return $info;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$access

ilAccessHandler ilObjCourseAccess::$access

protected

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

$booking_repo

ILIAS BookingManager Reservations ReservationDBRepository ilObjCourseAccess::$booking_repo = null

staticprotected

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

$lng

ilLanguage ilObjCourseAccess::$lng

protected

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

$rbacSystem

ilRbacSystem ilObjCourseAccess::$rbacSystem

protected

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

$user

ilObjUser ilObjCourseAccess::$user

protected

Definition at line 32 of file class.ilObjCourseAccess.php.

$using_code

bool ilObjCourseAccess::$using_code = false

staticprotected

Definition at line 28 of file class.ilObjCourseAccess.php.

---

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

• components/ILIAS/Course/classes/class.ilObjCourseAccess.php