Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ddrv/php-slim-session
PHP session
https://github.com/ddrv/php-slim-session
Last synced: 3 days ago
JSON representation
PHP session
- Host: GitHub
- URL: https://github.com/ddrv/php-slim-session
- Owner: ddrv
- License: mit
- Created: 2020-04-20T16:55:33.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-12-25T11:05:54.000Z (almost 4 years ago)
- Last Synced: 2024-04-18T18:44:57.420Z (7 months ago)
- Language: PHP
- Size: 32.2 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://packagist.org/packages/ddrv/slim-session)
[](https://packagist.org/packages/ddrv/slim-session/stats)
[](https://github.com/ddrv/slim-session/blob/master/LICENSE)
[](https://php.net)
# ddrv/slim-session
PHP Library for work with sessions.
## install
1. Run in console:
```text
composer require ddrv/slim-session:^2.0
```
1. Include autoload file
```php
require_once('vendor/autoload.php');
```
## Integration in legacy code
> For example, session cookie name used as `sess_id`.
1. Init storage and handler (for example, `\Ddrv\Slim\Session\Storage\FileHandler`, but it may be any implementation of `\Ddrv\Slim\Session\Storage` interface).
```php
$storage = new Ddrv\Slim\Session\Storage\FileStorage('/path/to/sessions', 'sess_id');
$handler = new Ddrv\Slim\Session\Handler($storage);
```
1. Define session ID and start the session
```php
/** @var Ddrv\Slim\Session\Handler $handler */
$sessionId = array_key_exists('sess_id', $_COOKIE) ? $_COOKIE['sess_id'] : $handler->generateId();
$session = $handler->read($sessionId);
// some logic
// When you need to update session ID do
$session->regenerate();
// some logic
if ($session->isNeedRegenerate()) {
$handler->destroy($sessionId);
$sessionId = $handler->generateId();
}
$handler->write($sessionId, $session); // store data to storage and close session
// add session cookie to response
setcookie('sess_id', $sessionId, time() + 86400, '/', '.example.com', false, true);
```
1. When you need to destroy the session do
```php
/** @var string $sessionId */
/** @var Ddrv\Slim\Session\Handler $handler */
$handler->destroy($sessionId);
setcookie('sess_id', "", time() + 86400, '/', '.example.com', false, true);
```
## Integration in PRS Frameworks
This package contains the `Psr\Http\Server\MiddlewareInterface` (`PSR-15`) implementation. See `Ddrv\Slim\Session\Middleware\SessionMiddleware` class.
## Using
### Use session as key-value storage
```php
/** @var Ddrv\Slim\Session\Session $session */
$session->set('key1', 'value');
$session->set('key2', ['a', 'b', 'c']);
$value = $session->get('key1'); // 'value'
$value = $session->get('key1', 'default'); // 'value'
$value = $session->get('nonexistent-key'); // null
$value = $session->get('nonexistent-key', 'default'); // 'default'
```
### Use a flash messages
```php
/** @var Ddrv\Slim\Session\Session $session */
$session->flash('key1', 'value'); // 'key1' will be stored only for the current and the next request
// Current request
$session->has('key1'); // true
$value = $session->get('key1'); // 'value'
// Next request
$session->has('key1'); // true
$value = $session->get('key1'); // 'value'
// Other request
$session->has('key1'); // false
$value = $session->get('key1'); // null
```
### Use a counters
```php
/** @var Ddrv\Slim\Session\Session $session */
$session->increment('counter_1'); // 1
$session->increment('counter_1'); // 2
$session->increment('counter_1'); // 3
$session->increment('counter_1'); // 4
$session->increment('counter_1'); // 5
$session->decrement('counter_1'); // 4
$session->decrement('counter_1'); // 3
$session->decrement('counter_1'); // 2
$session->counter('counter_1'); // 2
$session->reset('counter_1'); // 0
$session->counter('counter_1'); // 0
```
## Removing old sessions
Remove old sessions from storage from time to time.
```php
/** @var Ddrv\Slim\Session\Handler $handler */
$handler->removeExpiredSessions(); // Delete sessions not used during the day
```
## Encryption
You can use encryption for session data. Use `Ddrv\Slim\Session\Handler\EncryptionHandlerDecorator` for it (required `openssl` PHP extension).
```php
/** @var Ddrv\Slim\Session\Storage $handler */
$cryptHandler = new Ddrv\Slim\Session\Storage\EncryptedStorageDecorator($handler, 'secret-key', 16);
```