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

Inheritance diagram for ilTablePropertiesStorageGUI:

Collaboration diagram for ilTablePropertiesStorageGUI:

Public Member Functions
	__construct ()

	executeCommand ()

	showFilter ()

	hideFilter ()

	storeProperty (string $a_table_id, int $a_user_id, string $a_property, string $a_value)

	getProperty (string $a_table_id, int $a_user_id, string $a_property)

	isValidProperty ($a_property)

Data Fields
array	$properties

Protected Attributes
ILIAS Table TableGUIRequest	$table_request = null

ilObjUser	$user

ilCtrl	$ctrl

ilDBInterface	$db

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 Saves (mostly asynchronously) user properties of tables (e.g. filter on/off)

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

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

Constructor & Destructor Documentation

◆ __construct()

ilTablePropertiesStorageGUI::__construct ( )

Definition at line 40 of file class.ilTablePropertiesStorageGUI.php.

References $DIC, ILIAS\Repository\ctrl(), and ILIAS\Repository\user().

     {
         global $DIC;
 
         $this->user = $DIC->user();
         $this->ctrl = $DIC->ctrl();
         $this->db = $DIC->database();
         if (isset($DIC["http"])) {
             $this->table_request = new \ILIAS\Table\TableGUIRequest(
                 $DIC->http(),
                 $DIC->refinery()
             );
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ executeCommand()

ilTablePropertiesStorageGUI::executeCommand ( )

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

References $ctrl, and ilCtrl\getCmd().

                                     : void
     {
         $ilCtrl = $this->ctrl;
         $cmd = $ilCtrl->getCmd();
         $this->$cmd();
     }

Here is the call graph for this function:

◆ getProperty()

ilTablePropertiesStorageGUI::getProperty	(	string	$a_table_id,
		int	$a_user_id,
		string	$a_property
	)

Definition at line 131 of file class.ilTablePropertiesStorageGUI.php.

References $db, $ilDB, ANONYMOUS_USER_ID, ilSession\get(), and isValidProperty().

      : string {
         $ilDB = $this->db;
 
         if ($a_table_id == "" || !$this->isValidProperty($a_property)) {
             return "";
         }
 
         $storage = $this->properties[$a_property]["storage"];
         if ($a_user_id == ANONYMOUS_USER_ID) {
             $storage = "session";
         }
 
         switch ($storage) {
             case "session":
                 return ilSession::get("table_" . $a_table_id . "_" . $a_user_id . "_" . $a_property) ?? "";
 
             case "db":
                 $set = $ilDB->query(
                     $q = "SELECT value FROM table_properties " .
                     " WHERE table_id = " . $ilDB->quote($a_table_id, "text") .
                     " AND user_id = " . $ilDB->quote($a_user_id, "integer") .
                     " AND property = " . $ilDB->quote($a_property, "text")
                 );
                 $rec = $ilDB->fetchAssoc($set);
                 return $rec["value"] ?? '';
         }
         return "";
     }

Here is the call graph for this function:

◆ hideFilter()

ilTablePropertiesStorageGUI::hideFilter ( )

Definition at line 80 of file class.ilTablePropertiesStorageGUI.php.

References $ilUser, $requested_user_id, $user, and storeProperty().

                                 : void
     {
         $ilUser = $this->user;
 
         $requested_user_id = $this->table_request->getUserId();
         $requested_table_id = $this->table_request->getTableId();
         if ($requested_user_id == $ilUser->getId()) {
             $this->storeProperty(
                 $requested_table_id,
                 $requested_user_id,
                 "filter",
                 0
             );
         }
     }

Here is the call graph for this function:

◆ isValidProperty()

ilTablePropertiesStorageGUI::isValidProperty ( $a_property )

Definition at line 168 of file class.ilTablePropertiesStorageGUI.php.

Referenced by getProperty(), and storeProperty().

                                                 : bool
     {
         if (array_key_exists($a_property, $this->properties)) {
             return true;
         }
         return false;
     }

Here is the caller graph for this function:

◆ showFilter()

ilTablePropertiesStorageGUI::showFilter ( )

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

References $ilUser, $requested_user_id, $user, and storeProperty().

                                 : void
     {
         $ilUser = $this->user;
 
         $requested_user_id = $this->table_request->getUserId();
         $requested_table_id = $this->table_request->getTableId();
 
         if ($requested_user_id == $ilUser->getId()) {
             $this->storeProperty(
                 $requested_table_id,
                 $requested_user_id,
                 "filter",
                 1
             );
         }
     }

Here is the call graph for this function:

◆ storeProperty()

ilTablePropertiesStorageGUI::storeProperty	(	string	$a_table_id,
		int	$a_user_id,
		string	$a_property,
		string	$a_value
	)

Definition at line 96 of file class.ilTablePropertiesStorageGUI.php.

References $db, $ilDB, ANONYMOUS_USER_ID, isValidProperty(), and ilSession\set().

Referenced by hideFilter(), and showFilter().

      : void {
         $ilDB = $this->db;
 
         if ($a_table_id == "" || !$this->isValidProperty($a_property)) {
             return;
         }
 
         $storage = $this->properties[$a_property]["storage"];
         if ($a_user_id == ANONYMOUS_USER_ID) {
             $storage = "session";
         }
         switch ($storage) {
             case "session":
                 ilSession::set("table_" . $a_table_id . "_" . $a_user_id . "_" . $a_property, $a_value);
                 break;
 
             case "db":
                 $ilDB->replace(
                     "table_properties",
                     array(
                     "table_id" => array("text", $a_table_id),
                     "user_id" => array("integer", $a_user_id),
                     "property" => array("text", $a_property)),
                     array(
                     "value" => array("text", $a_value)
                     )
                 );
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $ctrl

ilCtrl ilTablePropertiesStorageGUI::$ctrl

protected

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

Referenced by executeCommand().

◆ $db

ilDBInterface ilTablePropertiesStorageGUI::$db

protected

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

Referenced by getProperty(), and storeProperty().

◆ $properties

array ilTablePropertiesStorageGUI::$properties

Initial value:

= array(
        "filter" => array("storage" => "db"),
        "direction" => array("storage" => "db"),
        "order" => array("storage" => "db"),
        "rows" => array("storage" => "db"),
        "offset" => array("storage" => "session"),
        "selfields" => array("storage" => "db"),
        "selfilters" => array("storage" => "db"),
        "filter_values" => array("storage" => "db")
    )