ilTablePropertiesStorage Class Reference

Saves (mostly asynchronously) user properties of tables (e.g. More...

Collaboration diagram for ilTablePropertiesStorage:

Public Member Functions
	__construct ()
	Constructor. More...
&	executeCommand ()
	execute command More...
	showFilter ()
	Show Filter. More...
	hideFilter ()
	Hide Filter. More...
	storeProperty ( $a_table_id, $a_user_id, $a_property, $a_value)
	Store property in session or db. More...
	getProperty ($a_table_id, $a_user_id, $a_property)
	Get property in session or db. More...
	isValidProperty ($a_property)
	Check if given property id is valid. More...

Data Fields
	$properties

Protected Attributes
	$user
	$ctrl
	$db

Detailed Description

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

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

Constructor & Destructor Documentation

__construct()

ilTablePropertiesStorage::__construct

(

)

Constructor.

Definition at line 31 of file class.ilTablePropertiesStorage.php.

References $DIC, and user().

    {
        global $DIC;

        $this->user = $DIC->user();
        $this->ctrl = $DIC->ctrl();
        $this->db = $DIC->database();
    }

Here is the call graph for this function:

Member Function Documentation

executeCommand()

& ilTablePropertiesStorage::executeCommand

(

)

execute command

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

References $ctrl, $ilUser, and $user.

    {
        $ilUser = $this->user;
        $ilCtrl = $this->ctrl;
        
        $cmd = $ilCtrl->getCmd();
        //              $next_class = $this->ctrl->getNextClass($this);

        $this->$cmd();
    }

getProperty()

ilTablePropertiesStorage::getProperty	(		$a_table_id,
			$a_user_id,
			$a_property
	)

Get property in session or db.

Definition at line 142 of file class.ilTablePropertiesStorage.php.

References $_SESSION, $db, $ilDB, ANONYMOUS_USER_ID, and isValidProperty().

    {
        $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 $_SESSION["table"][$a_table_id][$a_user_id][$a_property];
                break;
                
            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"];
                break;
        }
    }

Here is the call graph for this function:

hideFilter()

ilTablePropertiesStorage::hideFilter

(

)

Hide Filter.

Definition at line 85 of file class.ilTablePropertiesStorage.php.

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

    {
        $ilUser = $this->user;
        
        if ($_GET["user_id"] == $ilUser->getId()) {
            $this->storeProperty(
                $_GET["table_id"],
                $_GET["user_id"],
                "filter",
                0
            );
        }
    }

Here is the call graph for this function:

isValidProperty()

ilTablePropertiesStorage::isValidProperty

(

$a_property

)

Check if given property id is valid.

Parameters

string

$a_property

Returns

bool

Definition at line 179 of file class.ilTablePropertiesStorage.php.

Referenced by getProperty(), and storeProperty().

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

Here is the caller graph for this function:

showFilter()

ilTablePropertiesStorage::showFilter

(

)

Show Filter.

Definition at line 68 of file class.ilTablePropertiesStorage.php.

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

    {
        $ilUser = $this->user;
        
        if ($_GET["user_id"] == $ilUser->getId()) {
            $this->storeProperty(
                $_GET["table_id"],
                $_GET["user_id"],
                "filter",
                1
            );
        }
    }

Here is the call graph for this function:

storeProperty()

ilTablePropertiesStorage::storeProperty	(		$a_table_id,
			$a_user_id,
			$a_property,
			$a_value
	)

Store property in session or db.

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

References $_SESSION, $db, $ilDB, ANONYMOUS_USER_ID, and isValidProperty().

Referenced by hideFilter(), and showFilter().

      {
        $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":
                $_SESSION["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

ilTablePropertiesStorage::$ctrl

protected

Definition at line 20 of file class.ilTablePropertiesStorage.php.

Referenced by executeCommand().

$db

ilTablePropertiesStorage::$db

protected

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

Referenced by getProperty(), and storeProperty().

$properties

ilTablePropertiesStorage::$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")
        )

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

$user

ilTablePropertiesStorage::$user

protected

Definition at line 15 of file class.ilTablePropertiesStorage.php.

Referenced by executeCommand(), hideFilter(), and showFilter().

---

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

• Services/Table/classes/class.ilTablePropertiesStorage.php