ILIAS\User\Profile\Mode Class Reference

Personal profile publishing mode of a user. More...

Collaboration diagram for ILIAS\User\Profile\Mode:

Public Member Functions
	__construct (private readonly Language $lng, private readonly \ilSetting $settings, private readonly \ilObjUser $user)
	getMode ()
	isEnabled ()
	getModeInfo (string $mode=null)

Data Fields
const	PROFILE_DISABLED = 'n'
const	PROFILE_ENABLED_LOGGED_IN_USERS = 'y'
const	PROFILE_ENABLED_GLOBAL = 'g'

Detailed Description

Personal profile publishing mode of a user.

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 29 of file Mode.php.

Constructor & Destructor Documentation

__construct()

ILIAS\User\Profile\Mode::__construct	(	private readonly Language	$lng,
		private readonly \ilSetting	$settings,
		private readonly \ilObjUser	$user
	)

Definition at line 35 of file Mode.php.

      {
    }

Member Function Documentation

getMode()

ILIAS\User\Profile\Mode::getMode

(

)

Definition at line 42 of file Mode.php.

References ILIAS\Repository\settings(), and ILIAS\Repository\user().

Referenced by ILIAS\User\Profile\Mode\getModeInfo(), and ILIAS\User\Profile\Mode\isEnabled().

                             : string
    {
        $public_profile_pref = $this->user->prefs['public_profile'] ?? null;
        if ($public_profile_pref === null
            || !in_array(
                $public_profile_pref,
                [
                    self::PROFILE_ENABLED_LOGGED_IN_USERS,
                    self::PROFILE_ENABLED_GLOBAL
                ]
            )) {
            return self::PROFILE_DISABLED;
        }

        if ($this->settings->get('enable_global_profiles')) {
            return $public_profile_pref;
        }
        return self::PROFILE_ENABLED_LOGGED_IN_USERS;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getModeInfo()

ILIAS\User\Profile\Mode::getModeInfo

(

string

$mode = null

)

Definition at line 73 of file Mode.php.

References ILIAS\User\Profile\Mode\getMode(), and ILIAS\Repository\lng().

                                                    : string
    {
        switch ($this->getMode()) {
            case self::PROFILE_DISABLED:
                return $this->lng->txt('usr_public_profile_disabled');
            case self::PROFILE_ENABLED_LOGGED_IN_USERS:
                return $this->lng->txt('usr_public_profile_logged_in');
            case self::PROFILE_ENABLED_GLOBAL:
                return $this->lng->txt('usr_public_profile_global');
        }
        return '';
    }

Here is the call graph for this function:

isEnabled()

ILIAS\User\Profile\Mode::isEnabled

(

)

Definition at line 62 of file Mode.php.

References ILIAS\User\Profile\Mode\getMode().

                               : bool
    {
        return in_array(
            $this->getMode(),
            [
                self::PROFILE_ENABLED_LOGGED_IN_USERS,
                self::PROFILE_ENABLED_GLOBAL
            ]
        );
    }

Here is the call graph for this function:

Field Documentation

PROFILE_DISABLED

const ILIAS\User\Profile\Mode::PROFILE_DISABLED = 'n'

Definition at line 31 of file Mode.php.

PROFILE_ENABLED_GLOBAL

const ILIAS\User\Profile\Mode::PROFILE_ENABLED_GLOBAL = 'g'

Definition at line 33 of file Mode.php.

PROFILE_ENABLED_LOGGED_IN_USERS

const ILIAS\User\Profile\Mode::PROFILE_ENABLED_LOGGED_IN_USERS = 'y'

Definition at line 32 of file Mode.php.

---

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

• components/ILIAS/User/src/Profile/Mode.php