antonkalmykov/session-muscle

Session provider component for ITCourses Jazz Framework

v1.0.0 2016-02-16 13:18 UTC

Requires

• php: >=5.5.9

MIT

• Anton Kalmykov

README

Session provider component for ITCourses Jazz Framework

How to use:

Every time when there is a request to the server, SessionMuscle will start session automatically. To modify or save current session data use SessionMuscle API methods. Under session type understood long-term session or short-term session. By default, all sessions are short-term. The duration of the sessions, you can specify in the session settings. Depending of the session type, session essentially will end on short or long postfix. For example:

63073ae80b786fdc21bb7616a54d25615e6c8f28short - name of short session

or 27s45ae80b987fsc22bs4576v54d25615w6c8f28long - name of long session

Garbage collector will start automatically, depending of 'runRate' session setting and session lifetime types.

NOTE: session repository must have read/write permissions.

First of all, create an array of settings for SessionMuscle component:

// settings array
$settings = [
    // cookie name which will store the session id
    'cookieName' => 'sess',
    // session entity to record logs
    'sessLogName' => '.sesslog',
    // session repository in this case be folder,
    // generally it can be any
    'repository' => 'storage/sessions',
    // through a gap to run the garbage collector
    'runRate' => 10,
    // short session lifetime in seconds
    'short' => 60,
    // long session lifetime in seconds
    'long' => 120
];

Then, create adapter which will be responsible for maintaining sessions (in this example, this is adapter who stored sessions into files):

use SessionMuscle\Adapters\FileAdapter;
$adapter = new FileAdapter();

And now you can create session instance, first argument is session adapter instance, second - session settings:

use SessionMuscle\Session;
$session = new Session($adapter, $settings);

SessionMuscle API

Retrieve all data from the session:

$session->all(); // return array of session data

Retrieve a value from the session. You may also pass a default value as the second argument to this method. This default value will be returned if the specified key does not exist in the session:

$session->get($key, $default = ''); // return session data or default value

Add new data to current session:

$session->put($key, $value); // return true on success

Check if an item exists in the session:

$session->has($key); // return true if key exists or false if no

Retrieve a value from the session, and then delete it. You may also pass a default value as the second argument to this method. This default value will be returned if the specified key does not exist in the session:

$session->pull($key, $default = ''); // return session data or default value.

Remove a piece of data from the session by given key:

$session->delete($key, $default = ''); // true on successful removal or false if no

To get current session ID with session type (if exists), use:

$session->getSessID(); // current session ID with session type

To get current repository, use:

$session->getRepository();

To get current session cookie name, use:

$session->getCookieName();

To get used session types, use:

$session->getSessionTypes(); // return array of session types

To get current session type, use:

$session->getSessionType(); // return current session type

To set type of current session, use:

$session->setSessionType($sessionType);

To get current session settings, use:

$session->getSessionSettings(); // return current session settings array

To save current session, use:

$session->save();

To regenerate current session, use:

$session->regenerate();

To completely remove current session, use:

$session->clear();