This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilProfileChecklistStatus:

Public Member Functions
	__construct (?ilLanguage $lng=null, ?ilObjUser $user=null)

	getSteps ()

	anyVisibilitySettings ()
	Any visibility settings? More...

	getStatus (int $step)
	Get status of step. More...

	getStatusDetails (int $step)
	Get status details. More...

	saveStepSucess (int $step)
	Save step success. More...

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

Protected Attributes
ilPersonalProfileMode	$profile_mode

ilObjUser	$user

ilLanguage	$lng

ilSetting	$settings

Private Member Functions
	areOnScreenChatOptionsVisible ()

	areChatTypingBroadcastOptionsVisible ()

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

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

Definition at line 22 of file ilProfileChecklistStatus.php.

Constructor & Destructor Documentation

◆ __construct()

ilProfileChecklistStatus::__construct	(	?ilLanguage	$lng = `null`,
		?ilObjUser	$user = `null`
	)

Definition at line 37 of file ilProfileChecklistStatus.php.

      {
        global $DIC;
 
        $this->lng = is_null($lng)
            ? $DIC->language()
            : $lng;
 
        $this->lng->loadLanguageModule('chatroom');
        $this->user = is_null($user)
            ? $DIC->user()
            : $user;
 
        $this->settings = $DIC->settings();
 
        $this->profile_mode = new ilPersonalProfileMode($this->user, $DIC->settings());
    }

References $DIC, $lng, $user, ILIAS\Repository\lng(), ILIAS\Repository\settings(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

◆ anyVisibilitySettings()

ilProfileChecklistStatus::anyVisibilitySettings ( )

Any visibility settings?

Definition at line 99 of file ilProfileChecklistStatus.php.

                                           : bool
    {
        $awrn_set = new ilSetting("awrn");
        if (
            $awrn_set->get("awrn_enabled", '0') ||
            ilBuddySystem::getInstance()->isEnabled() ||
            $this->areOnScreenChatOptionsVisible() ||
            $this->areChatTypingBroadcastOptionsVisible()
        ) {
            return true;
        }
 
        return false;
    }

References ilBuddySystem\getInstance().

Referenced by getStatusDetails(), and getSteps().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ areChatTypingBroadcastOptionsVisible()

ilProfileChecklistStatus::areChatTypingBroadcastOptionsVisible ( )

private

Definition at line 68 of file ilProfileChecklistStatus.php.

                                                           : bool
    {
        $chatSettings = new ilSetting('chatroom');
 
        return (
            $chatSettings->get('chat_enabled', '0') &&
            !(bool) $this->settings->get('usr_settings_hide_chat_broadcast_typing', '0')
        );
    }

Referenced by getStatusDetails().

Here is the caller graph for this function:

◆ areOnScreenChatOptionsVisible()

ilProfileChecklistStatus::areOnScreenChatOptionsVisible ( )

private

Definition at line 57 of file ilProfileChecklistStatus.php.

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

Referenced by getStatusDetails().

Here is the caller graph for this function:

◆ getStatus()

ilProfileChecklistStatus::getStatus ( int $step )

Get status of step.

Definition at line 117 of file ilProfileChecklistStatus.php.

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

References $user, ilObjUser\getPref(), ilObjUser\getProfileIncomplete(), STATUS_IN_PROGRESS, STATUS_NOT_STARTED, STATUS_SUCCESSFUL, STEP_PROFILE_DATA, STEP_PUBLISH_OPTIONS, and STEP_VISIBILITY_OPTIONS.

Referenced by getStatusDetails(), and ilProfileChecklistGUI\render().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getStatusDetails()

ilProfileChecklistStatus::getStatusDetails ( int $step )

Get status details.

Definition at line 153 of file ilProfileChecklistStatus.php.

                                               : string
    {
        $lng = $this->lng;
        $user = $this->user;
        $status = $this->getStatus($step);
        $details = "";
        switch ($step) {
            case self::STEP_PROFILE_DATA:
                if ($status == self::STATUS_SUCCESSFUL) {
                    $details = $lng->txt("user_profile_data_checked");
                } else {
                    $details = $lng->txt("user_check_profile_data");
                }
                break;
 
            case self::STEP_PUBLISH_OPTIONS:
                if ($status == self::STATUS_SUCCESSFUL) {
                    $details = $this->profile_mode->getModeInfo();
                } else {
                    $details = $lng->txt("user_set_publishing_options");
                }
                break;
 
            case self::STEP_VISIBILITY_OPTIONS:
                if ($status == self::STATUS_SUCCESSFUL) {
                    $awrn_set = new ilSetting("awrn");
                    $status = [];
                    if ($awrn_set->get("awrn_enabled", '0')) {
                        $show = ($user->getPref("hide_own_online_status") === "n" ||
                            ($user->getPref("hide_own_online_status") == "" && $this->settings->get("hide_own_online_status") === "n"));
                        $status[] = (!$show)
                            ? $lng->txt("hide_own_online_status")
                            : $lng->txt("show_own_online_status");
                    }
                    if (ilBuddySystem::getInstance()->isEnabled()) {
                        $status[] = ($user->getPref("bs_allow_to_contact_me") !== "y")
                            ? $lng->txt("buddy_allow_to_contact_me_no")
                            : $lng->txt("buddy_allow_to_contact_me_yes");
                    }
                    if ($this->areOnScreenChatOptionsVisible()) {
                        $status[] = ilUtil::yn2tf((string) $this->user->getPref('chat_osc_accept_msg'))
                            ? $lng->txt("chat_use_osc")
                            : $lng->txt("chat_not_use_osc");
                    }
                    if ($this->areChatTypingBroadcastOptionsVisible()) {
                        $status[] = ilUtil::yn2tf((string) $this->user->getPref('chat_broadcast_typing'))
                            ? $lng->txt("chat_use_typing_broadcast")
                            : $lng->txt("chat_no_use_typing_broadcast");
                    }
                    $details = implode(",<br>", $status);
                } else {
                    if ($this->anyVisibilitySettings()) {
                        $details = $lng->txt("user_set_visibilty_options");
                    }
                }
                break;
        }
        return $details;
    }

References ILIAS\LTI\ToolProvider\$details, $lng, $user, anyVisibilitySettings(), areChatTypingBroadcastOptionsVisible(), areOnScreenChatOptionsVisible(), ilBuddySystem\getInstance(), ilObjUser\getPref(), getStatus(), ILIAS\Repository\settings(), STEP_PROFILE_DATA, STEP_PUBLISH_OPTIONS, STEP_VISIBILITY_OPTIONS, ilLanguage\txt(), ILIAS\Repository\user(), and ilUtil\yn2tf().

Referenced by ilProfileChecklistGUI\render().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSteps()

ilProfileChecklistStatus::getSteps ( )

Returns: array<int,string>

Definition at line 81 of file ilProfileChecklistStatus.php.

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

References $lng, anyVisibilitySettings(), and ilLanguage\txt().

Here is the call graph for this function:

◆ saveStepSucess()

ilProfileChecklistStatus::saveStepSucess ( int $step )

Save step success.

Definition at line 217 of file ilProfileChecklistStatus.php.

                                             : void
    {
        $user = $this->user;
        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;
        }
        $user->update();
    }