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

Collaboration diagram for ilObjGroupAccess:

Public Member Functions
	_checkAccess (string $cmd, string $permission, int $ref_id, int $obj_id, ?int $user_id=null)
	@inheritDoc More...
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)
	canBeDelivered (ilWACPath $ilWACPath)

Static Public Member Functions
static	_getCommands ()
	@inheritDoc More...
static	_checkGoto (string $target)
	@inheritDoc More...
static	_registrationEnabled (int $a_obj_id)
static	_preloadData (array $obj_ids, array $ref_ids)
	@inheritDoc More...
static	lookupRegistrationInfo (int $a_obj_id)
static	lookupPeriodInfo (int $a_obj_id)
static	_usingRegistrationCode ()
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...

Static Protected Attributes
static bool	$using_code = false

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 Class ilObjGroupAccess

Author

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

Version

$Id$

Definition at line 30 of file class.ilObjGroupAccess.php.

Member Function Documentation

_checkAccess()

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

@inheritDoc

Reimplemented from ilObjectAccess.

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

                                                                                                                 : bool
    {
        global $DIC;
 
        $ilUser = $DIC['ilUser'];
        $lng = $DIC['lng'];
        $ilAccess = $DIC['ilAccess'];
 
        if (is_null($user_id)) {
            $user_id = $ilUser->getId();
        }
 
        switch ($cmd) {
            case "info":
 
                if (ilGroupParticipants::_isParticipant($ref_id, $user_id)) {
                    $ilAccess->addInfoItem(ilAccessInfo::IL_STATUS_INFO, $lng->txt("info_is_member"));
                } else {
                    $ilAccess->addInfoItem(ilAccessInfo::IL_STATUS_INFO, $lng->txt("info_is_not_member"));
                }
                break;
 
            case "join":
 
                if (!self::_registrationEnabled($obj_id)) {
                    return false;
                }
 
                if (ilGroupWaitingList::_isOnList($ilUser->getId(), $obj_id)) {
                    return false;
                }
 
                if (ilGroupParticipants::_isParticipant($ref_id, $user_id)) {
                    return false;
                }
                break;
 
            case 'leave':
                // Regular member
                if ($permission == 'leave') {
                    $limit = null;
                    if (!ilObjGroup::mayLeave($obj_id, $user_id, $limit)) {
                        $ilAccess->addInfoItem(
                            ilAccessInfo::IL_STATUS_INFO,
                            sprintf($lng->txt("grp_cancellation_end_rbac_info"), ilDatePresentation::formatDate($limit))
                        );
                        return false;
                    }
 
                    if (!ilGroupParticipants::_isParticipant($ref_id, $user_id)) {
                        return false;
                    }
                }
                break;
 
            case 'leaveWaitList':
                // Waiting list
                if ($permission == 'join') {
                    if (!ilGroupWaitingList::_isOnList($ilUser->getId(), $obj_id)) {
                        return false;
                    }
                }
                break;
 
        }
 
        switch ($permission) {
            case 'leave':
                return ilObjGroup::mayLeave($obj_id, $user_id);
        }
        return true;
    }

References $DIC, $ilUser, $lng, $ref_id, ilWaitingList\_isOnList(), ilGroupParticipants\_isParticipant(), ilDatePresentation\formatDate(), ilAccessInfo\IL_STATUS_INFO, and ilObjGroup\mayLeave().

Here is the call graph for this function:

_checkGoto()

static ilObjGroupAccess::_checkGoto ( string  $target )

static

@inheritDoc

