ilUserFormSettings Class Reference

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

Collaboration diagram for ilUserFormSettings:

Public Member Functions
	__construct (string $a_id, ?int $a_user_id=null)
	hasStoredEntry ()
	Check if entry exist. More...
	set (array $a_data)
	reset ()
	enabled (string $a_option)
	Check if a specific option is enabled. More...
	getValue (string $a_option)
	Get value. More...
	setValue (string $a_option, $a_value)
	deleteValue (string $a_option)
	Delete value. More...
	valueExists (string $a_option)
	Does value exist in settings? More...
	store ()
	delete (bool $a_reset=true)
	Delete user related data. More...
	importFromForm (ilPropertyFormGUI $a_form)
	Import settings from form. More...
	exportToForm (ilPropertyFormGUI $a_form, bool $a_set_post=false)
	Export settings to form. More...

Static Public Member Functions
static	deleteAllForUser (int $a_user_id)
	Delete all settings for user id. More...
static	deleteAllForId (string $a_id)
	Delete for id. More...
static	deleteAllForPrefix (string $a_prefix)
	Delete all entries for prefix. More...

Protected Member Functions
	read ()

Protected Attributes
ilDBInterface	$db
int	$user_id
string	$id
array	$settings = array()

Private Attributes
bool	$has_stored_entry = false

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

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Definition at line 22 of file class.ilUserFormSettings.php.

Constructor & Destructor Documentation

__construct()

ilUserFormSettings::__construct	(	string	$a_id,
		?int	$a_user_id = null
	)

Definition at line 30 of file class.ilUserFormSettings.php.

References $DIC, $ilDB, $ilUser, ILIAS\Repository\int(), and read().

      {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        $ilUser = $DIC['ilUser'];

        $this->user_id = (int) $a_user_id;
        $this->id = $a_id;
        $this->db = $ilDB;

        if (!$this->user_id) {
            $this->user_id = $ilUser->getId();
        }

        $this->read();
    }

Here is the call graph for this function:

Member Function Documentation

delete()

ilUserFormSettings::delete

(

bool

$a_reset = true

)

Delete user related data.

Definition at line 150 of file class.ilUserFormSettings.php.

References $query, and reset().

                                                : void
    {
        $query = "DELETE FROM usr_form_settings" .
            " WHERE user_id = " . $this->db->quote($this->user_id, 'integer') .
            " AND id = " . $this->db->quote($this->id, 'text');
        $this->db->manipulate($query);

        if ($a_reset) {
            $this->reset();
        }
    }

Here is the call graph for this function:

deleteAllForId()

static ilUserFormSettings::deleteAllForId ( string  $a_id )

static

Delete for id.

Definition at line 178 of file class.ilUserFormSettings.php.

References $GLOBALS, and $query.

                                                       : void
    {
        $query = "DELETE FROM usr_form_settings" .
            " WHERE id = " . $GLOBALS['DIC']['ilDB']->quote($a_id, 'text');
        $GLOBALS['DIC']['ilDB']->manipulate($query);
    }

deleteAllForPrefix()

static ilUserFormSettings::deleteAllForPrefix ( string  $a_prefix )

static

Delete all entries for prefix.

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

References $GLOBALS, and $query.

Referenced by ilMemberExportSettingsGUI\savePrintViewSettings().

                                                               : void
    {
        $query = "DELETE FROM usr_form_settings " .
            'WHERE ' . $GLOBALS['DIC']['ilDB']->like('id', 'text', $a_prefix . '%');

        $GLOBALS['DIC']['ilDB']->manipulate($query);
    }

Here is the caller graph for this function:

deleteAllForUser()

static ilUserFormSettings::deleteAllForUser ( int  $a_user_id )

static

Delete all settings for user id.

Definition at line 165 of file class.ilUserFormSettings.php.

References $DIC, $ilDB, and $query.

                                                           : void
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        $query = "DELETE FROM usr_form_settings" .
            " WHERE user_id = " . $ilDB->quote($a_user_id, 'integer');
        $ilDB->manipulate($query);
    }

deleteValue()

ilUserFormSettings::deleteValue

(

string

$a_option

)

Delete value.

Definition at line 102 of file class.ilUserFormSettings.php.

References ILIAS\Repository\settings(), and valueExists().

                                                 : void
    {
        if ($this->valueExists($a_option)) {
            unset($this->settings[$a_option]);
        }
    }

Here is the call graph for this function:

enabled()

ilUserFormSettings::enabled

(

string

$a_option

)

Check if a specific option is enabled.

Definition at line 74 of file class.ilUserFormSettings.php.

References getValue().

                                             : bool
    {
        return (bool) $this->getValue($a_option);
    }

Here is the call graph for this function:

exportToForm()

ilUserFormSettings::exportToForm	(	ilPropertyFormGUI	$a_form,
		bool	$a_set_post = false
	)

Export settings to form.

Definition at line 229 of file class.ilUserFormSettings.php.

