Collaboration diagram for ILIAS\User\Profile\ChecklistStatus:

Public Member Functions
	__construct (private readonly Language $lng, private readonly \ilSetting $settings, private \ilObjUser $user, private readonly Visibility $profile_mode)

	getSteps ()

	anyVisibilitySettings ()

	getStatus (int $step)

	getStatusDetails (int $step)

	setStepSucessOnUser (int $step, \ilObjUser $user)

Data Fields
const	STEP_PROFILE_DATA = 0

const	STEP_PUBLISH_OPTIONS = 1

const	STEP_VISIBILITY_OPTIONS = 2

const	STATUS_NOT_STARTED = 0

const	STATUS_IN_PROGRESS = 1

const	STATUS_SUCCESSFUL = 2

Private Member Functions
	buildStatusArrayForVisibilityOnSuccess ()

	areOnScreenChatOptionsVisible ()

	areChatTypingBroadcastOptionsVisible ()

Private Attributes
ilSetting	$settings_chat

ilSetting	$settings_awareness

Detailed Description

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

Definition at line 28 of file ChecklistStatus.php.

Constructor & Destructor Documentation

◆ __construct()

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

Definition at line 41 of file ChecklistStatus.php.

      {
        $this->settings_chat = new \ilSetting('chatroom');
        $this->settings_awareness = new \ilSetting('awrn');
 
        $this->lng->loadLanguageModule('chatroom');
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

Member Function Documentation

◆ anyVisibilitySettings()

ILIAS\User\Profile\ChecklistStatus::anyVisibilitySettings ( )

Definition at line 68 of file ChecklistStatus.php.

                                           : bool
    {
 
        return $this->settings_awareness->get('awrn_enabled', '0') !== '0'
            || \ilBuddySystem::getInstance()->isEnabled()
            || $this->areOnScreenChatOptionsVisible()
            || $this->areChatTypingBroadcastOptionsVisible();
    }

References ILIAS\User\Profile\ChecklistStatus\areChatTypingBroadcastOptionsVisible(), ILIAS\User\Profile\ChecklistStatus\areOnScreenChatOptionsVisible(), and ilBuddySystem\getInstance().

Referenced by ILIAS\User\Profile\ChecklistStatus\getStatusDetails(), and ILIAS\User\Profile\ChecklistStatus\getSteps().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ areChatTypingBroadcastOptionsVisible()

ILIAS\User\Profile\ChecklistStatus::areChatTypingBroadcastOptionsVisible ( )

private

Definition at line 190 of file ChecklistStatus.php.

                                                           : bool
    {
        return $this->settings_chat->get('chat_enabled', '0')
            && $this->settings->get('usr_settings_hide_chat_broadcast_typing', '0') === '0';
    }

References ILIAS\Repository\settings().

Referenced by ILIAS\User\Profile\ChecklistStatus\anyVisibilitySettings().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ areOnScreenChatOptionsVisible()

ILIAS\User\Profile\ChecklistStatus::areOnScreenChatOptionsVisible ( )

private

Definition at line 183 of file ChecklistStatus.php.

                                                    : bool
    {
        return $this->settings_chat->get('chat_enabled', '0') !== '0'
            && $this->settings_chat->get('enable_osc', '0') !== '0'
            && $this->settings->get('usr_settings_hide_chat_osc_accept_msg', '0') === '0';
    }

References ILIAS\Repository\settings().

Referenced by ILIAS\User\Profile\ChecklistStatus\anyVisibilitySettings().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildStatusArrayForVisibilityOnSuccess()

ILIAS\User\Profile\ChecklistStatus::buildStatusArrayForVisibilityOnSuccess ( )

private

Definition at line 154 of file ChecklistStatus.php.

                                                             : string
    {
        $status = [];
        if ($this->settings_awareness->get('awrn_enabled', '0') !== '0') {
            $show = $this->user->getPref('hide_own_online_status') === 'n'
                || $this->user->getPref('hide_own_online_status') ?? '' === ''
                    && $this->settings->get('hide_own_online_status') === 'n';
            $status[] = !$show
                ? $this->lng->txt('hide_own_online_status')
                : $this->lng->txt('show_own_online_status');
        }
        if (\ilBuddySystem::getInstance()->isEnabled()) {
            $status[] = $this->user->getPref('bs_allow_to_contact_me') !== 'y'
                ? $this->lng->txt('buddy_allow_to_contact_me_no')
                : $this->lng->txt('buddy_allow_to_contact_me_yes');
        }
        if ($this->areOnScreenChatOptionsVisible()) {
            $status[] = $this->user->getPref('chat_osc_accept_msg') === 'y'
                ? $this->lng->txt('chat_use_osc')
                : $this->lng->txt('chat_not_use_osc');
        }
        if ($this->areChatTypingBroadcastOptionsVisible()) {
            $status[] = $this->user->getPref('chat_broadcast_typing') === 'y'
                ? $this->lng->txt('chat_use_typing_broadcast')
                : $this->lng->txt('chat_no_use_typing_broadcast');
        }
        return implode(',<br>', $status);
    }

References ilBuddySystem\getInstance(), ILIAS\Repository\lng(), ILIAS\Repository\settings(), and ILIAS\Repository\user().

Referenced by ILIAS\User\Profile\ChecklistStatus\getStatusDetails().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getStatus()

ILIAS\User\Profile\ChecklistStatus::getStatus ( int $step )

Definition at line 77 of file ChecklistStatus.php.

                                        : int
    {
        switch ($step) {
            case self::STEP_PROFILE_DATA:
                if ($this->user->getProfileIncomplete()) {
                    return self::STATUS_IN_PROGRESS;
                }
                if ($this->user->getPref('profile_personal_data_saved')) {
                    return self::STATUS_SUCCESSFUL;
                }
                break;
 
            case self::STEP_PUBLISH_OPTIONS:
                if ($this->user->getPref('profile_publish_opt_saved')) {
                    return self::STATUS_SUCCESSFUL;
                }
                break;
 
            case self::STEP_VISIBILITY_OPTIONS:
                if ($this->user->getPref('profile_visibility_opt_saved')
                        || !$this->anyVisibilitySettings()
                            && $this->user->getPref('profile_publish_opt_saved')) {
                    return self::STATUS_SUCCESSFUL;
                }
                break;
        }
 
        return self::STATUS_NOT_STARTED;
    }

References ILIAS\User\Profile\ChecklistStatus\STATUS_IN_PROGRESS, ILIAS\User\Profile\ChecklistStatus\STATUS_NOT_STARTED, ILIAS\User\Profile\ChecklistStatus\STATUS_SUCCESSFUL, ILIAS\User\Profile\ChecklistStatus\STEP_PROFILE_DATA, ILIAS\User\Profile\ChecklistStatus\STEP_PUBLISH_OPTIONS, ILIAS\User\Profile\ChecklistStatus\STEP_VISIBILITY_OPTIONS, and ILIAS\Repository\user().

Referenced by ILIAS\User\Profile\ChecklistStatus\getStatusDetails(), and ILIAS\User\Profile\ChecklistGUI\render().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getStatusDetails()

ILIAS\User\Profile\ChecklistStatus::getStatusDetails ( int $step )

Definition at line 107 of file ChecklistStatus.php.

                                               : string
    {
        $status = $this->getStatus($step);
        switch ($step) {
            case self::STEP_PROFILE_DATA:
                if ($status === self::STATUS_SUCCESSFUL) {
                    return $this->lng->txt('user_profile_data_checked');
                }
                return $this->lng->txt('user_check_profile_data');
 
            case self::STEP_PUBLISH_OPTIONS:
                if ($status === self::STATUS_SUCCESSFUL) {
                    return $this->profile_mode->getModeInfo();
                }
                return $this->lng->txt('user_set_publishing_options');
 
            case self::STEP_VISIBILITY_OPTIONS:
                if ($status === self::STATUS_SUCCESSFUL) {
                    return $this->buildStatusArrayForVisibilityOnSuccess();
                }
                if ($this->anyVisibilitySettings()) {
                    return $this->lng->txt('user_set_visibilty_options');
                }
                break;
        }
        return '';
    }

References ILIAS\User\Profile\ChecklistStatus\anyVisibilitySettings(), ILIAS\User\Profile\ChecklistStatus\buildStatusArrayForVisibilityOnSuccess(), ILIAS\User\Profile\ChecklistStatus\getStatus(), ILIAS\Repository\lng(), ILIAS\User\Profile\ChecklistStatus\STEP_PROFILE_DATA, ILIAS\User\Profile\ChecklistStatus\STEP_PUBLISH_OPTIONS, and ILIAS\User\Profile\ChecklistStatus\STEP_VISIBILITY_OPTIONS.

Referenced by ILIAS\User\Profile\ChecklistGUI\render().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSteps()

ILIAS\User\Profile\ChecklistStatus::getSteps ( )

Returns: array<int,string>

Definition at line 55 of file ChecklistStatus.php.

                              : array
    {
        $txt_visibility = $this->anyVisibilitySettings()
            ? $this->lng->txt('user_visibility_settings')
            : $this->lng->txt('preview');
 
        return [
            self::STEP_PROFILE_DATA => $this->lng->txt('user_profile_data'),
            self::STEP_PUBLISH_OPTIONS => $this->lng->txt('user_publish_options'),
            self::STEP_VISIBILITY_OPTIONS => $txt_visibility
        ];
    }

References ILIAS\User\Profile\ChecklistStatus\anyVisibilitySettings(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ setStepSucessOnUser()

ILIAS\User\Profile\ChecklistStatus::setStepSucessOnUser	(	int	$step,
		\ilObjUser	$user
	)

Definition at line 135 of file ChecklistStatus.php.

     : \ilObjUser {
        switch ($step) {
            case self::STEP_PROFILE_DATA:
                $user->setPref('profile_personal_data_saved', '1');
                break;
            case self::STEP_PUBLISH_OPTIONS:
                $user->setPref('profile_publish_opt_saved', '1');
                break;
            case self::STEP_VISIBILITY_OPTIONS:
                $user->setPref('profile_visibility_opt_saved', '1');
                break;
        }
        $this->user = $user;
        return $user;
    }

References ilObjUser\setPref(), ILIAS\User\Profile\ChecklistStatus\STEP_PROFILE_DATA, ILIAS\User\Profile\ChecklistStatus\STEP_PUBLISH_OPTIONS, and ILIAS\User\Profile\ChecklistStatus\STEP_VISIBILITY_OPTIONS.

Here is the call graph for this function:

Field Documentation

◆ $settings_awareness

ilSetting ILIAS\User\Profile\ChecklistStatus::$settings_awareness

private

Definition at line 39 of file ChecklistStatus.php.

◆ $settings_chat

ilSetting ILIAS\User\Profile\ChecklistStatus::$settings_chat

private

Definition at line 38 of file ChecklistStatus.php.

◆ STATUS_IN_PROGRESS

const ILIAS\User\Profile\ChecklistStatus::STATUS_IN_PROGRESS = 1

Definition at line 35 of file ChecklistStatus.php.

Referenced by ILIAS\User\Profile\ChecklistStatus\getStatus(), and ILIAS\User\Profile\ChecklistGUI\getUIChecklistStatus().

◆ STATUS_NOT_STARTED

const ILIAS\User\Profile\ChecklistStatus::STATUS_NOT_STARTED = 0

Definition at line 34 of file ChecklistStatus.php.

Referenced by ILIAS\User\Profile\ChecklistStatus\getStatus(), and ILIAS\User\Profile\ChecklistGUI\getUIChecklistStatus().

◆ STATUS_SUCCESSFUL

const ILIAS\User\Profile\ChecklistStatus::STATUS_SUCCESSFUL = 2

Definition at line 36 of file ChecklistStatus.php.

Referenced by ILIAS\User\Profile\ChecklistStatus\getStatus(), and ILIAS\User\Profile\ChecklistGUI\getUIChecklistStatus().

◆ STEP_PROFILE_DATA

const ILIAS\User\Profile\ChecklistStatus::STEP_PROFILE_DATA = 0

Definition at line 30 of file ChecklistStatus.php.

Referenced by ILIAS\User\Profile\ChecklistStatus\getStatus(), ILIAS\User\Profile\ChecklistStatus\getStatusDetails(), ILIAS\User\Profile\PersonalProfileGUI\savePersonalData(), and ILIAS\User\Profile\ChecklistStatus\setStepSucessOnUser().

◆ STEP_PUBLISH_OPTIONS

const ILIAS\User\Profile\ChecklistStatus::STEP_PUBLISH_OPTIONS = 1

Definition at line 31 of file ChecklistStatus.php.

Referenced by ILIAS\User\Profile\ChecklistStatus\getStatus(), ILIAS\User\Profile\ChecklistStatus\getStatusDetails(), and ILIAS\User\Profile\ChecklistStatus\setStepSucessOnUser().

◆ STEP_VISIBILITY_OPTIONS

const ILIAS\User\Profile\ChecklistStatus::STEP_VISIBILITY_OPTIONS = 2

Definition at line 32 of file ChecklistStatus.php.

Referenced by ILIAS\User\Profile\PersonalProfileGUI\executeCommand(), ILIAS\User\Profile\ChecklistStatus\getStatus(), ILIAS\User\Profile\ChecklistStatus\getStatusDetails(), ILIAS\User\Privacy\SettingsGUI\saveCmd(), and ILIAS\User\Profile\ChecklistStatus\setStepSucessOnUser().

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

components/ILIAS/User/src/Profile/ChecklistStatus.php

Public Member Functions

Data Fields

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ anyVisibilitySettings()

◆ areChatTypingBroadcastOptionsVisible()

◆ areOnScreenChatOptionsVisible()

◆ buildStatusArrayForVisibilityOnSuccess()

◆ getStatus()

◆ getStatusDetails()

◆ getSteps()

◆ setStepSucessOnUser()

Field Documentation

◆ $settings_awareness

◆ $settings_chat

◆ STATUS_IN_PROGRESS

◆ STATUS_NOT_STARTED

◆ STATUS_SUCCESSFUL

◆ STEP_PROFILE_DATA

◆ STEP_PUBLISH_OPTIONS

◆ STEP_VISIBILITY_OPTIONS