README

ddrv/slim-session

PHP Library for work with sessions.

install

Run in console:

composer require ddrv/slim-session:^2.0

Include autoload file
```
require_once('vendor/autoload.php');
```

Integration in legacy code

For example, session cookie name used as sess_id.

Init storage and handler (for example, \Ddrv\Slim\Session\Storage\FileHandler, but it may be any implementation of \Ddrv\Slim\Session\Storage interface).
```
$storage = new Ddrv\Slim\Session\Storage\FileStorage('/path/to/sessions', 'sess_id');
$handler = new Ddrv\Slim\Session\Handler($storage);
```

Define session ID and start the session

/** @var Ddrv\Slim\Session\Handler $handler */
$sessionId = array_key_exists('sess_id', $_COOKIE) ? $_COOKIE['sess_id'] : $handler->generateId(); 
$session = $handler->read($sessionId);

// some logic

// When you need to update session ID do
$session->regenerate();

// some logic

if ($session->isNeedRegenerate()) {
    $handler->destroy($sessionId);
    $sessionId = $handler->generateId();
}

$handler->write($sessionId, $session); // store data to storage and close session
// add session cookie to response
setcookie('sess_id', $sessionId, time() + 86400, '/', '.example.com', false, true);

When you need to destroy the session do

/** @var string $sessionId */
/** @var Ddrv\Slim\Session\Handler $handler */
$handler->destroy($sessionId);
setcookie('sess_id', "", time() + 86400, '/', '.example.com', false, true);

Integration in PRS Frameworks

This package contains the Psr\Http\Server\MiddlewareInterface (PSR-15) implementation. See Ddrv\Slim\Session\Middleware\SessionMiddleware class.

Using

Use session as key-value storage

/** @var Ddrv\Slim\Session\Session $session */
$session->set('key1', 'value');
$session->set('key2', ['a', 'b', 'c']);
$value = $session->get('key1'); // 'value'
$value = $session->get('key1', 'default'); // 'value'
$value = $session->get('nonexistent-key'); // null
$value = $session->get('nonexistent-key', 'default'); // 'default'

Use a flash messages

/** @var Ddrv\Slim\Session\Session $session */
$session->flash('key1', 'value'); // 'key1' will be stored only for the current and the next request

// Current request
$session->has('key1');          // true
$value = $session->get('key1'); // 'value'

// Next request
$session->has('key1');          // true
$value = $session->get('key1'); // 'value'

// Other request
$session->has('key1');          // false
$value = $session->get('key1'); // null

Use a counters

/** @var Ddrv\Slim\Session\Session $session */
$session->increment('counter_1'); // 1
$session->increment('counter_1'); // 2
$session->increment('counter_1'); // 3
$session->increment('counter_1'); // 4
$session->increment('counter_1'); // 5
$session->decrement('counter_1'); // 4
$session->decrement('counter_1'); // 3
$session->decrement('counter_1'); // 2
$session->counter('counter_1');   // 2
$session->reset('counter_1');     // 0
$session->counter('counter_1');   // 0

Removing old sessions

Remove old sessions from storage from time to time.

/** @var Ddrv\Slim\Session\Handler $handler */
$handler->removeExpiredSessions(); // Delete sessions not used during the day

Encryption

You can use encryption for session data. Use Ddrv\Slim\Session\Handler\EncryptionHandlerDecorator for it (required openssl PHP extension).

/** @var Ddrv\Slim\Session\Storage $handler */
$cryptHandler = new Ddrv\Slim\Session\Storage\EncryptedStorageDecorator($handler, 'secret-key', 16);

ddrv / slim-session

Maintainers

Details