W3cubDocs

/Phalcon 3

Class Phalcon\Session\Bag

implements Phalcon\Di\InjectionAwareInterface, Phalcon\Session\BagInterface, IteratorAggregate, Traversable, ArrayAccess, Countable

Source on GitHub

This component helps to separate session data into “namespaces”. Working by this way you can easily create groups of session variables into the application

$user = new \Phalcon\Session\Bag("user");

$user->name = "Kimbra Johnson";
$user->age  = 22;

Methods

public __construct (mixed $name)

Phalcon\Session\Bag constructor

public setDI (Phalcon\DiInterface $dependencyInjector)

Sets the DependencyInjector container

public getDI ()

Returns the DependencyInjector container

public initialize ()

Initializes the session bag. This method must not be called directly, the class calls it when its internal data is accessed

public destroy ()

Destroys the session bag

$user->destroy();

public set (mixed $property, mixed $value)

Sets a value in the session bag

$user->set("name", "Kimbra");

public __set (mixed $property, mixed $value)

Magic setter to assign values to the session bag

$user->name = "Kimbra";

public get (mixed $property, [mixed $defaultValue])

Obtains a value from the session bag optionally setting a default value

echo $user->get("name", "Kimbra");

public __get (mixed $property)

Magic getter to obtain values from the session bag

echo $user->name;

public has (mixed $property)

Check whether a property is defined in the internal bag

var_dump(
    $user->has("name")
);

public __isset (mixed $property)

Magic isset to check whether a property is defined in the bag

var_dump(
    isset($user["name"])
);

public remove (mixed $property)

Removes a property from the internal bag

$user->remove("name");

public __unset (mixed $property)

Magic unset to remove items using the array syntax

unset($user["name"]);

final public count ()

Return length of bag

echo $user->count();

final public getIterator ()

Returns the bag iterator

final public offsetSet (mixed $property, mixed $value)

...

final public offsetExists (mixed $property)

...

final public offsetUnset (mixed $property)

...

final public offsetGet (mixed $property)

...

© 2011–2017 Phalcon Framework Team
Licensed under the Creative Commons Attribution License 3.0.
https://docs.phalconphp.com/en/latest/api/Phalcon_Session_Bag.html