ilUIFilterServiceSessionGateway Class Reference

Session data handling for filter ui service. More...

Collaboration diagram for ilUIFilterServiceSessionGateway:

Public Member Functions
	__construct ()
	Constructor. More...
	writeValue (string $filter_id, string $input_id, $value)
	Write session value for an input field. More...
	getValue (string $filter_id, string $input_id)
	Get value. More...
	writeRendered (string $filter_id, string $input_id, bool $value)
	Write rendered information. More...
	isRendered (string $filter_id, string $input_id, bool $default)
	Is rendered status active? More...
	reset (string $filter_id)
	Resets filter to its default state. More...
	writeActivated (string $filter_id, bool $value)
	Write activation info of filter. More...
	writeExpanded (string $filter_id, bool $value)
	Write expand info of filter. More...
	isActivated (string $filter_id, bool $default)
	Is activated? More...
	isExpanded (string $filter_id, bool $default)
	Is expanded? More...

Data Fields
const	TYPE_VALUE = "value"
const	TYPE_RENDERED = "rendered"
const	TYPE_ACTIVATED = "activated"
const	TYPE_EXPANDED = "expanded"

Detailed Description

Session data handling for filter ui service.

Author

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

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

Constructor & Destructor Documentation

__construct()

ilUIFilterServiceSessionGateway::__construct

(

)

Constructor.

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

    {
    }

Member Function Documentation

getValue()

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

Get value.

Parameters

string	$filter_id
string	$input_id

Returns

mixed|null

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

References $_SESSION.

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

isActivated()

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

Is activated?

Parameters

string	$filter_id
bool	$default

Returns

bool

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

References $_SESSION.

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

isExpanded()

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

Is expanded?

Parameters

string	$filter_id
bool	$default

Returns

bool

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

References $_SESSION.

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

isRendered()

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

Is rendered status active?

Parameters

string	$filter_id
string	$input_id
bool	$default

Returns

bool

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

References $_SESSION.

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

reset()

ilUIFilterServiceSessionGateway::reset

(

string

$filter_id

)

Resets filter to its default state.

Parameters

string

$filter_id

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

References $_SESSION.

    {
        unset($_SESSION["ui"]["filter"][$filter_id]);
    }

writeActivated()

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

Write activation info of filter.

Parameters

string	$filter_id
bool	$value

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

References $_SESSION.

    {
        $_SESSION["ui"]["filter"][$filter_id][self::TYPE_ACTIVATED] = $value;
    }

writeExpanded()

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

Write expand info of filter.

Parameters

string	$filter_id
bool	$value

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

References $_SESSION.

    {
        $_SESSION["ui"]["filter"][$filter_id][self::TYPE_EXPANDED] = $value;
    }

writeRendered()

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

Write rendered information.

Parameters

string	$filter_id
string	$input_id
	$value

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

References $_SESSION.

    {
        $_SESSION["ui"]["filter"][$filter_id][self::TYPE_RENDERED][$input_id] = $value;
    }

writeValue()

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

Write session value for an input field.

Parameters

string	$filter_id
string	$input_id
	$value

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

References $_SESSION.

    {
        $value = serialize($value);
        $_SESSION["ui"]["filter"][$filter_id][self::TYPE_VALUE][$input_id] = $value;
    }

Field Documentation

TYPE_ACTIVATED

const ilUIFilterServiceSessionGateway::TYPE_ACTIVATED = "activated"

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

TYPE_EXPANDED

const ilUIFilterServiceSessionGateway::TYPE_EXPANDED = "expanded"

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

TYPE_RENDERED

const ilUIFilterServiceSessionGateway::TYPE_RENDERED = "rendered"

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

TYPE_VALUE

const ilUIFilterServiceSessionGateway::TYPE_VALUE = "value"

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

---

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

• Services/UI/classes/class.ilUIFilterServiceSessionGateway.php