VuFind API Documentation

Container
in package

Class for treating a set of cookies as an object (inspired by \Laminas\Session\Container).

Tags
category

VuFind

author

Demian Katz demian.katz@villanova.edu

license

http://opensource.org/licenses/gpl-2.0.php GNU General Public License

link

Wiki

Table of Contents

$groupName  : string
Prefix to use for cookie values.
$manager  : CookieManager
Cookie manager.
__construct()  : mixed
Constructor
__get()  : void
Get the value of a variable in this object.
__isset()  : bool
Test the existence of a variable in this object.
__set()  : void
Set a variable in this object.
__unset()  : void
Unset a variable in this object.
getAllValues()  : array<string|int, mixed>
Get all values in the container as an associative array.

Properties

$groupName

Prefix to use for cookie values.

protected string $groupName

Methods

__construct()

Constructor

public __construct(string $groupName[, CookieManager $manager = null ]) : mixed
Parameters
$groupName : string

Prefix to use for cookie values.

$manager : CookieManager = null

Cookie manager.

Return values
mixed

__get()

Get the value of a variable in this object.

public & __get(string $var) : void
Parameters
$var : string

programmatic name of a key, in a <key,value> pair in the current container

Return values
void

__isset()

Test the existence of a variable in this object.

public __isset(string $var) : bool
Parameters
$var : string

programmatic name of a key, in a <key,value> pair in the current container

Return values
bool

__set()

Set a variable in this object.

public __set(string $var, string $value) : void
Parameters
$var : string

programmatic name of a key, in a <key,value> pair in the current container

$value : string

new value for the key

Return values
void

__unset()

Unset a variable in this object.

public __unset(string $var) : void
Parameters
$var : string

programmatic name of a key, in a <key,value> pair in the current groupName

Return values
void

getAllValues()

Get all values in the container as an associative array.

public getAllValues() : array<string|int, mixed>
Return values
array<string|int, mixed>

Search results