Close search
Hoa

Hack book of Hoa\Session

Unfortunately, the documentation of this library has not been written yet. However, the README.md file may contain enough information to help you. This document is an extract of the README.md file.
Sorry for this inconvenience. Be ensured we are working hard to fix this.

Help on IRC Help on Gitter Documentation Board

This library allows to manipulate sessions easily by creating “namespaces”, i.e. an entry in the $_SESSION global variable. It also allows to manipulate flash sessions.

Each namespace has a profile. Amongst many things, it implies we can control lifetime of each namespace individually. This library can be used in conjunction of ext/session (especially to configure session).

Learn more.

Quick usage

We propose a quick overview of three usages: manipulating a namespace, expiration handling and destructing a namespace.

Manipulating a namespace

We will start a user namespace. If this namespace is empty, it implies two things: either the session is newly created or it has expired. In all cases, we print first time and save the current time in foo. And if the namespace is not empty, we print other times and dump the saved time. Thus:

$user = new Hoa\Session\Session('user');

if ($user->isEmpty()) {
    echo 'first time', "\n";
    $user['foo'] = time();
} else {
    echo 'other times', "\n";
    var_dump($user['foo']);
}

First execution will print first time and next ones will print other times followed by a timestamp.

No need to start the session, it will be done automatically. But if we want to, we can use the session_start function or the Hoa\Session\Session::start static method, which is more sophisticated.

Expiration handling

If a namespace expires before the session, either an event is fired on the channel hoa://Event/Session/<namespace>:expired or an exception Hoa\Session\Exception\Expired is thrown (if no callable listens the channel). We can test if the namespace is expired with the help of the Hoa\Session\Session::isExpired method or we can declare the namespace as expired with the help of the Hoa\Session\Session::hasExpired method (this method will throw an exception or fire an event).

Considering the previous example, we will declare the namespace as expired when the session is empty:

Hoa\Event\Event::getEvent('hoa://Event/Session/user:expired')
    ->attach(function (Hoa\Event\Bucket $bucket) {
        echo 'expired', "\n";
    });

$user = new Hoa\Session\Session('user');

if ($user->isEmpty()) {
    $user->hasExpired();
    echo 'first time', "\n";
    $user['foo'] = time();
} else {
    echo 'other times', "\n";
    var_dump($user['foo']);
}

First execution will print expired and first time, and next ones will print other times followed by a timestamp.

If an empty session does not imply an expiration (depending of our workflow and configuration), we could avoid the call to $user->hasExpired(): the test is automatically done during the construction of the namespace.

We can modify the lifetime by using the Hoa\Session\Session::rememberMe method; for example:

$user->rememberMe('+1 day');

And we can also forget the namespace:

$user->forgetMe();

Destructing a namespace

Destructing a namespace uses the Hoa\Session\Session::delete method:

$user = new Hoa\Session\Session('user');
$user['foo'] = 'bar';
$user->delete();

Stored data in the namespace are lost because we explicitly delete the namespace.

If we want to destroy the session (including all namespaces and cookie), we could use the Hoa\Session\Session::destroy static method. Again, no need to previously start the session manually if it is not done.

An error or a suggestion about the documentation? Contributions are welcome!

Comments

menu