PHPackages                             zholus/symfony-middleware - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. zholus/symfony-middleware

ActiveLibrary

zholus/symfony-middleware
=========================

v3.0.0(4y ago)76.2k↓41.7%1MITPHPPHP >=8.0.2

Since Oct 8Pushed 4y ago2 watchersCompare

[ Source](https://github.com/zholus/symfony-middleware-bundle)[ Packagist](https://packagist.org/packages/zholus/symfony-middleware)[ RSS](/packages/zholus-symfony-middleware/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (9)Dependencies (5)Versions (13)Used By (0)

MiddlewareBundle for Symfony
============================

[](#middlewarebundle-for-symfony)

[![Build Status](https://camo.githubusercontent.com/df158c36623eade3e3dbcd3f3dfcb06c562de605a091495cd6ed2d8e2925649d/68747470733a2f2f7472617669732d63692e6f72672f7a686f6c75732f73796d666f6e792d6d6964646c65776172652d62756e646c652e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/zholus/symfony-middleware-bundle)[![Coverage Status](https://camo.githubusercontent.com/74b0bf9c6c7efb26bd9d11e8475c49dfe9a462914e9324a63c824bcafa693e9d/68747470733a2f2f636f766572616c6c732e696f2f7265706f732f6769746875622f7a686f6c75732f73796d666f6e792d6d6964646c65776172652d62756e646c652f62616467652e7376673f6272616e63683d7068702d636f766572616c6c73)](https://coveralls.io/github/zholus/symfony-middleware-bundle?branch=php-coveralls)[![StyleCI](https://camo.githubusercontent.com/847dbe211964eb57ed235b0f3b024236f984c39c14f7c5b8c8b6156a658a6b54/68747470733a2f2f6769746875622e7374796c6563692e696f2f7265706f732f3230353636313633382f736869656c643f6272616e63683d6d6173746572)](https://github.styleci.io/repos/205661638)

This bundle allows you to create simple middleware that executes right before controller does on each requests.

Its almost looks like middleware in laravel framework.

There are 4 possible ways to inject your middleware to your request.

Symfony versions
----------------

[](#symfony-versions)

- Symfony version `6.x` - use branch `master`
- Symfony version `5.x` - use branch `5.x`
- Symfony version `4.x` - use branch `4.x`

Installation
------------

[](#installation)

Composer for symfony version 6.x

`composer require zholus/symfony-middleware`

Composer for symfony version 5.x

`composer require zholus/symfony-middleware:^2`

Composer for symfony version 4.x

`composer require zholus/symfony-middleware:^1`

Add bundle in `bundles.php`

`Zholus\SymfonyMiddleware\MiddlewareBundle::class => ['all' => true]`

Register middleware
-------------------

[](#register-middleware)

### Global middleware

[](#global-middleware)

Global middleware executes on every http requests before every controller.

To register middleware as global you need implement interface `\Zholus\SymfonyMiddleware\GlobalMiddlewareInterface`.

That's all.

### Controller middleware

[](#controller-middleware)

This middleware will execute on every action in certain controller, to attach middleware to controller, you need setup some configuration in your services.yaml file:

```
App\Controller\WelcomeController:
    tags:
        - { name: 'middleware.controller', middleware: 'App\Middleware\AuthNeededMiddleware' }

```

That's all, just attach tag with options: `name` - `middleware.controller` and `middleware` - fully-qualified class name.

You can attach more that one middleware to controller

```
App\Controller\WelcomeController:
    tags:
        - { name: 'middleware.controller', middleware: 'App\Middleware\AuthNeededMiddleware' }
        - { name: 'middleware.controller', middleware: 'App\Middleware\AdminAccessMiddleware' }

```

### Action middleware

[](#action-middleware)

This middleware is similar to controller, we need to add just one more option called `action`

```
App\Controller\WelcomeController:
    tags:
        - { name: 'middleware.controller', middleware: 'App\Middleware\AuthNeededMiddleware', action: 'index' }

```

That means that when action `index` will run, than our middleware will executed

### Route middleware

[](#route-middleware)

In your routes configuration file add array option called `middleware`:

```
index:
    path: /
    controller: App\Controller\WelcomeController::index
    options:
        middleware: ['App\Middleware\AuthNeededMiddleware', 'App\Middleware\AdminAccessMiddleware']

```

Those middlewares will attach to route name in our example to `index`.

Priority of middleware executions
---------------------------------

[](#priority-of-middleware-executions)

Order of execution of different types of middleware is next: `global` middleware execute first, next `controller`, next `action` and last `route`.

For global middlewares you can specify in services.yaml, lets see an example

```
App\Middleware\AuthNeededMiddleware:
    tags:
        - { name: 'middleware.global', priority: 2 }

App\Middleware\AdminAccessMiddleware:
    tags:
        - { name: 'middleware.global', priority: 1 }

```

Default priority without specifying in configuration is 0. The higher the number, the earlier a middleware is executed.

For other 3 types (controller, action, route) priority will the same is in the configuration, for example in route configuration:

```
index:
    path: /
    controller: App\Controller\WelcomeController::index
    options:
        middleware: ['App\Middleware\AuthNeededMiddleware', 'App\Middleware\AdminAccessMiddleware']

```

First will execute `App\Middleware\AuthNeededMiddleware` and next `App\Middleware\AdminAccessMiddleware`. And same in other 2 types.

Middleware example
------------------

[](#middleware-example)

In example below, our middleware check if given credentials is represent user with admin access, if not, we will return response with access denied message.

As we can see, if any of middlewares returning Response, it means that next middlewares will not be executed.

Returning of null means that next middleware will be executed.

```