Skip to content

Session.md

Latest commit

 

History

History
103 lines (66 loc) · 2.09 KB

Session.md

File metadata and controls

103 lines (66 loc) · 2.09 KB

Session

\WebServCo\Framework\Libraries\Session

Implements \WebServCo\Framework\Interfaces\SessionInterface.

Instantiation

Framework

Both \WebServCo\Framework\AbstractController and \WebServCo\Framework\AbstractRepository contain the method session() which returns a single instance of the Session class.

This means you can use $this->session() in your Controller or Repository classes.

The Library is instantiated using the configuration file Session.php from your application's config directory.

To use the library in another place:

final public function session()
{
    return \WebServCo\Framework\Framework::getLibrary('Session');
}

Standalone instantiation

$session = new \WebServCo\Framework\Libraries\Session($configurationArray);

Starting the session

Note: session is not started in CLI mode.

In your Controller's __construct() method:

with custom storage directory (recommended):

$this->session()->start($storagePath);

with default PHP storage directory:

$this->session()->start();

Usage

Checking if a value exists in session

$result = $this->session()->has('user/name');

Setting a value

$this->session()->set($setting, $value);
$this->session()->set('user/name', 'Aria');

Adding a value to an already existing key

$this->session()->add($setting, $data);
$this->session()->add('user/settings', 'setting1');
$this->session()->add('user/settings', 'setting2');
$this->session()->add('user/settings', 'setting3');

Clearing a value

The key remains in session storage, however the value will be null.

$this->session()->clear($setting);
$this->session()->clear('user/name');

Removing a value

The key is deleted from session storage.

Use has() to check if the key exists before removing.

$this->session()->remove($setting);
$this->session()->remove('user/name');

Retrieving data

$this->session()->get($setting, $defaultValue = null);
$this->session()->get('user/name');
$this->session()->get('user/name', 'N/A');