Skip to content

Commit

Permalink
Drop documentation bits about removed optional middleware support
Browse files Browse the repository at this point in the history
Signed-off-by: Aleksei Khudiakov <[email protected]>
  • Loading branch information
Xerkus committed Jun 3, 2022
1 parent 885ccab commit 5399cda
Show file tree
Hide file tree
Showing 5 changed files with 0 additions and 25 deletions.
2 changes: 0 additions & 2 deletions docs/book/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -241,8 +241,6 @@ Once you've done this, there are two additional actions you can take. The first
the application. In the default implementation, this does the following:

- Attaches the default route listener (`Laminas\Mvc\RouteListener`).
- Attaches the middleware dispatch listener (`Laminas\Mvc\MiddlewareListener`)
(v2.7.0 and up).
- Attaches the default dispatch listener (`Laminas\Mvc\DispatchListener`).
- Attaches the `ViewManager` listener (`Laminas\Mvc\View\ViewManager`).
- Creates the `MvcEvent`, and injects it with the application, request, and
Expand Down
18 changes: 0 additions & 18 deletions docs/book/middleware.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,22 +14,4 @@ The package [laminas-mvc-middleware][laminas-mvc-middleware] is a laminas-mvc
application module that enables dispatching of middleware, middleware pipes, and
request handlers for route matches that contain a `middleware` parameter.

## Built-in Optional Support Deprecation

With version 2.7.0, laminas-mvc began offering the now deprecated
`Laminas\Mvc\MiddlewareListener`. The `MiddlewareListener` is always enabled, but
requires optional dependencies installed to be used.
A new laminas-mvc module, [laminas-mvc-middleware][laminas-mvc-middleware], transparently replaces
it with `Laminas\Mvc\Middleware\MiddlewareListener` when registered with a
laminas-mvc application.

Starting with version 3.2.0, the built-in `Laminas\Mvc\MiddlewareListener` will
trigger deprecation level errors on any attempt to handle a route match containing
a `middleware` parameter.

If your application currently depends on the built-in optional middleware
support, `laminas/laminas-mvc-middleware:~1.0.0` provides a drop-in replacement.
If you use this new module, please note that the module `Laminas\Mvc\Middleware`
must be enabled in your laminas-mvc application.

[laminas-mvc-middleware]: https://docs.laminas.dev/laminas-mvc-middleware/
2 changes: 0 additions & 2 deletions docs/book/mvc-event.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,6 @@ priority to lower priority):

Class | Priority | Method Called | Triggers | Description
------------------------------|---------:|---------------|----------|------------
`Laminas\Mvc\MiddlewareListener` | 1 | `onDispatch` | `MvcEvent::EVENT_DISPATCH_ERROR` (if an exception is raised during dispatch processes) | Load and dispatch the matched PSR-7 middleware from the service manager (and throws various exceptions if it does not).
`Laminas\Mvc\DispatchListener` | 1 | `onDispatch` | `MvcEvent::EVENT_DISPATCH_ERROR` (if an exception is raised during dispatch processes) | Load and dispatch the matched controller from the service manager (and throws various exceptions if it does not).
`Laminas\Mvc\AbstractController` | 1 | `onDispatch` | none | The `onDispatch` method of the `AbstractController` is an abstract method. In `AbstractActionController`, for instance, it calls the action method.

Expand Down Expand Up @@ -196,7 +195,6 @@ Class | Priority | Method Called | Description

Class | In Method
------------------------------|----------
`Laminas\Mvc\MiddlewareListener` | `onDispatch`
`Laminas\Mvc\DispatchListener` | `onDispatch`
`Laminas\Mvc\DispatchListener` | `marshallControllerNotFoundEvent`
`Laminas\Mvc\DispatchListener` | `marshallBadControllerEvent`
Expand Down
2 changes: 0 additions & 2 deletions docs/book/services.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,6 @@ services configured out of the box.
### Invokable services

- `DispatchListener`, mapping to `Laminas\Mvc\DispatchListener`.
- `Laminas\Mvc\MiddlewareListener`.
- `RouteListener`, mapping to `Laminas\Mvc\RouteListener`.
- `SendResponseListener`, mapping to `Laminas\Mvc\SendResponseListener`.
- `SharedEventManager`, mapping to `Laminas\EventManager\SharedEventManager`.
Expand Down Expand Up @@ -315,7 +314,6 @@ services configured out of the box.
- `Configuration`, mapping to the `Config` service.
- `Console`, mapping to the `ConsoleAdapter` service.
- `Di`, mapping to the `DependencyInjector` service.
- `MiddlewareListener`, mapping to the `Laminas\Mvc\MiddlewareListener` service.
- `Laminas\Di\LocatorInterface`, mapping to the `DependencyInjector` service.
- `Laminas\EventManager\EventManagerInterface`, mapping to the `EventManager`
service. This is mainly to ensure that when falling through to DI, classes
Expand Down
1 change: 0 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ nav:
- 'Available Controllers': controllers.md
- 'Controller Plugins': plugins.md
- Examples: examples.md
- 'Dispatching PSR-7 Middleware': middleware.md
- Migration:
- "Migration Overview": migration/index.md
- 'v2.X to v2.7': migration/to-v2-7.md
Expand Down

0 comments on commit 5399cda

Please sign in to comment.