References ilPropertyFormGUI\getItems(), getValue(), IL_CAL_DATETIME, and valueExists().

     : void {
        foreach ($a_form->getItems() as $item) {
            if (method_exists($item, "getPostVar")) {
                $field = $item->getPostVar();

                if ($this->valueExists($field)) {
                    $value = $this->getValue($field);

                    if (method_exists($item, "setDate")) {
                        $date = new ilDateTime($value, IL_CAL_DATETIME);
                        $item->setDate($date);
                    } elseif (method_exists($item, "setChecked")) {
                        $item->setChecked((bool) $value);
                    } elseif (method_exists($item, "setValue")) {
                        $item->setValue($value);
                    }
                }
            }
        }
    }

Here is the call graph for this function:

getValue()

ilUserFormSettings::getValue

(

string

$a_option

)

Get value.

Returns

mixed

Definition at line 83 of file class.ilUserFormSettings.php.

References ILIAS\Repository\settings(), and valueExists().

Referenced by enabled(), and exportToForm().

    {
        if ($this->valueExists($a_option)) {
            return $this->settings[$a_option];
        }
        return null;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

hasStoredEntry()

ilUserFormSettings::hasStoredEntry

(

)

Check if entry exist.

Definition at line 53 of file class.ilUserFormSettings.php.

References $has_stored_entry.

                                    : bool
    {
        return $this->has_stored_entry;
    }

importFromForm()

ilUserFormSettings::importFromForm

(

ilPropertyFormGUI

$a_form

)

Import settings from form.

Definition at line 199 of file class.ilUserFormSettings.php.

References ilPropertyFormGUI\getItems(), IL_CAL_DATETIME, reset(), and setValue().

                                                             : void
    {
        $this->reset();
        $value = null;

        foreach ($a_form->getItems() as $item) {
            if (method_exists($item, "getPostVar")) {
                $field = $item->getPostVar();

                if (method_exists($item, "getDate")) {
                    $value = $item->getDate();
                    if ($value && !$value->isNull()) {
                        $value = $value->get(IL_CAL_DATETIME);
                    }
                } elseif (method_exists($item, "getChecked")) {
                    $value = $item->getChecked();
                } elseif (method_exists($item, "getMulti") && $item->getMulti()) {
                    $value = $item->getMultiValues();
                } elseif (method_exists($item, "getValue")) {
                    $value = $item->getValue();
                }

                $this->setValue($field, $value);
            }
        }
    }

Here is the call graph for this function:

read()

ilUserFormSettings::read ( )

protected

Definition at line 130 of file class.ilUserFormSettings.php.

References $query, $res, ilDBConstants\FETCHMODE_OBJECT, reset(), and ILIAS\Repository\settings().

Referenced by __construct().

                             : void
    {
        $query = "SELECT * FROM usr_form_settings" .
            " WHERE user_id = " . $this->db->quote($this->user_id, 'integer') .
            " AND id = " . $this->db->quote($this->id, 'text');
        $res = $this->db->query($query);

        if ($res->numRows()) {
            $this->has_stored_entry = true;
        }

        $this->reset();
        if ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $this->settings = unserialize($row->settings, ['allowed_classes' => false]);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

reset()

ilUserFormSettings::reset

(

)

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

References ILIAS\Repository\settings().

Referenced by delete(), importFromForm(), and read().

                           : void
    {
        $this->settings = array();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

set()

ilUserFormSettings::set

(

array

$a_data

)

Parameters

array

Array of Settings

Definition at line 61 of file class.ilUserFormSettings.php.

References ILIAS\Repository\settings().

                                      : void // Missing array type.
    {
        $this->settings = $a_data;
    }

Here is the call graph for this function:

setValue()

ilUserFormSettings::setValue	(	string	$a_option,
			$a_value
	)

Parameters

mixed

$a_value

Definition at line 94 of file class.ilUserFormSettings.php.

References ILIAS\Repository\settings().

Referenced by importFromForm().

                                                        : void
    {
        $this->settings[$a_option] = $a_value;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

store()

ilUserFormSettings::store

(

)

Definition at line 117 of file class.ilUserFormSettings.php.

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

                           : void
    {
        $this->delete(false);

        $query = "INSERT INTO usr_form_settings (user_id,id,settings) " .
            "VALUES( " .
                $this->db->quote($this->user_id, 'integer') . ", " .
                $this->db->quote($this->id, 'text') . ", " .
                $this->db->quote(serialize($this->settings), 'text') . " " .
            ")";
        $this->db->manipulate($query);
    }

Here is the call graph for this function:

valueExists()

ilUserFormSettings::valueExists

(

string

$a_option

)

Does value exist in settings?

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

References ILIAS\Repository\settings().

Referenced by deleteValue(), exportToForm(), and getValue().

                                                 : bool
    {
        return array_key_exists($a_option, $this->settings);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$db

ilDBInterface ilUserFormSettings::$db

protected

Definition at line 24 of file class.ilUserFormSettings.php.

$has_stored_entry

bool ilUserFormSettings::$has_stored_entry = false

private

Definition at line 28 of file class.ilUserFormSettings.php.

Referenced by hasStoredEntry().

$id

string ilUserFormSettings::$id

protected

Definition at line 26 of file class.ilUserFormSettings.php.

$settings

array ilUserFormSettings::$settings = array()

protected

Definition at line 27 of file class.ilUserFormSettings.php.

$user_id

int ilUserFormSettings::$user_id

protected

Definition at line 25 of file class.ilUserFormSettings.php.

---

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

• Services/User/classes/class.ilUserFormSettings.php