mezzio/mezzio

PSR-15 Middleware Microframework

3.17.0 2023-05-09 14:54 UTC

Requires

• php: ~8.1.0 || ~8.2.0
• fig/http-message-util: ^1.1.5
• laminas/laminas-httphandlerrunner: ^2.1
• laminas/laminas-stratigility: ^3.5
• mezzio/mezzio-router: ^3.7
• mezzio/mezzio-template: ^2.2
• psr/container: ^1.0||^2.0
• psr/http-factory: ^1.0
• psr/http-message: ^1.0.1 || ^2.0.0
• psr/http-server-middleware: ^1.0
• webmozart/assert: ^1.10

Requires (Dev)

• filp/whoops: ^2.14.6
• laminas/laminas-coding-standard: ~2.5.0
• laminas/laminas-diactoros: ^3.0
• laminas/laminas-servicemanager: ^3.20
• mezzio/mezzio-aurarouter: ^3.6
• mezzio/mezzio-fastroute: ^3.8
• mezzio/mezzio-laminasrouter: ^3.7
• phpunit/phpunit: ^10.1
• psalm/plugin-phpunit: ^0.18.4
• vimeo/psalm: ^5.7.7

Suggests

• filp/whoops: ^2.1 to use the Whoops error handler
• laminas/laminas-auradi-config: ^2.0 to use Aura.Di dependency injection container
• laminas/laminas-pimple-config: ^1.0 to use Pimple for dependency injection container
• laminas/laminas-servicemanager: ^3.3 to use laminas-servicemanager for dependency injection
• mezzio/mezzio-helpers: ^3.0 for its UrlHelper, ServerUrlHelper, and BodyParseMiddleware
• mezzio/mezzio-tooling: ^1.0 for migration and development tools; require it with the --dev flag
• psr/http-message-implementation: Please install a psr/http-message-implementation to consume Mezzio; e.g., laminas/laminas-diactoros

Conflicts

• container-interop/container-interop: <1.2.0
• filp/whoops: <2.14.4
• laminas/laminas-diactoros: <1.7.1
• laminas/laminas-http: <2.15.0
• laminas/laminas-router: <3.5.0
• laminas/laminas-stdlib: <3.6.0
• zendframework/zend-expressive: *

BSD-3-Clause

• http
• middleware
• psr
• psr-7
• PSR-11
• psr-15
• laminas
• mezzio

README

Develop PSR-7 middleware applications in minutes!

mezzio builds on laminas-stratigility to provide a minimalist PSR-7 middleware framework for PHP, with the following features:

• Routing. Choose your own router; we support:
  • Aura.Router
  • FastRoute
  • laminas-router
• DI Containers, via PSR-11 Container. Middleware matched via routing is retrieved from the composed container.
• Optionally, templating. We support:
  • Plates
  • Twig
  • Laminas's PhpRenderer

Installation

We provide two ways to install Mezzio, both using Composer: via our skeleton project and installer, or manually.

Using the skeleton + installer

The simplest way to install and get started is using the skeleton project, which includes installer scripts for choosing a router, dependency injection container, and optionally a template renderer and/or error handler. The skeleton also provides configuration for officially supported dependencies.

To use the skeleton, use Composer's create-project command:

$ composer create-project mezzio/mezzio-skeleton <project dir>

This will prompt you through choosing your dependencies, and then create and install the project in the <project dir> (omitting the <project dir> will create and install in a mezzio-skeleton/ directory).

Manual Composer installation

You can install Mezzio standalone using Composer:

$ composer require mezzio/mezzio

However, at this point, Mezzio is not usable, as you need to supply minimally:

• a router.
• a dependency injection container.

We currently support and provide the following routing integrations:

• Aura.Router: composer require mezzio/mezzio-aurarouter
• FastRoute: composer require mezzio/mezzio-fastroute
• laminas-router: composer require mezzio/mezzio-laminasrouter

We recommend using a dependency injection container, and typehint against PSR-11 Container. We can recommend the following implementations:

• laminas-servicemanager: composer require laminas/laminas-servicemanager
• Pimple (see docs for more details): composer require laminas/laminas-pimple-config
• Aura.Di (see docs for more details): composer require laminas/laminas-auradi-config

Additionally, you may optionally want to install a template renderer implementation, and/or an error handling integration. These are covered in the documentation.

Documentation

Documentation is in the doc tree, and can be compiled using mkdocs:

$ mkdocs build

Additionally, public-facing, browseable documentation is available at https://docs.mezzio.dev/mezzio/