xenokore/session

Simple Session handling library

1.2.0 2022-11-09 05:06 UTC

Requires

• php: >=7.3

Requires (Dev)

• phpunit/phpunit: ^9.0

MIT

• Yani B.

• session
• handler

README

A simple PHP session handler library with some extra features.

Installation

composer require xenokore/session

Usage

Load the $_SESSION variable in the constructor:

$session = new Xenokore\Session\Session($_SESSION);

You can access it as an array as if you're working directly with $_SESSION:

$session['test'] = 'hello';

var_dump($session['test']); // string(4) "test"

unset($session['test']);

You can also use the get() and set() methods:

// "name" will not be found so the default fallback will be used
var_dump( $session->get('name', 'unknown') ); // string(7) "unknown"

$session->set('name', 'yani'),

echo $session->get('name', 'unknown'); // string(4) "yani"

Another feature of this library is to remember a variable once using once() and getOnce(). This behaves like FlashMessages and can be used to pass one-time data between requests:

$session->once('error', 'failed to login');

// On a different request:
$error = $session->getOnce('error', null);

if($error){
    var_dump($error); // string(15) "failed to login"
}

$error = $session->getOnce('error', null);

var_dump($error); // null

getOnce() instantly removes the one-time variable from the session. You can also use getAllOnce() to get all one-time variables.