Reimplemented from ilObjectAccess.

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

                                                     : bool
    {
        global $DIC;
 
        $ilAccess = $DIC->access();
        $ilUser = $DIC->user();
 
        $t_arr = explode("_", $target);
        // registration codes
        if (substr((string) ($t_arr[2] ?? ""), 0, 5) === 'rcode' and $ilUser->getId() != ANONYMOUS_USER_ID) {
            self::$using_code = true;
            return true;
        }
 
        if ($t_arr[0] != "grp" || ((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;
    }

References $DIC, $ilUser, and ANONYMOUS_USER_ID.

_getCommands()

static ilObjGroupAccess::_getCommands ( )

static

@inheritDoc

Reimplemented from ilObjectAccess.

Definition at line 113 of file class.ilObjGroupAccess.php.

                                         : array
    {
        $commands = array();
        $commands[] = array("permission" => "grp_linked", "cmd" => "", "lang_var" => "show", "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" => "grp_btn_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;
    }

References ilDAVActivationChecker\_isActive().

Referenced by ilObjGroupReferenceAccess\_getCommands(), and ilObjGroupListGUI\init().

Here is the call graph for this function:

Here is the caller graph for this function:

_preloadData()

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

static

@inheritDoc

Reimplemented from ilObjectAccess.

Definition at line 200 of file class.ilObjGroupAccess.php.

                                                                       : void
    {
        global $DIC;
 
        $ilDB = $DIC->database();
        $ilUser = $DIC->user();
 
        ilGroupWaitingList::_preloadOnListInfo([$ilUser->getId()], $obj_ids);
    }

References $DIC, $ilDB, $ilUser, and ilWaitingList\_preloadOnListInfo().

Here is the call graph for this function:

_registrationEnabled()

static ilObjGroupAccess::_registrationEnabled ( int  $a_obj_id )

static

Definition at line 165 of file class.ilObjGroupAccess.php.

                                                              : bool
    {
        global $DIC;
 
        $ilDB = $DIC->database();
        $query = "SELECT * FROM grp_settings " .
            "WHERE obj_id = " . $ilDB->quote($a_obj_id, 'integer') . " ";
 
        $res = $ilDB->query($query);
 
        $enabled = $unlimited = false;
        $start = $end = 0;
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $enabled = $row->registration_enabled;
            $unlimited = $row->registration_unlimited;
            $start = $row->registration_start;
            $end = $row->registration_end;
        }
 
        if (!$enabled) {
            return false;
        }
        if ($unlimited) {
            return true;
        }
        $start = new ilDateTime($start, IL_CAL_DATETIME);
        $end = new ilDateTime($end, IL_CAL_DATETIME);
        $time = new ilDateTime(time(), IL_CAL_UNIX);
        return ilDateTime::_after($time, $start) and ilDateTime::_before($time, $end);
    }

References $DIC, ILIAS\LTI\ToolProvider\$enabled, $ilDB, $query, $res, ilDateTime\_after(), ilDateTime\_before(), ilDBConstants\FETCHMODE_OBJECT, IL_CAL_DATETIME, and IL_CAL_UNIX.

Here is the call graph for this function:

_usingRegistrationCode()

static ilObjGroupAccess::_usingRegistrationCode ( )

static

Definition at line 332 of file class.ilObjGroupAccess.php.

                                                   : bool
    {
        return self::$using_code;
    }

References $using_code.

Referenced by ilObjGroup\register().

Here is the caller graph for this function:

lookupPeriodInfo()

static ilObjGroupAccess::lookupPeriodInfo ( int  $a_obj_id )

static

Parameters

int

$a_obj_id

Returns

array<{property: string, value: string}> | null

Exceptions

ilDateTimeException

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

                                                          : ?array
    {
        global $DIC;
 
        $ilDB = $DIC->database();
        $lng = $DIC->language();
 
        $start = $end = null;
        $query = 'SELECT period_start, period_end, period_time_indication FROM grp_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('grp');
 
            return
                [
                    'property' => $lng->txt('grp_period'),
                    'value' => ilDatePresentation::formatPeriod($start, $end)
                ];
        }
        return null;
    }

References $DIC, $ilDB, $lng, $query, $res, ilDBConstants\FETCHMODE_OBJECT, ilDatePresentation\formatPeriod(), IL_CAL_DATETIME, ilDBConstants\T_INTEGER, and ilTimeZone\UTC.

Referenced by ilObjGroupListGUI\getProperties().

Here is the call graph for this function:

Here is the caller graph for this function:

lookupRegistrationInfo()

static ilObjGroupAccess::lookupRegistrationInfo ( int  $a_obj_id )

static

Definition at line 210 of file class.ilObjGroupAccess.php.

                                                                : array
    {
        global $DIC;
 
        $ilDB = $DIC->database();
        $lng = $DIC->language();
 
        $query = 'SELECT registration_type, registration_enabled, registration_unlimited,  registration_start, ' .
            'registration_end, registration_mem_limit, registration_max_members FROM grp_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->registration_start, IL_CAL_DATETIME);
            $info['reg_info_end'] = new ilDateTime($row->registration_end, IL_CAL_DATETIME);
            $info['reg_info_type'] = $row->registration_type;
            $info['reg_info_mem_limit'] = $row->registration_mem_limit;
            $info['reg_info_unlimited'] = $row->registration_unlimited;
 
            $info['reg_info_max_members'] = 0;
            if ($info['reg_info_mem_limit']) {
                $info['reg_info_max_members'] = $row->registration_max_members;
            }
 
            $info['reg_info_enabled'] = $row->registration_enabled;
        }
 
        $registration_possible = $info['reg_info_enabled'];
 
        // Limited registration (added $registration_possible, see bug 0010157)
        if (!$info['reg_info_unlimited'] && $registration_possible) {
            $dt = new ilDateTime(time(), IL_CAL_UNIX);
            if (ilDateTime::_before($dt, $info['reg_info_start'])) {
                $info['reg_info_list_prop']['property'] = $lng->txt('grp_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('grp_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('grp_list_reg_period');
                $info['reg_info_list_prop']['value'] = $lng->txt('grp_list_reg_noreg');
            }
        } else {
            // added !$registration_possible, see bug 0010157
            if (!$registration_possible) {
                $registration_possible = false;
                $info['reg_info_list_prop']['property'] = $lng->txt('grp_list_reg');
                $info['reg_info_list_prop']['value'] = $lng->txt('grp_list_reg_noreg');
            }
        }
 
        if ($info['reg_info_mem_limit'] && $info['reg_info_max_members'] && $registration_possible) {
            // Check for free places
            $part = ilGroupParticipants::_getInstanceByObjId($a_obj_id);
 
            $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->getCountMembers());
            }
 
            if ($info['reg_info_free_places']) {
                $info['reg_info_list_prop_limit']['property'] = $lng->txt('grp_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('grp_list_reg_limit_full');
            }
        }
 
        return $info;
    }

References $DIC, $ilDB, $lng, $query, $res, ilDateTime\_before(), ilGroupParticipants\_getInstanceByObjId(), ilDBConstants\FETCHMODE_OBJECT, ilDatePresentation\formatDate(), IL_CAL_DATETIME, IL_CAL_UNIX, ilWaitingList\lookupListSize(), and ilDBConstants\T_INTEGER.

Referenced by ilGroupRegistrationGUI\fillMaxMembers(), ilObjGroupListGUI\getProperties(), and ilObjGroupGUI\infoScreen().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$using_code

bool ilObjGroupAccess::$using_code = false

staticprotected

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

Referenced by _usingRegistrationCode().

---

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

• Modules/Group/classes/class.ilObjGroupAccess.php