Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jnessier/session
NOT MAINTAINED ANYMORE. Session service for Slim 4 and similar PSR-15 compliant frameworks and apps.
https://github.com/jnessier/session
middleware php73 psr-11 psr-15 session session-service slim slim-framework slim4
Last synced: 4 months ago
JSON representation
NOT MAINTAINED ANYMORE. Session service for Slim 4 and similar PSR-15 compliant frameworks and apps.
- Host: GitHub
- URL: https://github.com/jnessier/session
- Owner: jnessier
- License: mit
- Archived: true
- Created: 2020-07-09T20:17:30.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-06-12T09:20:52.000Z (over 1 year ago)
- Last Synced: 2024-09-28T19:42:42.832Z (4 months ago)
- Topics: middleware, php73, psr-11, psr-15, session, session-service, slim, slim-framework, slim4
- Language: PHP
- Homepage:
- Size: 183 KB
- Stars: 8
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# This project is no longer maintained.
Please use other solutions for session handling on PHP.
------------------------------------------------------------
# Session
[](https://travis-ci.org/Neoflow/Session)
[](https://coveralls.io/github/Neoflow/Session?branch=master)
[](https://packagist.org/packages/neoflow/session)
[](//packagist.org/packages/neoflow/session)
[](https://packagist.org/packages/neoflow/session)
Session service for Slim 4 and similar [PSR-15](https://www.php-fig.org/psr/psr-15/) compliant frameworks and apps.
## Table of Contents
- [Requirement](#requirement)
- [Installation](#installation)
- [Configuration](#configuration)
- [Usage](#usage)
- [Flash messages](#flash-messages)
- [Contributors](#contributors)
- [History](#history)
- [License](#license)
## Requirement
* PHP >= 7.3
## Installation
You have 2 options to install this library.
Via composer...
```bash
composer require neoflow/session
```
...or manually download the latest release from [here](https://github.com/Neoflow/Session/releases/).
## Configuration
The following instructions based on [Slim 4](http://www.slimframework.com), in combination with
[PHP-DI](https://php-di.org), but should be adaptable for any PSR-11/PSR-15 compliant frameworks and libraries.
Add the service `Neoflow\Session\Session` and middleware `Neoflow\Session\Middleware\SessionMiddleware`
to the container definitions...
```php
use Neoflow\Session\Session;
use Neoflow\Session\SessionInterface;
use Neoflow\Session\Middleware\SessionMiddleware;
use Psr\Container\ContainerInterface;
return [
// ...
SessionInterface::class => function () {
return new Session([ // Default session options
'name' => 'sid',
'autoRefresh' => true,
'cookie' => [
'lifetime' => 3600,
'path' => '/',
'domain' => null,
'secure' => false,
'httponly' => true,
'samesite' => 'Lax'
],
'iniSettings' => []
]);
},
SessionMiddleware::class => function (ContainerInterface $container) {
$session = $container->get(SessionInterface::class);
return new SessionMiddleware($session);
},
// ...
];
```
...and register the middleware, to autostart the session when it got dispatched.
```php
use Neoflow\Session\Middleware\SessionMiddleware;
$app->add(SessionMiddleware::class);
```
The service `Neoflow\Session\Session` supports the following options:
| Key | Type | Description | Default |
|---|---|---|---|
| `name` | string | Name of the session cookie. | `"sid"` |
| `autoRefresh` | bool | Refresh of session lifetime after each request. | `true` |
| `cookie['lifetime']` | int | Lifetime in seconds of the session cookie in seconds | `3600` |
| `cookie['path']` | string | Path to set in the session cookie | `"/"` |
| `cookie['domain']` | string/null | Domain to set in the session cookie | `null` |
| `cookie['secure']` | bool | Set `true` to sent session cookie only over secure connections | `false` |
| `cookie['httponly']` | bool | Set `false` to make session cookie accessible for scripting languages | `true` |
| `cookie['samesite']` | string | Set `"Strict"` to prevent the session cookie be sent along with cross-site requests | `"Lax"` |
| `iniSettings[]` | array | [PHP session settings](https://www.php.net/manual/en/session.configuration.php), without `session.` | `[]` |
When your DI container supports inflectors (e.g. [league/container](https://container.thephpleague.com/3.x/inflectors/)),
you can optionally register `Neoflow/Session/SessionAwareInterface` as inflector to your container definition.
Additionally, you can also use `Neoflow/Session/SessionAwareTrait` as a shorthand implementation of
`Neoflow/Session/SessionAwareInterface`.
## Usage
Examples how to handle the session:
```php
// Set session name.
$name = 'sid'; // Session name
$session = $session->setName($name);
// Set session cookie.
$session = $session->setCookie([
// Cookie options
]);
// Start session.
$started = $session->start();
// Get session status.
$status = $session->getStatus();
// Check whether session is started.
$isStarted = $session->isStarted();
// Generate new session id.
$id = $session->generateId();
// Get session cookie.
$cookie = $session->getCookie();
// Get session id.
$id = $session->getId();
// Get session name.
$name = $session->getName();
// Destroy session.
$destroyed = $session->destroy();
```
Examples how to access and manage the values of the session:
```php
// Get session value by key.
$default = null; // Default value, when key doesn't exists
$value = $session->getValue('key', $default);
// Set session value by key.
$overwrite = true; // Set FALSE to prevent overwrite existing value
$session = $session->setValue('key', 'value', $overwrite);
// Check whether session value exists by key.
$valueExists = $session->hasValue('key');
// Delete session value by key.
$session->deleteValue('key');
// Count number of session values.
$numberOfValues = $session->countValues();
// Get session values.
$values = $session->getValues();
// Clear session values.
$session = $session->clearValues();
// Replace session values by key. Existing values with similar keys will be overwritten.
$recursive = true; // Set TRUE to enable recursive replacement
$session = $session->replaceValues([
// Array with key/value pairs
], $recursive);
// Set session values. Existing values will be overwritten.
$session = $session->setValues([
// Array with key/value pairs
]);
```
## Flash messages
The first version of this library had built-in support for flash messages.
But to comply with the design principle of separation of concerns, the code of the flash messages was move into a
standalone library, called [Neoflow\FlashMessages](https://github.com/Neoflow/FlashMessages).
If you need support for flash messages, you can easily combine both libraries as composer packages.
The integration and usage of [Neoflow\FlashMessages](https://github.com/Neoflow/FlashMessages) is very similar to the
current library.
## Contributors
* Jonathan Nessier, [Neoflow](https://www.neoflow.ch)
If you would like to see this library develop further, or if you want to support me or show me your appreciation, please
donate any amount through PayPal. Thank you! :beers:
[](https://www.paypal.me/JonathanNessier)
## License
Licensed under [MIT](LICENSE).
*Made in Switzerland with :cheese: and :heart:*