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

Collaboration diagram for ilUIFilterServiceSessionGateway:

Public Member Functions
	writeValue (string $filter_id, string $input_id, $value)
	Write session value for an input field. More...

	getValue (string $filter_id, string $input_id)

	writeRendered (string $filter_id, string $input_id, bool $value)

	isRendered (string $filter_id, string $input_id, bool $default)

	reset (string $filter_id)
	Resets filter to its default state. More...

	writeActivated (string $filter_id, bool $value)

	writeExpanded (string $filter_id, bool $value)

	isActivated (string $filter_id, bool $default)

	isExpanded (string $filter_id, bool $default)

Data Fields
const	TYPE_VALUE = "value"

const	TYPE_RENDERED = "rendered"

const	TYPE_ACTIVATED = "activated"

const	TYPE_EXPANDED = "expanded"

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 Session data handling for filter ui service

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

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

Member Function Documentation

◆ getValue()

ilUIFilterServiceSessionGateway::getValue	(	string	$filter_id,
		string	$input_id
	)

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

References $session, and ilSession\get().

Referenced by UIFilterServiceSessionGatewayTest\testClear(), and UIFilterServiceSessionGatewayTest\testFilterInputValue().

     {
         $session = ilSession::get("ui");
         if (isset($session["filter"][$filter_id][self::TYPE_VALUE][$input_id])) {
             return unserialize($session["filter"][$filter_id][self::TYPE_VALUE][$input_id]);
         }
 
         return null;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isActivated()

ilUIFilterServiceSessionGateway::isActivated	(	string	$filter_id,
		bool	$default
	)

Definition at line 95 of file class.ilUIFilterServiceSessionGateway.php.

References $session, and ilSession\get().

Referenced by UIFilterServiceSessionGatewayTest\testClear(), and UIFilterServiceSessionGatewayTest\testFilterActivated().

                                                                  : bool
     {
         $session = ilSession::get("ui");
         if (isset($session["filter"][$filter_id][self::TYPE_ACTIVATED])) {
             return (bool) $session["filter"][$filter_id][self::TYPE_ACTIVATED];
         }
 
         return $default;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isExpanded()

ilUIFilterServiceSessionGateway::isExpanded	(	string	$filter_id,
		bool	$default
	)

Definition at line 105 of file class.ilUIFilterServiceSessionGateway.php.

References $session, and ilSession\get().

Referenced by UIFilterServiceSessionGatewayTest\testClear(), and UIFilterServiceSessionGatewayTest\testFilterExpanded().

                                                                 : bool
     {
         $session = ilSession::get("ui");
         if (isset($session["filter"][$filter_id][self::TYPE_EXPANDED])) {
             return (bool) $session["filter"][$filter_id][self::TYPE_EXPANDED];
         }
 
         return $default;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isRendered()

ilUIFilterServiceSessionGateway::isRendered	(	string	$filter_id,
		string	$input_id,
		bool	$default
	)

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

References $session, and ilSession\get().

Referenced by UIFilterServiceSessionGatewayTest\testClear(), and UIFilterServiceSessionGatewayTest\testFilterInputRendered().

                                                                                   : bool
     {
         $session = ilSession::get("ui");
         if (isset($session["filter"][$filter_id][self::TYPE_RENDERED][$input_id])) {
             return (bool) $session["filter"][$filter_id][self::TYPE_RENDERED][$input_id];
         }
 
         return $default;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ reset()

ilUIFilterServiceSessionGateway::reset ( string $filter_id )

Resets filter to its default state.

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

References $session, ilSession\get(), and ilSession\set().

Referenced by UIFilterServiceSessionGatewayTest\testClear().

                                             : void
     {
         $session = ilSession::get("ui");
         $session["filter"][$filter_id] = null;
         ilSession::set("ui", $session);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeActivated()

ilUIFilterServiceSessionGateway::writeActivated	(	string	$filter_id,
		bool	$value
	)

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

References $session, ilSession\get(), and ilSession\set().

Referenced by UIFilterServiceSessionGatewayTest\testClear(), and UIFilterServiceSessionGatewayTest\testFilterActivated().

                                                                   : void
     {
         $session = ilSession::get("ui");
         $session["filter"][$filter_id][self::TYPE_ACTIVATED] = $value;
         ilSession::set("ui", $session);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeExpanded()

ilUIFilterServiceSessionGateway::writeExpanded	(	string	$filter_id,
		bool	$value
	)

Definition at line 88 of file class.ilUIFilterServiceSessionGateway.php.

References $session, ilSession\get(), and ilSession\set().

Referenced by UIFilterServiceSessionGatewayTest\testClear(), and UIFilterServiceSessionGatewayTest\testFilterExpanded().

                                                                  : void
     {
         $session = ilSession::get("ui");
         $session["filter"][$filter_id][self::TYPE_EXPANDED] = $value;
         ilSession::set("ui", $session);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeRendered()

ilUIFilterServiceSessionGateway::writeRendered	(	string	$filter_id,
		string	$input_id,
		bool	$value
	)

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

References $session, ilSession\get(), and ilSession\set().

Referenced by UIFilterServiceSessionGatewayTest\testClear(), and UIFilterServiceSessionGatewayTest\testFilterInputRendered().

                                                                                    : void
     {
         $session = ilSession::get("ui");
         $session["filter"][$filter_id][self::TYPE_RENDERED][$input_id] = $value;
         ilSession::set("ui", $session);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeValue()

ilUIFilterServiceSessionGateway::writeValue	(	string	$filter_id,
		string	$input_id,
			$value
	)

Write session value for an input field.

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

References $session, ilSession\get(), and ilSession\set().

Referenced by UIFilterServiceSessionGatewayTest\testClear(), and UIFilterServiceSessionGatewayTest\testFilterInputValue().

                                                                            : void
     {
         $session = ilSession::get("ui");
         $value = serialize($value);
         $session["filter"][$filter_id][self::TYPE_VALUE][$input_id] = $value;
         ilSession::set("ui", $session);
     }