slabphp/session-manager

SlabPHP Session Manager Library

SlabPHP Session Manager

This session management library was built because I liked the idea of "flash data", and I wanted a set of re-usable session handlers that I could alternatively use in the native session handling system. I wanted those handlers to be embedded in an encapsulated object that managed the lifecycle of the handler for me but also managed the concept of flash data transparently., _(*1)

Please see the main SlabPHP documentation for more information on the SlabPHP project., _(*2)

Installation

Include this library in your project, _(*3)

composer require slabphp/session-manager

Usage

General steps are to create a handler, instantiate a driver, use the driver to handle your sessions. The handlers themselves can be instantiated and then activated with just using the ->startNativeSession() method., _(*4)

File Handler Session

The file handler will use the built-in session save directory if you are using native session handling otherwise you may want do something like the following:, _(*5)

$handler = new \Slab\Session\Handlers\File();

$handler->setSavePath(ini_get('session.save_path'));

$driver = new \Slab\Session\Driver();

$driver
    ->setHandler($handler)
    ->start();

Database Handler Session

Assuming you have a mysqli object already open and created, you can feed it's reference into a database handler., _(*6)

$handler = new \Slab\Session\Handlers\Database\MySQL();

$handler->setDatabase($myMySQLiObject, 'databaseName', 'tableName', 'site.com');

$driver = new \Slab\Session\Driver();

$driver
    ->setHandler($handler)
    ->start();

Reading and Writing Data

Assuming you stored the session driver somewhere and have a reference to it called $session in the current object context:, _(*7)

// Will return a value if set, or false empty or not is set
$variableValue = $this->session->get('variableName');

Will retrieve the stored value. Otherwise you can set it with:, _(*8)

$this->session->set('variableName', 'some value');

You can delete data the data with ->delete()., _(*9)

Flash Data

Flash data is data that is set in a session and then deleted after the following request. You mark a variable as flash data by giving it an @ symbol as the first character., _(*10)

For example, if you are on a postback controller and you set a value with:, _(*11)

$this->session->set('@success', true);
$this->redirect('/thanks');

On the following page you could read this flash var but it won't persist for anything longer than that next request. So in your view controller you could do something like:, _(*12)

if ($this->session->get('@success')) $this->displaySuccessMessage();

Subsequent loads of that page will not have the @success var because it will be deleted., _(*13)