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

Collaboration diagram for ilObjSessionAccess:

Public Member Functions
	__construct ()
	_checkAccess ($a_cmd, $a_permission, $a_ref_id, $a_obj_id, $a_user_id="")
	isRegistrationLimitExceeded (int $ref_id, int $obj_id)
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	_getCommands ()
static	_checkGoto ($a_target)
static	_lookupRegistration (int $a_obj_id)
static	_lookupRegistered (int $a_usr_id, int $a_obj_id)
static	_preloadData ($a_obj_ids, $a_ref_ids)
static	getBookingInfoRepo ()
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 Attributes
ilObjUser	$user

Static Protected Attributes
static array	$registrations = null
static array	$registered = null
static ILIAS BookingManager Reservations ReservationDBRepository	$booking_repo = null

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

Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

\

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

Constructor & Destructor Documentation

__construct()

ilObjSessionAccess::__construct

(

)

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

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

    {
        global $DIC;

        $this->user = $DIC->user();
    }

Here is the call graph for this function:

Member Function Documentation

_checkAccess()

ilObjSessionAccess::_checkAccess	(		$a_cmd,
			$a_permission,
			$a_ref_id,
			$a_obj_id,
			$a_user_id = ""
	)

Definition at line 57 of file class.ilObjSessionAccess.php.

References $DIC, $user, ilWaitingList\_isOnList(), ilParticipants\_isSubscriber(), ANONYMOUS_USER_ID, ilObject\getId(), and isRegistrationLimitExceeded().

                                                                                              : bool
    {
        global $DIC;

        $ilUser = $this->user;

        if (!$a_user_id) {
            $a_user_id = $ilUser->getId();
        }

        switch ($a_cmd) {
            case 'register':

                if (!self::_lookupRegistration($a_obj_id)) {
                    return false;
                }
                if ($ilUser->isAnonymous()) {
                    return false;
                }
                if (self::_lookupRegistered($a_user_id, $a_obj_id)) {
                    return false;
                }
                if (\ilSessionParticipants::_isSubscriber($a_obj_id, $a_user_id)) {
                    return false;
                }
                if (ilSessionWaitingList::_isOnList($a_user_id, $a_obj_id)) {
                    return false;
                }
                if ($this->isRegistrationLimitExceeded($a_ref_id, $a_obj_id)) {
                    return false;
                }
                break;

            case 'unregister':
                if (self::_lookupRegistration($a_obj_id) && $a_user_id != ANONYMOUS_USER_ID) {
                    return self::_lookupRegistered($a_user_id, $a_obj_id);
                }
                return false;
        }
        return true;
    }

Here is the call graph for this function:

_checkGoto()

static ilObjSessionAccess::_checkGoto (   $a_target )

static

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

References $DIC.

                                                : bool
    {
        global $DIC;

        $ilAccess = $DIC->access();

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

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

        if ($ilAccess->checkAccess("read", "", (int) $t_arr[1]) ||
            $ilAccess->checkAccess("visible", "", (int) $t_arr[1])) {
            return true;
        }
        return false;
    }

_getCommands()

static ilObjSessionAccess::_getCommands ( )

static

Definition at line 43 of file class.ilObjSessionAccess.php.

Referenced by ilObjSessionListGUI\init().

                                         : array
    {
        $commands = array(
            array("permission" => "read", "cmd" => "infoScreen", "lang_var" => "info_short", "default" => true),
            array("permission" => "read", "cmd" => "register", "lang_var" => "join_session"),
            array("permission" => "read", "cmd" => "unregister", "lang_var" => "event_unregister"),
            array("permission" => "write", "cmd" => "edit", "lang_var" => "settings"),
            array("permission" => "manage_materials", "cmd" => "materials", "lang_var" => "crs_objective_add_mat"),
            array('permission' => 'manage_members', 'cmd' => 'members', 'lang_var' => 'event_edit_members')
        );

        return $commands;
    }

Here is the caller graph for this function:

_lookupRegistered()

static ilObjSessionAccess::_lookupRegistered ( int  $a_usr_id, int  $a_obj_id  )

static

Definition at line 149 of file class.ilObjSessionAccess.php.

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

                                                                          : bool
    {
        global $DIC;

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

        if (isset(self::$registered[$a_usr_id][$a_obj_id])) {
            return (bool) self::$registered[$a_usr_id][$a_obj_id];
        }

        $query = "SELECT event_id, registered FROM event_participants WHERE usr_id = " . $ilDB->quote($ilUser->getId(), 'integer');
        $res = $ilDB->query($query);
        self::$registered[$a_usr_id] = [];
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            self::$registered[$a_usr_id][$row->event_id] = (bool) $row->registered;
        }
        return (bool) (self::$registered[$a_usr_id][$a_obj_id] ?? false);
    }

_lookupRegistration()

static ilObjSessionAccess::_lookupRegistration ( int  $a_obj_id )

static

Definition at line 131 of file class.ilObjSessionAccess.php.

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

                                                             : bool
    {
        global $DIC;

        $ilDB = $DIC->database();

        if (!is_null(self::$registrations)) {
            return (bool) self::$registrations[$a_obj_id];
        }

        $query = "SELECT registration,obj_id FROM event ";
        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            self::$registrations[$row->obj_id] = (bool) $row->registration;
        }
        return (bool) self::$registrations[$a_obj_id];
    }

_preloadData()

static ilObjSessionAccess::_preloadData (   $a_obj_ids,   $a_ref_ids  )

static

Definition at line 169 of file class.ilObjSessionAccess.php.

References $DIC.

                                                               : void
    {
        global $DIC;

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

getBookingInfoRepo()

static ilObjSessionAccess::getBookingInfoRepo ( )

static

Definition at line 179 of file class.ilObjSessionAccess.php.

Referenced by ilObjSessionListGUI\getProperties().

                                                : ?\ILIAS\BookingManager\Reservations\ReservationDBRepository
    {
        if (self::$booking_repo instanceof \ILIAS\BookingManager\Reservations\ReservationDBRepository) {
            return self::$booking_repo;
        }
        return null;
    }

Here is the caller graph for this function:

isRegistrationLimitExceeded()

ilObjSessionAccess::isRegistrationLimitExceeded	(	int	$ref_id,
		int	$obj_id
	)

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

References ilSessionParticipants\getInstance().

Referenced by _checkAccess().

                                                                         : bool
    {
        $session_data = new ilObjSession($obj_id, false);
        if (!$session_data->isRegistrationUserLimitEnabled()) {
            return false;
        }
        $part = ilSessionParticipants::getInstance($ref_id);
        if ($part->getCountMembers() >= $session_data->getRegistrationMaxUsers()) {
            return true;
        }
        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$booking_repo

ILIAS BookingManager Reservations ReservationDBRepository ilObjSessionAccess::$booking_repo = null

staticprotected

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

$registered

array ilObjSessionAccess::$registered = null

staticprotected

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

$registrations

array ilObjSessionAccess::$registrations = null

staticprotected

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

$user

ilObjUser ilObjSessionAccess::$user

protected

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

Referenced by _checkAccess().

---

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

• components/ILIAS/Session/classes/class.ilObjSessionAccess.php