slim-session's Introduction

slim-session

Simple middleware for Slim Framework 3, that allows managing PHP built-in sessions and includes a Helper class to help you with the $_SESSION superglobal.

For the middleware version for Slim Framework 2, please check out the slim-2 branch in this repository.

Installation

Include this line in your composer.json:

"bryanjhv/slim-session": "~3.0"

Usage

$app = new \Slim\App;
$app->add(new \Slim\Middleware\Session([
  'name' => 'dummy_session',
  'autorefresh' => true,
  'lifetime' => '1 hour'
]));

Supported options

lifetime: How long a session can be. Defaults to 20 minutes (yes, you can pass anything that can be parsed by strtotime).
path, domain, secure, httponly: Options for the session cookie.
name: Name for the session cookie. Defaults to slim_session (instead of PHP's PHPSESSID).
autorefresh: Set this to true if you want the session to be refresh each time a user activity is made.

Session helper

This package also ships with a Helper class which you need to register in the container or instance as an object if you want to use it:

$container = $app->getContainer();

$container['session'] = function ($c) {
  return new \SlimSession\Helper;
};

This will provide you $app->session, so you can simply do:

$app->get('/', function () {
  $session = new \SlimSession\Helper; // or $this->session if registered

  // Get a variable
  $key = $session->get('key', 'default');
  $st = $session->st;

  // Set a variable
  $session->my_key = 'my_value';
  $app->session->set('a', 'var');

  // Remove variable
  $session->delete('a_var');

  // Destroy session
  $session::destroy();

  // Get current session id
  $id = $this->session::id();
});