ilObjGroupAccess Class Reference

Class ilObjGroupAccess. More...

Inheritance diagram for ilObjGroupAccess:

Collaboration diagram for ilObjGroupAccess:

Public Member Functions
	_checkAccess ($a_cmd, $a_permission, $a_ref_id, $a_obj_id, $a_user_id="")
	checks wether a user may invoke a command or not (this method is called by ilAccessHandler::checkAccess) More...
Public Member Functions inherited from ilObjectAccess
	_checkAccess ($a_cmd, $a_permission, $a_ref_id, $a_obj_id, $a_user_id="")
	Checks wether a user may invoke a command or not (this method is called by ilAccessHandler::checkAccess) More...
	_checkCondition ($a_obj_id, $a_operator, $a_value, $a_usr_id)
	check condition More...
	canBeDelivered (ilWACPath $ilWACPath)
	Parameters ilWACPath $ilWACPath Returns bool More...

Static Public Member Functions
static	_getCommands ()
	get commands More...
static	_checkGoto ($a_target)
	check whether goto script will succeed More...
static	_registrationEnabled ($a_obj_id)
static	_preloadData ($a_obj_ids, $a_ref_ids)
	Preload data. More...
static	lookupRegistrationInfo ($a_obj_id)
	Lookup registration info ilDB $ilDB ilObjUser $ilUser ilLanguage $lng. More...
static	lookupPeriodInfo ($a_obj_id)
	Lookup course period info. More...
static	_usingRegistrationCode ()
	Using Registration code. More...
Static Public Member Functions inherited from ilObjectAccess
static	_getCommands ()
	get commands More...
static	_checkGoto ($a_target)
	check whether goto script will succeed More...
static	_isOffline ($a_obj_id)
	Type-specific implementation of general status, has to be overwritten if object type does not support centralized offline handling. More...
static	_preloadData ($a_obj_ids, $a_ref_ids)
	Preload data. More...

Static Protected Attributes
static	$using_code = false

Detailed Description

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 15 of file class.ilObjGroupAccess.php.

Member Function Documentation

_checkAccess()

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

checks wether a user may invoke a command or not (this method is called by ilAccessHandler::checkAccess)

Parameters

string	$a_cmd	command (not permission!)
string	$a_permission	permission
int	$a_ref_id	reference id
int	$a_obj_id	object id
int	$a_user_id	user id (if not provided, current user is taken)

Returns

