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

Collaboration diagram for ilObjUserAccess:

Public Member Functions
	_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)
	_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 ()
	get commands More...
static	_checkGoto (string $target)
	check whether goto script will succeed More...
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...

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 ilObjUserAccess

Author

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

Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 25 of file class.ilObjUserAccess.php.

Member Function Documentation

_checkAccess()

ilObjUserAccess::_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)

Please do not check any preconditions handled by ilConditionHandler here. Also don't do any RBAC checks.

Reimplemented from ilObjectAccess.

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

                                                                                                                 : bool
    {
        throw new ilException("_checkAccess must not be called on user object.");
    }

_checkGoto()

static ilObjUserAccess::_checkGoto ( string  $target )

static

check whether goto script will succeed

Reimplemented from ilObjectAccess.

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

                                                     : bool
    {
        global $DIC;
        $main_tpl = $DIC->ui()->mainTemplate();
        $settings = isset($GLOBALS['DIC']) ? $GLOBALS['DIC']->settings() : $GLOBALS['DIC']['ilSetting'];
 
        if ('usr_registration' == $target) {
            $regSeetings = new ilRegistrationSettings();
            if ($regSeetings->getRegistrationType() == ilRegistrationSettings::IL_REG_DISABLED) {
                $GLOBALS['DIC']->language()->loadLanguageModule('registration');
                $main_tpl->setOnScreenMessage('failure', sprintf($GLOBALS['DIC']->language()->txt('registration_disabled_no_access'), $settings->get('admin_email')), true);
                return false;
            }
        } elseif ('usr_nameassist' == $target) {
            if (!$settings->get('password_assistance')) {
                $GLOBALS['DIC']->language()->loadLanguageModule('pwassist');
                $main_tpl->setOnScreenMessage('failure', sprintf($GLOBALS['DIC']->language()->txt('unassist_disabled_no_access'), $settings->get('admin_email')), true);
                return false;
            }
        } elseif ('usr_pwassist' == $target) {
            if (!$settings->get('password_assistance')) {
                $GLOBALS['DIC']->language()->loadLanguageModule('pwassist');
                $main_tpl->setOnScreenMessage('failure', sprintf($GLOBALS['DIC']->language()->txt('pwassist_disabled_no_access'), $settings->get('admin_email')), true);
                return false;
            }
        }
 
        return true;
    }

References $DIC, $GLOBALS, ILIAS\LTI\ToolProvider\$settings, ilRegistrationSettings\IL_REG_DISABLED, and ILIAS\UI\examples\Symbol\Glyph\Language\language().

Here is the call graph for this function:

_getCommands()

static ilObjUserAccess::_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"), );

Returns

array{permission?:string, cmd?:string, lang_var?:string, default?:bool}[]

Reimplemented from ilObjectAccess.

Definition at line 27 of file class.ilObjUserAccess.php.

                                         : array
    {
        throw new ilException("_getCommands must not be called on user object.");
    }

canBeDelivered()

ilObjUserAccess::canBeDelivered

(

ilWACPath

$ilWACPath

)

Reimplemented from ilObjectAccess.

Definition at line 67 of file class.ilObjUserAccess.php.

                                                        : bool
    {
        global $DIC;
 
        $ilUser = $DIC['ilUser'];
        $ilSetting = $DIC['ilSetting'];
 
        preg_match("/usr_(\\d*).*/ui", $ilWACPath->getFileName(), $matches);
        $usr_id = $matches[1];
 
        // check if own image is viewed
        if ($usr_id == $ilUser->getId()) {
            return true;
        }
 
        // check if image is in the public profile
        $public_upload = ilObjUser::_lookupPref($usr_id, 'public_upload');
        if ($public_upload != 'y') {
            return false;
        }
 
        // check the publication status of the profile
        $public_profile = ilObjUser::_lookupPref($usr_id, 'public_profile');
 
        if ($public_profile == 'g' and $ilSetting->get('enable_global_profiles') and $ilSetting->get('pub_section')) {
            // globally public
            return true;
        } elseif (($public_profile == 'y' or $public_profile == 'g') and $ilUser->getId() != ANONYMOUS_USER_ID && $ilUser->getId() != 0) {
            // public for logged in users
            return true;
        } else {
            // not public
            return false;
        }
    }

References $DIC, $ilSetting, $ilUser, ilObjUser\_lookupPref(), ANONYMOUS_USER_ID, and ilWACPath\getFileName().

Here is the call graph for this function:

---

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

• Services/User/classes/class.ilObjUserAccess.php