User privacy settings (currently located under "Profile and Privacy") More...

Collaboration diagram for ilUserPrivacySettingsGUI:

Public Member Functions
	__construct ()
	constructor More...

	executeCommand ()
	execute command More...

	workWithUserSetting (string $setting)

	userSettingVisible (string $setting)

	showPrivacySettings ($form=null)
	General settings form. More...

	initPrivacySettingsForm ()
	Init form. More...

	savePrivacySettings ()
	Save privacy settings. More...

Protected Member Functions
	isAwarnessSettingVisible ()
	Is awareness tool setting visible. More...

	isContactSettingVisible ()
	Is contact setting visible. More...

Protected Attributes
	$lng

	$ctrl

	$main_tpl

	$user_settings_config

	$ui

	$user

	$settings

	$request

	$checklist_status

	$profile_mode

Detailed Description

User privacy settings (currently located under "Profile and Privacy")

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

Definition at line 10 of file class.ilUserPrivacySettingsGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilUserPrivacySettingsGUI::__construct ( )

constructor

Definition at line 66 of file class.ilUserPrivacySettingsGUI.php.

References $DIC, settings(), ui(), and user().

     {
         global $DIC;
 
         $this->main_tpl = $DIC->ui()->mainTemplate();
         $this->lng = $DIC->language();
         $this->ctrl = $DIC->ctrl();
         $this->lng->loadLanguageModule("user");
         $this->ui = $DIC->ui();
         $this->user = $DIC->user();
 
         $this->request = $DIC->http()->request();
 
         $this->user_settings_config = new ilUserSettingsConfig();
         $this->settings = $DIC->settings();
         $this->checklist_status = new ilProfileChecklistStatus();
         $this->profile_mode = new ilPersonalProfileMode($this->user, $this->settings);
     }

Here is the call graph for this function:

Member Function Documentation

◆ executeCommand()

ilUserPrivacySettingsGUI::executeCommand ( )

execute command

Definition at line 88 of file class.ilUserPrivacySettingsGUI.php.

     {
         $next_class = $this->ctrl->getNextClass();
 
         switch ($next_class) {
             default:
                 $cmd = $this->ctrl->getCmd("showPrivacySettings");
                 $this->$cmd();
                 break;
         }
         $this->main_tpl->printToStdout();
     }

◆ initPrivacySettingsForm()

ilUserPrivacySettingsGUI::initPrivacySettingsForm ( )

Init form.

Returns

Definition at line 188 of file class.ilUserPrivacySettingsGUI.php.

References $ctrl, Vendor\Package\$f, $lng, $settings, $ui, $user, isAwarnessSettingVisible(), isContactSettingVisible(), and settings().

