mtymek / zend-expressive

Start to develop PSR-7 middleware applications in PHP in a minute!

zend-expressive

Begin developing PSR-7 middleware applications in minutes!

zend-expressive builds on zend-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
  • ZF2's MVC router
• DI Containers, via container-interop. Middleware matched via routing is retrieved from the composed container.
• Optionally, templating. We support:
  • Plates
  • Twig
  • ZF2's PhpRenderer

Installation

We provide two ways to install Expressive, 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 -s rc zendframework/zend-expressive-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 zend-expressive-skeleton/ directory).

Manual Composer installation

You can install Expressive standalone using Composer:

$ composer require zendframework/zend-expressive

However, at this point, Expressive 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 zendframework/zend-expressive-aurarouter
• FastRoute: composer require zendframework/zend-expressive-fastroute
• ZF2 MVC Router: composer require zendframework/zend-expressive-zendrouter

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

• zend-servicemanager: composer require zendframework/zend-servicemanager
• pimple-interop: composer require mouf/pimple-interop
• Aura.Di: composer require aura/di:3.0.*@beta

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 bookdown:

$ bookdown doc/bookdown.json
$ php -S 0.0.0.0:8080 -t doc/html/ # then browse to http://localhost:8080/

Bookdown

You can install bookdown globally using composer global require bookdown/bookdown. If you do this, make sure that $HOME/.composer/vendor/bin is on your $PATH.

Additionally, public-facing, browseable documentation is available at http://zend-expressive.rtfd.org.

Architecture

Architectural notes are in NOTES.md.

Please see the tests for full information on capabilities.