hub20xx/session

A simple session class

0.2.0 2016-01-05 14:08 UTC

Requires (Dev)

• phpunit/phpunit: ^5.1

MIT

• hub20xx

• session
• flash

README

A simple session class.

Install

Via Composer

$ composer require hub20xxx/session

Usage

You can use the class to store / retrieve anything that can be stored in a php session.

// Forget about session_start():
//   - current session left alone if present
//   - new session started if no session present
$session = new \hub20xxx\Session\Session;

// Checking the existence of a session variable
$session->exists('variable'); // returns a boolean

// Setting session variables
$session->set('myString', 'stringy string');
$session->set('myArray', ['key' => 'value', 'otherKey' => 'otherValue']);
$session->set('myClass', new StdClass);

// Getting values of session variables
$mySessionString = $session->get('myString');
$mySessionArray = $session->get('myArray');
$mySessionClass = $session->get('myClass');

// Deleting session variables
$session->delete('myString');
$session->delete('myArray');
$session->delete('myClass');

// Flashing session variables
// 1. Setting the session variable (you can use the set method as well)
$session->flash('myFlashString', 'stringy string');
$session->flash('myFlashArray', ['key' => 'value', 'otherKey' => 'otherValue']);
$session->flash('myFlashClass', new StdClass);

// 2. Getting values of session variables and deleting them
$myFlashString = $session->flash('myFlashString');
$myFlashArray = $session->flash('myFlashArray');
$myFlashClass = $session->flash('myFlashClass');

Testing

$ phpunit

License

MIT

Credits / Thanks

This package was inpired (among others) by:

• the Codecourse's tutorial on creating an OOP Login/Register System and especially this video and this video
• the SlimFlash package

Many thanks to them :)

Contributing

If you'd like to contribute, please use Github (issues, pull requests etc).