Referenced by savePrivacySettings(), and showPrivacySettings().

     {
         $ui = $this->ui;
         $f = $ui->factory();
         $ctrl = $this->ctrl;
         $lng = $this->lng;
         $user = $this->user;
         $settings = $this->settings;
 
         $fields = [];
 
         // hide_own_online_status
         if ($this->isAwarnessSettingVisible()) {
             $lng->loadLanguageModule("awrn");
 
             $default = ($this->settings->get('hide_own_online_status') == "n")
                 ? $this->lng->txt("user_awrn_show")
                 : $this->lng->txt("user_awrn_hide");
 
             $options = array(
                 "x" => $this->lng->txt("user_awrn_default")." (".$default.")",
                 "n" => $this->lng->txt("user_awrn_show"),
                 "y" => $this->lng->txt("user_awrn_hide"));
             $val = $user->prefs["hide_own_online_status"];
             if ($val == "") {
                 $val = "x";
             }
             $fields["hide_own_online_status"] = $f->input()->field()->select(
                 $lng->txt("awrn_user_show"),
                 $options,
                 $lng->txt("awrn_hide_from_awareness_info"))
                 ->withValue($val)
                 ->withRequired(true)
                 ->withDisabled($settings->get("usr_settings_disable_hide_own_online_status")
                 );
         }
 
         // allow to contact me
         if ($this->isContactSettingVisible()) {
             $lng->loadLanguageModule('buddysystem');
             $fields["bs_allow_to_contact_me"] = $f->input()->field()->checkbox(
                 $lng->txt("buddy_allow_to_contact_me"),
                 $lng->txt("buddy_allow_to_contact_me_info")
             )
                 ->withValue($user->prefs['bs_allow_to_contact_me'] == 'y')
                 ->withDisabled($settings->get('usr_settings_disable_bs_allow_to_contact_me'));
         }
 
         // section
         $section1 = $f->input()->field()->section($fields, $lng->txt("user_visibility_settings"));
 
         $form_action = $ctrl->getLinkTarget($this, "savePrivacySettings");
         return $f->input()->container()->form()->standard($form_action, ["sec" => $section1]);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isAwarnessSettingVisible()

ilUserPrivacySettingsGUI::isAwarnessSettingVisible ( )

protected

Is awareness tool setting visible.

Returns: bool

Definition at line 161 of file class.ilUserPrivacySettingsGUI.php.

References userSettingVisible().

Referenced by initPrivacySettingsForm(), and savePrivacySettings().

                                                   : bool
     {
         $awrn_set = new ilSetting("awrn");
         if ($awrn_set->get("awrn_enabled", false) && $this->userSettingVisible("hide_own_online_status")) {
             return true;
         }
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isContactSettingVisible()

ilUserPrivacySettingsGUI::isContactSettingVisible ( )

protected

Is contact setting visible.

Returns: bool

Definition at line 175 of file class.ilUserPrivacySettingsGUI.php.

References ilBuddySystem\getInstance(), and userSettingVisible().

Referenced by initPrivacySettingsForm(), and savePrivacySettings().

                                                  : bool
     {
         if (ilBuddySystem::getInstance()->isEnabled() && $this->userSettingVisible('bs_allow_to_contact_me')) {
             return true;
         }
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ savePrivacySettings()

ilUserPrivacySettingsGUI::savePrivacySettings ( )

Save privacy settings.

Definition at line 246 of file class.ilUserPrivacySettingsGUI.php.

References $ctrl, $data, $lng, $request, $user, initPrivacySettingsForm(), isAwarnessSettingVisible(), isContactSettingVisible(), showPrivacySettings(), ilProfileChecklistStatus\STEP_VISIBILITY_OPTIONS, and workWithUserSetting().

     {
         $request = $this->request;
         $form = $this->initPrivacySettingsForm();
         $lng = $this->lng;
         $user = $this->user;
         $ctrl = $this->ctrl;
 
         if ($request->getMethod() == "POST") {
             $form = $form->withRequest($request);
             $data = $form->getData();
             if (is_array($data["sec"])) {
                 if ($this->isAwarnessSettingVisible() && $this->workWithUserSetting("hide_own_online_status")) {
                     $val = $data["sec"]["hide_own_online_status"];
                     if ($val == "x") {
                         $val = "";
                     }
                     $user->setPref("hide_own_online_status",
                         $val);
                 }
                 if ($this->isContactSettingVisible() && $this->workWithUserSetting("bs_allow_to_contact_me")) {
                     if ($data["sec"]["bs_allow_to_contact_me"]) {
                         $user->setPref("bs_allow_to_contact_me", "y");
                     } else {
                         $user->setPref("bs_allow_to_contact_me", "n");
                     }
                 }
                 $user->update();
                 $this->checklist_status->saveStepSucess(ilProfileChecklistStatus::STEP_VISIBILITY_OPTIONS);
                 ilUtil::sendSuccess($lng->txt("msg_obj_modified"), true);
                 $ctrl->redirect($this, "");
             }
         }
         $this->showPrivacySettings($form);
     }

Here is the call graph for this function:

◆ showPrivacySettings()

ilUserPrivacySettingsGUI::showPrivacySettings ( $form = null )

General settings form.

Definition at line 129 of file class.ilUserPrivacySettingsGUI.php.

References $lng, $main_tpl, $ui, $user, ilPublicUserProfileGUI\getEmbeddable(), and initPrivacySettingsForm().

Referenced by savePrivacySettings().

     {
         $main_tpl = $this->main_tpl;
         $ui = $this->ui;
         $user = $this->user;
         $lng = $this->lng;
 
         $html = "";
         if ($this->checklist_status->anyVisibilitySettings()) {
             if (is_null($form)) {
                 $form = $this->initPrivacySettingsForm();
             }
             $html = $ui->renderer()->render([$form]);
         }
 
         $pub_profile = new ilPublicUserProfileGUI($user->getId());
         if ($this->profile_mode->isEnabled()) {
             $html .= $pub_profile->getEmbeddable();
         } else {
             if (!$this->checklist_status->anyVisibilitySettings()) {
                 $html .= $ui->renderer()->render([$ui->factory()->messageBox()->info($lng->txt("usr_public_profile_disabled"))]);
             }
         }
 
         $main_tpl->setContent($html);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ userSettingVisible()

ilUserPrivacySettingsGUI::userSettingVisible ( string $setting )

Parameters

string $setting

Returns: bool

Definition at line 121 of file class.ilUserPrivacySettingsGUI.php.

Referenced by isAwarnessSettingVisible(), and isContactSettingVisible().

                                                         : bool
     {
         return $this->user_settings_config->isVisible($setting);
     }

Here is the caller graph for this function:

◆ workWithUserSetting()

ilUserPrivacySettingsGUI::workWithUserSetting ( string $setting )

Parameters

string $setting

Returns: bool

Definition at line 112 of file class.ilUserPrivacySettingsGUI.php.

Referenced by savePrivacySettings().

                                                          : bool
     {
         return $this->user_settings_config->isVisibleAndChangeable($setting);
     }

Here is the caller graph for this function: