Provided Factories

Expressive provides several factories compatible with PSR-11 Container to facilitate setting up common dependencies. The following is a list of provided containers, what they will create, the suggested service name, and any additional dependencies they may require.

All factories, unless noted otherwise, are in the Zend\Expressive\Container namespace, and define an __invoke() method that accepts an Psr\Container\ContainerInterface instance as the sole argument.

ApplicationFactory

Additionally, the container instance itself is injected into the Application instance.

When the config service is present, the factory can utilize several keys in order to seed the Application instance:

```php 'middleware_pipeline' => [ // An array of middleware to register. [ / ... / ],

  // Expressive 1.0:
  Zend\Expressive\Container\ApplicationFactory::ROUTING_MIDDLEWARE,
  Zend\Expressive\Container\ApplicationFactory::DISPATCH_MIDDLEWARE,

  // Expressive 1.1 and above (above constants will still work, though):
  Zend\Expressive\Application::ROUTING_MIDDLEWARE,
  Zend\Expressive\Application::DISPATCH_MIDDLEWARE,

  [ /* ... */ ],

], ```

Each item of the array, other than the entries for routing and dispatch middleware, must be an array itself, with the following structure:

```php [ // required: 'middleware' => 'Name of middleware service, valid middleware, or an array of these', // optional: 'path' => '/path/to/match', 'priority' => 1, // Integer

  // optional under Expressive 1.X; ignored under 2.X:
  'error' => false, // boolean

], ```

The middleware key itself is the middleware to execute, and must be a service name resolving to valid middleware, middleware instances (either http-interop middleware or callable double-pass middleware), or an array of these values. If an array is provided, the specified middleware will be composed into a Zend\Stratigility\MiddlewarePipe instance.

If the path key is present, that key will be used to segregate the middleware to a specific matched path (in other words, it will not execute if the path is not matched).

The priority defaults to 1, and follows the semantics of SplPriorityQueue: higher integer values indicate higher priority (will execute earlier), while lower/negative integer values indicate lower priority (will execute last). Default priority is 1; use granular priority values to specify the order in which middleware should be piped to the application.

You can specify keys for each middleware specification. These will be ignored by the factory, but can be useful when merging several configurations into one for the application.

Under Expressive 1.X, if the error key is present and boolean true, then the middleware will be registered as error middleware. (This is necessary due to the fact that the factory defines a callable wrapper around middleware to enable lazy-loading of middleware.) We recommend not using this feature; see the chapter on error handling for details.

php 'routes' => [ [ 'path' => '/path/to/match', 'middleware' => 'Middleware service name, valid middleware, or array of these values', 'allowed_methods' => ['GET', 'POST', 'PATCH'], 'options' => [ 'stuff' => 'to', 'pass' => 'to', 'the' => 'underlying router', ], ], // etc. ],

Each route requires:

- `path`: the path to match. Format will be based on the router you choose for
  your project.

- `middleware`: a service name resolving to valid middleware, valid
  middleware (either http-interop middleware or callable double-pass
  middleware), or an array of such values (which will be composed into
  a `Zend\Stratigility\MiddlewarePipe` instance); this middleware will be
  dispatched when the route matches.

Optionally, the route definition may provide:

- `allowed_methods`: an array of allowed HTTP methods. If not provided, the
  application assumes any method is allowed.

- `name`: if not provided, the path will be used as the route name (and, if
  specific HTTP methods are allowed, a list of those).

- `options`: a key/value set of additional options to pass to the underlying
  router implementation for the given route. (Typical use cases include
  passing constraints or default values.)

ErrorHandlerFactory

ErrorResponseGeneratorFactory

When the config service is present, the factory can utilize two values:

As an example:

'debug' => true,
'zend-expressive' => [
    'error_handler' => [
        'template_error' => 'name of error template',
    ],
],

NotFoundDelegateFactory

When the config service is present, the factory can utilize two values:

As an example:

'zend-expressive' => [
    'error_handler' => [
        'template_404' => 'name of 404 template',
    ],
],

NotFoundHandlerFactory

WhoopsErrorResponseGeneratorFactory

WhoopsFactory

This factory creates and configures a Whoops\Run instance so that it will work properly with Zend\Expressive\Application; this includes disabling immediate write-to-output, disabling immediate quit, etc. The PrettyPageHandler returned for the Zend\Expressive\WhoopsPageHandler service will be injected.

It consumes the following config structure:

'whoops' => [
    'json_exceptions' => [
        'display'    => true,
        'show_trace' => true,
        'ajax_only'  => true,
    ],
],

If no whoops top-level key is present in the configuration, a default instance with no JsonResponseHandler composed will be created.

WhoopsPageHandlerFactory

It consumes the following config structure:

'whoops' => [
    'editor' => 'editor name, editor service name, or callable',
],

The editor value must be a known editor name (see the Whoops documentation for pre-configured editor types), a callable, or a service name to use.

PlatesRendererFactory

It consumes the following config structure:

'templates' => [
    'extension' => 'file extension used by templates; defaults to html',
    'paths' => [
        // namespace / path pairs
        //
        // Numeric namespaces imply the default/main namespace. Paths may be
        // strings or arrays of string paths to associate with the namespace.
    ],
]

One note: Due to a limitation in the Plates engine, you can only map one path per namespace when using Plates.

TwigRendererFactory

It consumes the following config structure:

'debug' => boolean,
'templates' => [
    'cache_dir' => 'path to cached templates',
    'assets_url' => 'base URL for assets',
    'assets_version' => 'base version for assets',
    'extension' => 'file extension used by templates; defaults to html.twig',
    'paths' => [
        // namespace / path pairs
        //
        // Numeric namespaces imply the default/main namespace. Paths may be
        // strings or arrays of string paths to associate with the namespace.
    ],
]

When debug is true, it disables caching, enables debug mode, enables strict variables, and enables auto reloading. The assets_* values are used to seed the TwigExtension instance (assuming the router was found).

ZendViewRendererFactory

It consumes the following config structure:

'templates' => [
    'layout' => 'name of layout view to use, if any',
    'map'    => [
        // template => filename pairs
    ],
    'paths'  => [
        // namespace / path pairs
        //
        // Numeric namespaces imply the default/main namespace. Paths may be
        // strings or arrays of string paths to associate with the namespace.
    ],
]

When creating the PhpRenderer instance, it will inject it with a Zend\View\HelperPluginManager instance (either pulled from the container, or instantiated directly). It injects the helper plugin manager with custom url and serverurl helpers, Zend\Expressive\ZendView\UrlHelper and Zend\Expressive\ZendView\ServerUrlHelper, respetively.