Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/middlewares/aura-session
PSR-15 middleware to manage sessions using Aura.Session
https://github.com/middlewares/aura-session
aura-session http middleware psr-15 session
Last synced: about 1 month ago
JSON representation
PSR-15 middleware to manage sessions using Aura.Session
- Host: GitHub
- URL: https://github.com/middlewares/aura-session
- Owner: middlewares
- License: mit
- Created: 2016-10-08T10:21:14.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2021-10-29T16:12:28.000Z (about 3 years ago)
- Last Synced: 2024-11-09T02:19:17.565Z (about 1 month ago)
- Topics: aura-session, http, middleware, psr-15, session
- Language: PHP
- Size: 24.4 KB
- Stars: 6
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-psr15-middlewares - middlewares/aura-session - Manage sessions using [Aura.Session](https://github.com/auraphp/Aura.Session). (Packages / Manage States)
README
# middlewares/aura-session
[![Latest Version on Packagist][ico-version]][link-packagist]
[![Software License][ico-license]](LICENSE)
![Testing][ico-ga]
[![Total Downloads][ico-downloads]][link-downloads]
[![SensioLabs Insight][ico-sensiolabs]][link-sensiolabs]
Middleware to manage sessions using [Aura.Session](https://github.com/auraphp/Aura.Session).
## Requirements
* PHP >= 7.0
* A [PSR-7](https://packagist.org/providers/psr/http-message-implementation) http message implementation ([Diactoros](https://github.com/zendframework/zend-diactoros), [Guzzle](https://github.com/guzzle/psr7), [Slim](https://github.com/slimphp/Slim), etc...)
* A [PSR-15 middleware dispatcher](https://github.com/middlewares/awesome-psr15-middlewares#dispatcher)
## Installation
This package is installable and autoloadable via Composer as [middlewares/aura-session](https://packagist.org/packages/middlewares/aura-session).
```sh
composer require middlewares/aura-session
```
## Example
```php
$dispatcher = new Dispatcher([
new Middlewares\AuraSession(),
function ($request) {
//get the session object
$session = $request->getAttribute('session');
}
]);
$response = $dispatcher->dispatch(new ServerRequest());
```
## Options
#### `__construct(Aura\Session\SessionFactory $factory = null)`
To use a custom session factory. If it's not passed, it will be created automatically.
#### `name(string $name)`
The session name. If it's not defined, the default `PHPSESSID` will be used.
#### `attribute(string $attribute)`
The attribute name used to store the session in the server request. By default is `session`.
---
Please see [CHANGELOG](CHANGELOG.md) for more information about recent changes and [CONTRIBUTING](CONTRIBUTING.md) for contributing details.
The MIT License (MIT). Please see [LICENSE](LICENSE) for more information.
[ico-version]: https://img.shields.io/packagist/v/middlewares/aura-session.svg?style=flat-square
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
[ico-ga]: https://github.com/middlewares/aura-session/workflows/testing/badge.svg
[ico-downloads]: https://img.shields.io/packagist/dt/middlewares/aura-session.svg?style=flat-square
[link-packagist]: https://packagist.org/packages/middlewares/aura-session
[link-downloads]: https://packagist.org/packages/middlewares/aura-session
[link-sensiolabs]: https://insight.sensiolabs.com/projects/174fe6b4-f522-49e4-9bab-2c7bf212d389