Download the PHP package dwendrich/expressive-session-middleware without Composer
On this page you can find all versions of the php package dwendrich/expressive-session-middleware. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download dwendrich/expressive-session-middleware
More information about dwendrich/expressive-session-middleware
Files in dwendrich/expressive-session-middleware
Package expressive-session-middleware
Short Description Session handling middleware for use with zend expressive 3 based on zend-session.
License MIT
Informations about the package expressive-session-middleware
expressive-session-middleware
Session handling middleware based on zend-session for use in zend expressive 3 applications.
PSR-15 Support
This version supports PSR-15 instead of http-interop/http-middleware interfaces, as currently implemented by zend expressive 3. For use with older versions of zend expressive, please refer to version 0.1.9.
Requirements
- PHP 7.1 or above
- zendframework/zend-session
Installation
Install the latest version with composer. For information on how to get composer or how to use it, please refer to getcomposer.org.
If during installation you are prompted to inject Zend\Session\ConfigProvider
into your configuration, you can simply
ignore and continue without it. All relevant configuration is part of SessionMiddleware\ConfigProvider
.
As part of a zend-expressive application add SessionMiddleware\ConfigProvider::class
to config/config.php
:
There are two ways of integrating the session middleware into your application.
1. Add the middleware to the programmatic middlewarepipeline
You can add the middleware to the file config/pipeline.php
:
Depending on which middleware should get access to the session, you should prepend SessionMiddleware
in the pipeline.
Commonly before registering the routing middleware is a good way to go.
This way the middleware is invoked on every request to your application. Since session handling may produce some overhead, which isn't always needed, there is an alternative:
2. Add the middleware to a specific route
Add a route definition to either config/routes.php
or a RouteDelegator
as part of your application:
This way session handling is bound to a specific path in your application where it may be needed.
For further information on programmatic pipelines and routing in zend expressive please refer to the documentation.
Basic usage
Once the session middleware is invoked it will start the session and adds the session manager object as attribute to the current request. Any middleware which processes this request subsequently, can detect that session handling is started by testing against the request attribute:
Storing and retrieving session data
Zend session component uses Container
objects to access and store session data. For information on this concept please
refer to the documentation.
Following is a simple example on how to use a Container
:
In another part of the application you may want to access this data:
Configuration
The session can be configured by adding a session.global.php
to your config/autoload
path, for example. You can
use session.global.php.dist
file (see session.global.php.dist) as template.
For possible configuration options please refer to the documentation of zend-session component.
You can override the session configuration instance with any instance or class implementing
Zend\Session\Config\ConfigInterface
. Simply specify it in session configuration:
For using a certain session storage adapter you can override it in the config, as well. Therefore it has to implement
Zend\Session\Storage\StorageInterface
:
To add validators to the session manager, you cann define them in the config, too, for example:
All versions of expressive-session-middleware with dependencies
zendframework/zend-session Version ^2.7
zendframework/zend-servicemanager Version ^3.3
psr/http-message Version ^1.0
psr/http-server-middleware Version ^1.0
http-interop/http-middleware Version ^0.4.1