Collaboration diagram for ilProfileChecklistStatus:

Public Member Functions
	__construct ($lng=null, $user=null)
	Constructor. More...

	getSteps ()
	Get steps. More...

	anyVisibilitySettings ()
	Any visibility settings? More...

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

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

	saveStepSucess ($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
	$lng

	$settings

Private Member Functions
	areOnScreenChatOptionsVisible ()

Detailed Description

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

Definition at line 10 of file ilProfileChecklistStatus.php.

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

Definition at line 33 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, settings(), and user().

Here is the call graph for this function:

Member Function Documentation

◆ anyVisibilitySettings()

ilProfileChecklistStatus::anyVisibilitySettings ( )

Any visibility settings?

Returns: bool

Definition at line 91 of file ilProfileChecklistStatus.php.

                                            : bool
    {
        $awrn_set = new ilSetting("awrn");
        if (
            $awrn_set->get("awrn_enabled", false) ||
            ilBuddySystem::getInstance()->isEnabled() ||
            $this->areOnScreenChatOptionsVisible()
        ) {
            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:

◆ areOnScreenChatOptionsVisible()

ilProfileChecklistStatus::areOnScreenChatOptionsVisible ( )

private

Returns: bool

Definition at line 54 of file ilProfileChecklistStatus.php.

                                                     : bool
    {
        $chatSettings = new ilSetting('chatroom');
        $notificationSettings = new ilSetting('notifications');
 
        return (
            $chatSettings->get('enable_osc', false) &&
            !(bool) $notificationSettings->get('usr_settings_hide_chat_osc_accept_msg', false)
        );
    }

Referenced by getStatusDetails().

Here is the caller graph for this function:

◆ getStatus()

ilProfileChecklistStatus::getStatus ( int $step )

Get status of step.

Parameters

int

Returns: int

Definition at line 111 of file ilProfileChecklistStatus.php.

    {
        $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 STATUS_IN_PROGRESS, STATUS_NOT_STARTED, STATUS_SUCCESSFUL, STEP_PROFILE_DATA, STEP_PUBLISH_OPTIONS, and STEP_VISIBILITY_OPTIONS.

Referenced by getStatusDetails().

Here is the caller graph for this function:

◆ getStatusDetails()

ilProfileChecklistStatus::getStatusDetails ( int $step )

Get status details.

Parameters

int $step

Returns: string

Definition at line 150 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", false)) {
                        $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($this->user->getPref('chat_osc_accept_msg'))
                            ? $lng->txt("chat_use_osc")
                            : $lng->txt("chat_not_use_osc");
                    }
                    $details = implode(",<br>", $status);
                } else {
                    if ($this->anyVisibilitySettings()) {
                        $details = $lng->txt("user_set_visibilty_options");
                    }
                }
                break;
        }
        return $details;
    }

References $lng, anyVisibilitySettings(), areOnScreenChatOptionsVisible(), ilBuddySystem\getInstance(), getStatus(), settings(), STEP_PROFILE_DATA, STEP_PUBLISH_OPTIONS, STEP_VISIBILITY_OPTIONS, user(), and ilUtil\yn2tf().

Here is the call graph for this function:

◆ getSteps()

ilProfileChecklistStatus::getSteps ( )

Get steps.

Parameters

return

Definition at line 71 of file ilProfileChecklistStatus.php.

    {
        $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, and anyVisibilitySettings().

Here is the call graph for this function:

◆ saveStepSucess()

ilProfileChecklistStatus::saveStepSucess ( $step )

Save step success.

Parameters

$step

Definition at line 211 of file ilProfileChecklistStatus.php.

    {
        $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();
    }