https://github.com/noglitchyo/symfony-middleware-bundle
Introduces PSR-15 middleware support into Symfony framework.
https://github.com/noglitchyo/symfony-middleware-bundle
dispatcher middleware psr-15 psr-7 request-handler symfony
Last synced: 14 days ago
JSON representation
Introduces PSR-15 middleware support into Symfony framework.
- Host: GitHub
- URL: https://github.com/noglitchyo/symfony-middleware-bundle
- Owner: noglitchyo
- License: mit
- Created: 2019-06-22T23:53:33.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-08-15T08:48:59.000Z (over 6 years ago)
- Last Synced: 2025-08-13T13:55:15.399Z (5 months ago)
- Topics: dispatcher, middleware, psr-15, psr-7, request-handler, symfony
- Language: PHP
- Homepage:
- Size: 71.3 KB
- Stars: 4
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# symfony-middleware-bundle
Introduces PSR-15 middleware support into Symfony framework.
[](https://travis-ci.org/noglitchyo/symfony-middleware-bundle)
[](https://codecov.io/gh/noglitchyo/symfony-middleware-bundle)
Roadmap
============
- Full test coverage
- Documentation
This bundle is under heavy development and is not meant to be used in production.
Feel free to contribute!
Description
============
Symfony Middleware Bundle provides support for PSR-15 middleware execution in Symfony application.
It introduces a middleware dispatcher in a non-intrusive way, so it can be used with a minimal and simple configuration.
This bundle attempts to offer two implementations, so it can be used in different ways:
- through an event listener plugged on the events dispatched by the HttpKernel.
It will execute the middleware collection before passing the request to the controller if no response were created by the middlewares.
- as a decorator of the HttpKernel with the MiddlewareStackKernel.
Getting started
============
Requirements
============
- Symfony 4
- PHP 7.3
Installation
============
Applications that use Symfony Flex
----------------------------------
Open a command console, enter your project directory and execute:
```console
$ composer require noglitchyo/symfony-middleware-bundle
```
Applications that don't use Symfony Flex
----------------------------------------
### Step 1: Download the Bundle
Open a command console, enter your project directory and execute the
following command to download the latest stable version of this bundle:
```console
$ composer require noglitchyo/symfony-middleware-bundle
```
This command requires you to have Composer installed globally, as explained
in the [installation chapter](https://getcomposer.org/doc/00-intro.md)
of the Composer documentation.
### Step 2: Enable the Bundle
Then, enable the bundle by adding it to the list of registered bundles
in the `config/bundles.php` file of your project:
```php
// config/bundles.php
return [
// ...
NoGlitchYo\MiddlewareBundle\NoGlitchYoMiddlewareBundle::class => ['all' => true],
];
```
Usage
=====
#### Step 1: Create a middleware collection
First, it is required to define a middleware collection. The middleware collection will, as states its name, contains all
the middleware to execute.
For this purpose, this bundle rely on the middleware collection implementation from
[noglitchyo/middleware-collection-request-handler](https://github.com/noglitchyo/middleware-collection-request-handler)
which gives the ability to execute a collection of middlewares as if it was a single PSR-15 middleware or request handler with different execution strategies.
#### Example
`services.yaml`
```yaml
# Let's define some middlewares that we want to use.
App\Middleware\SecurityMiddleware: ~
App\Middleware\CorsMiddleware: ~
App\Middleware\RouterMiddleware: ~*
# Then, we define the middleware
middleware_collections.default:
class: NoGlitchYo\MiddlewareCollectionRequestHandler\Collection\MiddlewareCollectionInterface
# Define the middleware collection class which MUST implement MiddlewareCollectionInterface.
# Some default implementations are provided. Choose one of them or create your own.
# NoGlitchYo\MiddlewareCollectionRequestHandler\Collection\ArrayStackMiddlewareCollection
# NoGlitchYo\MiddlewareCollectionRequestHandler\Collection\SplQueueMiddlewareCollection
# NoGlitchYo\MiddlewareCollectionRequestHandler\Collection\SplStackMiddlewareCollection
arguments:
- ['@App\Middleware\EncoderMiddleware', '@App\Middleware\RouterMiddleware', '@App\Middleware\EncoderMiddleware']
tags: ['middlewares.collection'] # Tag it! So the collection can be picked up.
```
#### Step 2: Define a middleware handler
Handler gives the instruction to execute the attached middleware collection.
Once, it is defined, the collection of middlewares will be executed for every incoming requests.
It is possible to define some conditions on when the handler should be run:
- Route Path matching : if the route path of the request match the given route path
- Route Name matching : if the route name of the request match the given route name
#### Example
`middlewares.yaml`
```yaml
middlewares:
handlers:
default: # Name of your handler configuration
collection: default.middleware_collection # should be the collection class name / service name defined in services.yaml
condition: # Condition is optional, if not provided the collection will be executed for every requests
routePath: '/path/test/1'
routeName: 'myCustomRouteName'
```
Tests
=====
Would like to the run the test suite? Go ahead:
`composer test`
References
==========
https://www.php-fig.org/psr/psr-15/
License
==========
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.