compwright / php-session
Standalone session implementation that does not rely on the PHP session module or the $_SESSION global, ideal for ReactPHP applications
Fund package maintenance!
compwright
Buymeacoffee.com
Installs: 5 393
Dependents: 0
Suggesters: 0
Security: 0
Stars: 16
Watchers: 3
Forks: 3
Open Issues: 0
Requires
- php: ^8.0 || ^8.1 || ^8.2
- dflydev/fig-cookies: ^3.0
- psr/http-message: ^1 || ^2
- psr/http-server-handler: ^1
- psr/http-server-middleware: ^1
- psr/simple-cache: ^1 || ^2 || ^3
Requires (Dev)
- behat/behat: ^3.13
- bramus/monolog-colored-line-formatter: ^3.0
- friendsofphp/php-cs-fixer: ^3.11
- kodus/file-cache: ^2
- league/flysystem: ^3.12
- matthiasmullie/scrapbook: ^1.4
- middlewares/access-log: ^2.0
- monolog/monolog: ^3.2
- php-di/php-di: ^7.0
- phpstan/phpstan: ^1.8
- phpunit/phpunit: ^10.5
- psr/log: ^2 || ^3
- slim/psr7: ^1.6
- slim/slim: ^4.11
Suggests
- ext-redis: Redis extension for PHP
- matthiasmullie/scrapbook: Scrapbook Cache provides excellent session storage options
README
A PHP session implementation that is single-process safe, compatible with PSR-7 and PSR-15, and does not rely on global variables ($_SESSION, $_COOKIE, etc).
This implementation is patterned after the built-in PHP session library, but is not a drop-in replacement for it. This library differs from the PHP session library in the following ways:
- Requires PHP 8+
- Fully object-oriented
- Strict mode is always on and cannot be disabled
- Auto-start and auto-shutdown are not supported
- Reading/writing cookie and cache headers is handled in middleware (included)
- Handlers implement the built-in PHP SessionHandlerInterface, but the PHP SessionHandler class will not work because it depends internally on the PHP session extension
- Session data is accessed using a Session object, not via $_SESSION
This library is ideal for single-process event loop-driven applications, using servers like ReactPHP.
Supported Features
- Array or Object Access
- Collision-Proof Secure ID Generation
- Data Persistance
- ID Regeneration
- Lockless Concurrency
- Garbage Collection
Installation
composer require compwright/php-session
Examples
Slim Framework
See tests/integration/server/App
To run with PHP Development Server:
$ composer run-script start-php
Basic Usage
$sessionFactory = new Compwright\PhpSession\Factory(); $manager = $sessionFactory->psr16Session( /** * @param Psr\SimpleCache\CacheInterface */ $cache, /** * @param array|Compwright\PhpSession\Config */ [ 'name' => 'my_app', 'sid_length' => 48, 'sid_bits_per_character' => 5, ] ); // Start the session $manager->id($sid); // Read $sid from request $started = $manager->start(); if ($started === false) { throw new RuntimeException("The session failed to start"); } // Read/write the current session $session = $manager->getCurrentSession(); $session["foo"] = "bar"; unset($session["bar"]); // Save and close the session $ended = $manager->write_close(); if ($ended === false) { throw new RuntimeException("The session failed to close properly, data may have been lost"); }