ilUserSettingsConfig Class Reference

User settings configuration (what preferences can be visible/changed/...) More...

Collaboration diagram for ilUserSettingsConfig:

Public Member Functions
	__construct (ilSetting $settings=null)
	Constructor. More...
	isVisibleAndChangeable ($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_"

Detailed Description

User settings configuration (what preferences can be visible/changed/...)

Author

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

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

Constructor & Destructor Documentation

__construct()

ilUserSettingsConfig::__construct

(

ilSetting

$settings = null

)

Constructor.

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

References $DIC, and 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?

Parameters

string

$field

Returns

bool

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

Referenced by 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?

Parameters

string

$field

Returns

bool

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

Referenced by 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

(

$field

)

Is field visible and changeable by user?

Parameters

$field

Returns

bool

Definition at line 33 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.

Parameters

string	$field
bool	$changeable

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

References settings().

    {
        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:

setVisible()

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

Set a profile field being visible.

Parameters

string	$field
bool	$visible

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

References settings().

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

Here is the call graph for this function:

Field Documentation

DISABLED_PREFIX

const ilUserSettingsConfig::DISABLED_PREFIX = "usr_settings_disable_"

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

HIDE_PREFIX

const ilUserSettingsConfig::HIDE_PREFIX = "usr_settings_hide_"

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

---

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

• Services/User/Settings/classes/class.ilUserSettingsConfig.php