Collaboration diagram for ilUserFormSettings:

Public Member Functions
	__construct ($a_id, $a_user_id=null)
	Constructor. More...

	hasStoredEntry ()
	Check if entry exist. More...

	set ($a_data)
	Set Settings. More...

	reset ()
	Remove all settings (internally) More...

	enabled ($a_option)
	Check if a specific option is enabled. More...

	getValue ($a_option)
	Get value. More...

	setValue ($a_option, $a_value)
	Set value. More...

	deleteValue ($a_option)
	Delete value. More...

	valueExists ($a_option)
	Does value exist in settings? More...

	store ()
	Store settings in DB. More...

	delete ($a_reset=true)
	Delete user related data. More...

	importFromForm (ilPropertyFormGUI $a_form)
	Import settings from form. More...

	exportToForm (ilPropertyFormGUI $a_form, $a_set_post=false)
	Export settings from form. More...

Static Public Member Functions
static	deleteAllForUser ($a_user_id)
	Delete all settings for user id. More...

static	deleteAllForId ($a_id)
	Delete for id. More...

static	deleteAllForPrefix ($a_prefix)
	Delete all entries for prefix. More...

Protected Member Functions
	read ()
	Read store settings. More...

Protected Attributes
	$db

	$user_id

	$id

	$settings = array()

Private Attributes
	$has_stored_entry = false

Detailed Description

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

Version: $Id$

/

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

Constructor & Destructor Documentation

◆ __construct()

ilUserFormSettings::__construct	(	$a_id,
		$a_user_id = `null`
	)

Constructor.

Parameters

int	$a_user_id
int	$a_id

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

References $ilDB, $ilUser, read(), and string.

     {
         global $ilDB, $ilUser;
         
         $this->user_id = (int) $a_user_id;
         $this->id = (string) $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 ( $a_reset = true )

Delete user related data.

Parameters

bool $a_reset

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

References $query, and reset().

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

static

Delete for id.

Parameters

string $a_id

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

References $GLOBALS, and $query.

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

◆ deleteAllForPrefix()

static ilUserFormSettings::deleteAllForPrefix ( $a_prefix )

static

Delete all entries for prefix.

Parameters

type $a_prefix

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

References $GLOBALS, and $query.

Referenced by ilMemberExportSettingsGUI\savePrintViewSettings().

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

Here is the caller graph for this function:

◆ deleteAllForUser()

static ilUserFormSettings::deleteAllForUser ( $a_user_id )

static

Delete all settings for user id.

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

References $ilDB, and $query.

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

◆ deleteValue()

ilUserFormSettings::deleteValue ( $a_option )

Delete value.

Parameters

string $a_option

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

References settings(), and valueExists().

Referenced by ilAttendanceList\initForm().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ enabled()

ilUserFormSettings::enabled ( $a_option )

Check if a specific option is enabled.

Parameters

string $a_option

Returns: bool

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

References getValue().

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

Here is the call graph for this function:

◆ exportToForm()

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

Export settings from form.

Parameters

ilPropertyFormGUI $a_form

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

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

     {
         foreach ($a_form->getItems() as $item) {
             if (method_exists($item, "getPostVar")) {
                 $field = $item->getPostVar();
                 
                 if ($this->valueExists($field)) {
                     $value = $this->getValue($field);
                     if ($a_set_post) {
                         $_POST[$item->getPostVar()] = $value;
                     }
 
                     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 ( $a_option )

Get value.

Parameters

string $a_option

Returns: mixed

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

References settings(), and valueExists().

Referenced by enabled(), and exportToForm().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasStoredEntry()

ilUserFormSettings::hasStoredEntry ( )

Check if entry exist.

Returns: type

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

References $has_stored_entry.

     {
         return $this->has_stored_entry;
     }

◆ importFromForm()

ilUserFormSettings::importFromForm ( ilPropertyFormGUI $a_form )

Import settings from form.

Parameters

ilPropertyFormGUI $a_form

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

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

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

Read store settings.

private

Parameters

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

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

Referenced by __construct().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ reset()

ilUserFormSettings::reset ( )

Remove all settings (internally)

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

References array, and settings().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ set()

ilUserFormSettings::set ( $a_data )

Set Settings.

Parameters

array Array of Settings

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

References settings().

     {
         $this->settings = $a_data;
     }

Here is the call graph for this function:

◆ setValue()

ilUserFormSettings::setValue	(	$a_option,
		$a_value
	)

Set value.

Parameters

string	$a_option
mmixed	$a_value

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

References settings().

Referenced by importFromForm().

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

Store settings in DB.

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

References $query, and settings().

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

Does value exist in settings?

Parameters

string $a_option

Returns: bool

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

References array, and settings().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $db

ilUserFormSettings::$db

protected

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

◆ $has_stored_entry

ilUserFormSettings::$has_stored_entry = false

private

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

Referenced by hasStoredEntry().

◆ $id

ilUserFormSettings::$id

protected

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

◆ $settings

ilUserFormSettings::$settings = array()

protected

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

◆ $user_id

ilUserFormSettings::$user_id

protected

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

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

Services/User/classes/class.ilUserFormSettings.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ delete()

◆ deleteAllForId()

◆ deleteAllForPrefix()

◆ deleteAllForUser()

◆ deleteValue()

◆ enabled()

◆ exportToForm()

◆ getValue()

◆ hasStoredEntry()

◆ importFromForm()

◆ read()

◆ reset()

◆ set()

◆ setValue()

◆ store()

◆ valueExists()

Field Documentation

◆ $db

◆ $has_stored_entry

◆ $id

◆ $settings

◆ $user_id