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

Collaboration diagram for ilUserSettingsConfig:

Public Member Functions
	__construct (?ilSetting $settings=null)

	isVisibleAndChangeable (string $field)
	Is field visible and changeable by user? More...

	isVisible (string $field)
	Is setting visible to user? More...

	isChangeable (string $field)
	Is setting changeable by user? More...

	setVisible (string $field, bool $visible)
	Set a profile field being visible. More...

	setChangeable (string $field, bool $changeable)
	Set a profile field being changeable. More...

Data Fields
const	HIDE_PREFIX = "usr_settings_hide_"

const	DISABLED_PREFIX = "usr_settings_disable_"

Protected Attributes
array	$setting

ilSetting	$settings

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 User settings configuration (what preferences can be visible/changed/...)

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

Definition at line 23 of file class.ilUserSettingsConfig.php.

Constructor & Destructor Documentation

◆ __construct()

ilUserSettingsConfig::__construct ( ?ilSetting $settings = null )

Definition at line 33 of file class.ilUserSettingsConfig.php.

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

       {
         global $DIC;
 
         $this->settings = (is_null($settings))
             ? $DIC->settings()
             : $settings;
         $this->setting = $this->settings->getAll();
     }

Here is the call graph for this function:

Member Function Documentation

◆ isChangeable()

ilUserSettingsConfig::isChangeable ( string $field )

Is setting changeable by user?

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

Referenced by ilUserFieldSettingsTableGUI\fillRow(), and isVisibleAndChangeable().

      : bool {
         return (!(isset($this->setting[self::DISABLED_PREFIX . $field]) &&
             $this->setting[self::DISABLED_PREFIX . $field] == 1));
     }

Here is the caller graph for this function:

◆ isVisible()

ilUserSettingsConfig::isVisible ( string $field )

Is setting visible to user?

Definition at line 56 of file class.ilUserSettingsConfig.php.

Referenced by ilUserFieldSettingsTableGUI\fillRow(), and isVisibleAndChangeable().

      : bool {
         return (!(isset($this->setting[self::HIDE_PREFIX . $field]) &&
             $this->setting[self::HIDE_PREFIX . $field] == 1));
     }

Here is the caller graph for this function:

◆ isVisibleAndChangeable()

ilUserSettingsConfig::isVisibleAndChangeable ( string $field )

Is field visible and changeable by user?

Definition at line 47 of file class.ilUserSettingsConfig.php.

References isChangeable(), and isVisible().

      : bool {
         return $this->isVisible($field) && $this->isChangeable($field);
     }

Here is the call graph for this function:

◆ setChangeable()

ilUserSettingsConfig::setChangeable	(	string	$field,
		bool	$changeable
	)

Set a profile field being changeable.

Definition at line 90 of file class.ilUserSettingsConfig.php.

References ILIAS\Repository\settings().

Referenced by ilObjUserFolderGUI\saveGlobalUserSettingsObject().

                                                                   : void
     {
         if (!$changeable) {
             $this->settings->set(self::DISABLED_PREFIX . $field, "1");
             $this->setting[self::DISABLED_PREFIX . $field] = 1;
         } else {
             $this->settings->delete(self::DISABLED_PREFIX . $field);
             unset($this->setting[self::DISABLED_PREFIX . $field]);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setVisible()

ilUserSettingsConfig::setVisible	(	string	$field,
		bool	$visible
	)

Set a profile field being visible.

Definition at line 76 of file class.ilUserSettingsConfig.php.

References ILIAS\Repository\settings().

Referenced by ilObjUserFolderGUI\saveGlobalUserSettingsObject().

                                                             : void
     {
         if (!$visible) {
             $this->settings->set(self::HIDE_PREFIX . $field, "1");
             $this->setting[self::HIDE_PREFIX . $field] = 1;
         } else {
             $this->settings->delete(self::HIDE_PREFIX . $field);
             unset($this->setting[self::HIDE_PREFIX . $field]);
         }
     }