https://github.com/compwright/php-session

Standalone session implementation that does not rely on the PHP session module or the $_SESSION global, ideal for Swoole or ReactPHP applications
https://github.com/compwright/php-session

psr-15 psr-7 reactphp sessions swoole

Last synced: 3 months ago
JSON representation

Standalone session implementation that does not rely on the PHP session module or the $_SESSION global, ideal for Swoole or ReactPHP applications

• Host: GitHub
• URL: https://github.com/compwright/php-session
• Owner: compwright
• License: mit
• Created: 2021-08-23T12:35:21.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-04-09T19:07:01.000Z (10 months ago)
• Last Synced: 2024-09-30T06:14:49.140Z (4 months ago)
• Topics: psr-15, psr-7, reactphp, sessions, swoole
• Language: PHP
• Homepage:
• Size: 222 KB
• Stars: 16
• Watchers: 3
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# Compwright\PhpSession

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](https://reactphp.org).

## Supported Features

* [Array or Object Access](features/access.feature)

* [Collision-Proof Secure ID Generation](features/id.feature)

* [Data Persistance](features/persistence.feature)

* [ID Regeneration](features/regeneration.feature)

* [Lockless Concurrency](features/concurrency.feature)

* [Garbage Collection](features/gc.feature)

## Installation

    composer require compwright/php-session

## Examples

### Slim Framework

See [tests/integration/server/App](tests/integration/server/App)

To run with PHP Development Server:

    $ composer run-script start-php

### Basic Usage

```php

$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");

}

```

## License

[MIT License](LICENSE)