boolean true, if everything is ok

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

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

    {
        global $DIC;

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

        if ($a_user_id == "") {
            $a_user_id = $ilUser->getId();
        }
        
        switch ($a_cmd) {
            case "info":
            
                include_once './Modules/Group/classes/class.ilGroupParticipants.php';
                if (ilGroupParticipants::_isParticipant($a_ref_id, $a_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($a_obj_id)) {
                    return false;
                }

                include_once './Modules/Group/classes/class.ilGroupWaitingList.php';
                if (ilGroupWaitingList::_isOnList($ilUser->getId(), $a_obj_id)) {
                    return false;
                }

                include_once './Modules/Group/classes/class.ilGroupParticipants.php';
                if (ilGroupParticipants::_isParticipant($a_ref_id, $a_user_id)) {
                    return false;
                }
                break;
                
            case 'leave':

                // Regular member
                if ($a_permission == 'leave') {
                    include_once './Modules/Group/classes/class.ilObjGroup.php';
                    $limit = null;
                    if (!ilObjGroup::mayLeave($a_obj_id, $a_user_id, $limit)) {
                        $ilAccess->addInfoItem(
                            ilAccessInfo::IL_STATUS_INFO,
                            sprintf($lng->txt("grp_cancellation_end_rbac_info"), ilDatePresentation::formatDate($limit))
                        );
                        return false;
                    }
                    
                    include_once './Modules/Group/classes/class.ilGroupParticipants.php';
                    if (!ilGroupParticipants::_isParticipant($a_ref_id, $a_user_id)) {
                        return false;
                    }
                }
                // Waiting list
                if ($a_permission == 'join') {
                    include_once './Modules/Group/classes/class.ilGroupWaitingList.php';
                    if (!ilGroupWaitingList::_isOnList($ilUser->getId(), $a_obj_id)) {
                        return false;
                    }
                }
                break;
                
        }

        switch ($a_permission) {
            case 'leave':
                include_once './Modules/Group/classes/class.ilObjGroup.php';
                return ilObjGroup::mayLeave($a_obj_id, $a_user_id);
        }
        return true;
    }

Here is the call graph for this function:

_checkGoto()

static ilObjGroupAccess::_checkGoto (   $a_target )

static

check whether goto script will succeed

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

References $DIC, and $ilUser.

    {
        global $DIC;

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

        $t_arr = explode("_", $a_target);
        // registration codes
        if (substr($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", "", $t_arr[1]) ||
            $ilAccess->checkAccess("visible", "", $t_arr[1])) {
            return true;
        }
        return false;
    }

_getCommands()

static ilObjGroupAccess::_getCommands ( )

static

get commands

this method returns an array of all possible commands/permission combinations

example: $commands = array ( array("permission" => "read", "cmd" => "view", "lang_var" => "show"), array("permission" => "write", "cmd" => "edit", "lang_var" => "edit"), );

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

References ilDAVActivationChecker\_isActive(), ilFMSettings\getInstance(), and ilWebDAVUtil\getInstance().

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

    {
        $commands = array();
        $commands[] = array("permission" => "grp_linked", "cmd" => "", "lang_var" => "show", "default" => true);

        include_once './Services/WebServices/FileManager/classes/class.ilFMSettings.php';
        if (ilFMSettings::getInstance()->isEnabled()) {
            $commands[] = array(
                'permission' => 'read',
                'cmd' => 'fileManagerLaunch',
                'lang_var' => 'fm_start',
                'enable_anonymous' => false
            );
        }

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

        // on waiting list
        $commands[] = array('permission' => "join", "cmd" => "leave", "lang_var" => "leave_waiting_list");
        
        // regualar users
        $commands[] = array('permission' => "leave", "cmd" => "leave", "lang_var" => "grp_btn_unsubscribe");
        
        include_once('Services/WebDAV/classes/class.ilDAVActivationChecker.php');
        if (ilDAVActivationChecker::_isActive()) {
            include_once './Services/WebDAV/classes/class.ilWebDAVUtil.php';
            if (ilWebDAVUtil::getInstance()->isLocalPasswordInstructionRequired()) {
                $commands[] = array('permission' => 'read', 'cmd' => 'showPasswordInstruction', 'lang_var' => 'mount_webfolder', 'enable_anonymous' => 'false');
            } else {
                $commands[] = array("permission" => "read", "cmd" => "mount_webfolder", "lang_var" => "mount_webfolder", "enable_anonymous" => "false");
            }
        }

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

_preloadData()

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

static

Preload data.

Parameters

array

$a_obj_ids

array of object ids

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

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

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        $ilUser = $DIC['ilUser'];
        
        include_once("./Modules/Group/classes/class.ilGroupWaitingList.php");
        ilGroupWaitingList::_preloadOnListInfo($ilUser->getId(), $a_obj_ids);
    }

Here is the call graph for this function:

_registrationEnabled()

static ilObjGroupAccess::_registrationEnabled (   $a_obj_id )

static

Returns

Parameters

object

$a_obj_id

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

References $DIC, $end, $ilDB, $query, $res, $row, $start, $time, ilDateTime\_after(), ilDateTime\_before(), ilDBConstants\FETCHMODE_OBJECT, IL_CAL_DATETIME, and IL_CAL_UNIX.

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

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

        $res = $ilDB->query($query);
        
        $enabled = $unlimited = false;
        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;
        }
        
        if (!$unlimited) {
            $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);
        }
        return false;
    }

Here is the call graph for this function:

_usingRegistrationCode()

static ilObjGroupAccess::_usingRegistrationCode ( )

static

Using Registration code.

Returns

bool

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

Referenced by ilObjGroup\register().

    {
        return self::$using_code;
    }

Here is the caller graph for this function:

lookupPeriodInfo()

static ilObjGroupAccess::lookupPeriodInfo (   $a_obj_id )

static

Lookup course period info.

Parameters

int

$a_obj_id

Returns

array

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

References $DIC, $end, $ilDB, $lng, $query, $row, $start, ilDatePresentation\formatPeriod(), and IL_CAL_UNIX.

Referenced by ilObjGroupListGUI\getProperties().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        $lng = $DIC['lng'];
        
        $start = $end = null;
        
        $query = 'SELECT grp_start, grp_end FROM grp_settings' .
            ' WHERE obj_id = ' . $ilDB->quote($a_obj_id);
        $set = $ilDB->query($query);
        while ($row = $ilDB->fetchAssoc($set)) {
            $start = $row['grp_start']
                ? new ilDate($row['grp_start'], IL_CAL_UNIX)
                : null;
            $end = $row['grp_end']
                ? new ilDate($row['grp_end'], IL_CAL_UNIX)
                : null;
        }
        
        if ($start && $end) {
            $lng->loadLanguageModule('grp');
            
            return array(
                'property' => $lng->txt('grp_period'),
                'value' => ilDatePresentation::formatPeriod($start, $end)
            );
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

lookupRegistrationInfo()

static ilObjGroupAccess::lookupRegistrationInfo (   $a_obj_id )

static

Lookup registration info ilDB $ilDB ilObjUser $ilUser ilLanguage $lng.

Parameters

int

$a_obj_id

Returns

array

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

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

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

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        $ilUser = $DIC['ilUser'];
        $lng = $DIC['lng'];
        
        $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);
        $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_max_members'] = $row->registration_max_members;
            $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
            include_once './Modules/Group/classes/class.ilGroupParticipants.php';
            $part = ilGroupParticipants::_getInstanceByObjId($a_obj_id);

            include_once './Modules/Course/classes/class.ilCourseWaitingList.php';
            $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;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$using_code

ilObjGroupAccess::$using_code = false

staticprotected

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

---

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

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