zend-expressive 3.2.1

Added

• Nothing.

Changed

• Nothing.

Deprecated

• Nothing.

Removed

• Nothing.

Fixed

• #646 fixes behavior in the MiddlewareContainer when retrieving
  services that implement both RequestHandlerInterface and
  MiddlewareInterface. Previously, it incorrectly cast these values to
  RequestHandlerMiddleware, which could cause middleware pipelines to fail if
  they attempted to delegate back to the application middleware pipeline. These
  values are now correctly returned verbatim.

zend-expressive 3.2.0

Added

• #637 adds support for zendframework/zend-diactoros 2.0.0. You may use either
  a 1.Y or 2.Y version of that library with Expressive applications.

Changed

• Nothing.

Deprecated

• Nothing.

Removed

• Nothing.

Fixed

• #634 provides several minor performance and maintenance improvements.

zend-expressive 3.0.3

Added

• #615 adds a cookbook entry for accessing common data in templates.

Changed

• Nothing.

Deprecated

• Nothing.

Removed

• Nothing.

Fixed

• #627 fixes an issue in the Whoops response generator; previously, if an error or
  exception occurred in an ErrorHandler listener or prior to handling the pipeline,
  Whoops would fail to intercept, resulting in an empty response with status 200. With
  the patch, it properly intercepts and displays the errors.

zend-expressive 3.0.2

Added

• Nothing.

Changed

• Nothing.

Deprecated

• Nothing.

Removed

• Nothing.

Fixed

• #612 updates the ApplicationConfigInjectionDelegator delegator factory logic to cast the $config value to an array before passing it to its injectPipelineFromConfig() and injectRoutesFromConfig() methods, ensuring it will work correctly with containers that store the config service as an ArrayObject instead of an array.

zend-expressive 3.0.1

Added

• Nothing.

Changed

• #596 updates the ApplicationConfigInjectionDelegator::injectRoutesFromConfig() method to use the key name associated with a route specification if no name member is provided when creating a Route instance. This can help enforce name uniqueness when defining routes via configuration.

Deprecated

• Nothing.

Removed

• Nothing.

Fixed

• Nothing.

zend-expressive 2.2.1

Added

• Nothing.

Changed

• Nothing.

Deprecated

• Nothing.

Removed

• Nothing.

Fixed

• #592 fixes a v3 to v2 backwards port issue where the Router\Middleware\DispatchMiddleware is registered as an invokable and it should be registered with the Router\Middleware\DispatchMiddlewareFactory. This caused a "DispatchMiddleware already exists and cannot be overridden" exception.

zend-expressive 3.0.0

Added

• #543 adds support for the final PSR-15 interfaces, and explicitly depends on psr/http-server-middleware.

• #538 adds scalar and return type hints to methods wherever possible.

• #562 adds the class Zend\Expressive\Response\ServerRequestErrorResponseGenerator, and maps it to the Zend\Expressive\Container\ServerRequestErrorResponseGeneratorFactory. The class generates an error response when an exeption occurs producing a server request instance, and can be optionally templated.

• #543 adds a new class, Zend\Expressive\MiddlewareContainer. The class decorates a PSR-11 ContainerInterface, and adds the following behavior:

  • If a class is not in the container, but exists, has() will return true.
  • If a class is not in the container, but exists, get() will attempt to instantiate it, caching the instance locally if it is valid.
  • Any instance pulled from the container or directly instantiated is tested. If it is a PSR-15 RequestHandlerInterface, it will decorate it in a zend-stratigility RequestHandlerMiddleware instance. If the instance is not a PSR-15 MiddlewareInterface, the container will raise a Zend\Expressive\Exception\InvalidMiddlewareException.

• #543 adds a new class, Zend\Expressive\MiddlewareFactory. The class composes a MiddlewareContainer, and exposes the following methods:

  • callable(callable $middleware) : CallableMiddlewareDecorator
  • handler(RequestHandlerInterface $handler) : RequestHandlerMiddleware
  • lazy(string $service) : LazyLoadingMiddleware
  • prepare($middleware) : MiddlewareInterface: accepts a string service name, callable, RequestHandlerInterface, MiddlewareInterface, or array of such values, and returns a MiddlewareInterface, raising an exception if it cannot determine what to do.
  • pipeline(...$middleware) : MiddlewarePipe: passes each argument to prepare(), and the result to MiddlewarePipe::pipe(), returning the pipeline when complete.

• #543 adds the following factory classes, each within the Zend\Expressive\Container namespace:

  • ApplicationPipelineFactory: creates and returns a Zend\Stratigility\MiddlewarePipe to use as the application middleware pipeline.
  • DispatchMiddlewareFactory: creates and returns a Zend\Expressive\Router\DispatchMiddleware instance.
  • EmitterFactory: creates and returns a Zend\HttpHandlerRunner\Emitter\EmitterStack instance composing an SapiEmitter from that same namespace as the only emitter on the stack. This is used as a dependency for the Zend\HttpHandlerRunner\RequestHandlerRunner service.
  • MiddlewareContainerFactory: creates and returns a Zend\Expressive\MiddlewareContainer instance decorating the PSR-11 container passed to the factory.
  • MiddlewareFactoryFactory: creates and returns a Zend\Expressive\MiddlewareFactory instance decorating a MiddlewareContainer instance as pulled from the container.
  • RequestHandlerRunnerFactory: creates and returns a Zend\HttpHandlerRunner\RequestHandlerRunner instance, using the services Zend\Expressive\Application, Zend\HttpHandlerRunner\Emitter\EmitterInterface, Zend\Expressive\ServerRequestFactory, and Zend\Expressive\ServerRequestErrorResponseGenerator.
  • ServerRequestFactoryFactory: creates and returns a callable factory for generating a PSR-7 ServerRequestInterface instance; this returned factory is a dependency for the Zend\HttpHandlerRunner\RequestHandlerRunner service.
  • ServerRequestErrorResponseGeneratorFactory: creates and returns a callable that accepts a PHP Throwable in order to generate a PSR-7 ResponseInterface instance; this returned factory is a dependency for the Zend\HttpHandlerRunner\RequestHandlerRunner service, which uses it to generate a response in the scenario that the ServerRequestFactory is unable to create a request instance.

• #551 and #554 add the following constants under the Zend\Expressive namespace:

  • DEFAULT_DELEGATE can be used to refer to the former DefaultDelegate FQCN service, and maps to the Zend\Expressive\Handler\NotFoundHandler service.
  • IMPLICIT_HEAD_MIDDLEWARE can be used to refer to the former Zend\Expressive\Middleware\ImplicitHeadMiddleware service, and maps to the Zend\Expressive\Router\Middleware\ImplicitHeadMiddleware service.
  • IMPLICIT_OPTIONS_MIDDLEWARE can be used to refer to the former Zend\Expressive\Middleware\ImplicitOptionsMiddleware service, and maps to the Zend\Expressive\Router\Middleware\ImplicitOptionsMiddleware service.
  • NOT_FOUND_MIDDLEWARE can be used to refer to the former Zend\Expressive\Middleware\NotFoundMiddleware service, and maps to the Zend\Expressive\Handler\NotFoundHandler service.

Changed

• #579 updates the version constraint for zend-expressive-router to use 3.0.0rc4 or later.

• #579 updates the version constraint for zend-stratigility to use 3.0.0rc1 or later.

• #543 adds a dependency on zendframework/zend-httphandlerrunner 1.0.0

• #542 modifies the composer.json to no longer suggest the pimple/pimple package, but rather the zendframework/zend-pimple-config package.

• #542 modifies the composer.json to no longer suggest the aura/di package, but rather the zendframework/zend-auradi-config package.

• #543 updates the Zend\Expressive\ConfigProvider to reflect new, removed, and updated services and their factories.

• #554 updates the ConfigProvider to add entries for the following constants as follows:

  • IMPLICIT_HEAD_MIDDLEWARE aliases to the Zend\Expressive\Router\Middleware\ImplicitHeadMiddleware service.
  • IMPLICIT_OPTIONS_MIDDLEWARE aliases to the Zend\Expressive\Router\Middleware\ImplicitOptionsMiddleware service.

• #543 updates Zend\Expressive\Handler\NotFoundHandler to implement the PSR-15 RequestHandlerInterface. As Zend\Expressive\Middleware\NotFoundHandler is removed, Zend\Expressive\Container\NotFoundHandlerFactory has been re-purposedto create an instance of Zend\Expressive\Handler\NotFoundHandler.

• #561 modifies the Zend\Expressive\Handler\NotFoundHandler to compose a response factory instead of a response prototype.

• #543 refactors Zend\Expressive\Application completely.

  The class no longer extends Zend\Stratigility\MiddlewarePipe, and instead implements the PSR-15 MiddlewareInterface and RequestHandlerInterface.

  It now requires the following dependencies via constructor injection, in the following order:

  • Zend\Expressive\MiddlewareFactory
  • Zend\Stratigility\MiddlewarePipe; this is the pipeline representing the application.
  • Zend\Expressive\Router\RouteCollector
  • Zend\HttpHandlerRunner\RequestHandlerRunner

  It removes all "getter" methods (as detailed in the "Removed" section of this release), but retains the following methods, with the changes described below. Please note: in most cases, these methods accept the same arguments as in the version 2 series, with the exception of callable double-pass middleware (these may be decorated manually using Zend\Stratigility\doublePassMiddleware()), and http-interop middleware (no longer supported; rewrite as PSR-15 middleware).

  • pipe($middlewareOrPath, $middleware = null) : void passes its arguments to the composed MiddlewareFactory's prepare() method; if two arguments are provided, the second is passed to the factory, and the two together are passed to Zend\Stratigility\path() in order to decorate them to work as middleware. The prepared middleware is then piped to the composed MiddlewarePipe instance.

    As a result of switching to use the MiddlewareFactory to prepare middleware, you may now pipe RequestHandlerInterface instances as well.

  • route(string $path, $middleware, array $methods = null, string $name) : Route passes its $middleware argument to the MiddlewareFactory::prepare() method, and then all arguments to the composed RouteCollector instance's route() method.

    As a result of switching to use the MiddlewareFactory to prepare middleware, you may now route to RequestHandlerInterface instances as well.

  • Each of get, post, patch, put, delete, and any now proxy to route() after marshaling the correct $methods.

  • getRoutes() : Route[] proxies to the composed RouteCollector instance.

  • handle(ServerRequestInterface $request) : ResponseInterface proxies to the composed MiddlewarePipe instance's handle() method.

  • process(ServerRequestInterface $request, RequestHandlerInterface $handler) : ResponseInterface proxies to the composed MiddlewarePipe instance's process() method.

  • run() : void proxies to the composed RequestHandlerRunner instance. Please note that the method no longer accepts any arguments.

• [#543](https:/...

zend-expressive 3.0.0rc5

This release contains a breaking change.

This release updates to zend-expressive-router 3.0.0rc5, which renames Zend\Expressive\Router\Middleware\PathBasedRoutingMiddleware to Zend\Expressive\Router\RouteCollector, and drops its extension of RouteMiddleware. This was done to prevent confusion between the two route middleware implementations in the final release, and because the primariy duty of the (newly renamed) RouteCollector is to produce and inject Route instances into the composed router.

This release of zend-expressive required one change to comply: Zend\Expressive\Application now composes a RouteCollector instead of a PathBasedRoutingMiddleware instance.

Below is a cumulative list of changes for the 3.0.0 release, including all changes from previous alpha and RC releases. References to PathBasedRoutingMiddleware have been updated to reference RouteCollector or RouteMiddleware based on context:

Added

• #543 adds support for the final PSR-15 interfaces, and explicitly depends on psr/http-server-middleware.

• #538 adds scalar and return type hints to methods wherever possible.

• #562 adds the class Zend\Expressive\Response\ServerRequestErrorResponseGenerator, and maps it to the Zend\Expressive\Container\ServerRequestErrorResponseGeneratorFactory. The class generates an error response when an exeption occurs producing a server request instance, and can be optionally templated.

• #543 adds a new class, Zend\Expressive\MiddlewareContainer. The class decorates a PSR-11 ContainerInterface, and adds the following behavior:

  • If a class is not in the container, but exists, has() will return true.
  • If a class is not in the container, but exists, get() will attempt to instantiate it, caching the instance locally if it is valid.
  • Any instance pulled from the container or directly instantiated is tested. If it is a PSR-15 RequestHandlerInterface, it will decorate it in a zend-stratigility RequestHandlerMiddleware instance. If the instance is not a PSR-15 MiddlewareInterface, the container will raise a Zend\Expressive\Exception\InvalidMiddlewareException.

• #543 adds a new class, Zend\Expressive\MiddlewareFactory. The class composes a MiddlewareContainer, and exposes the following methods:

  • callable(callable $middleware) : CallableMiddlewareDecorator
  • handler(RequestHandlerInterface $handler) : RequestHandlerMiddleware
  • lazy(string $service) : LazyLoadingMiddleware
  • prepare($middleware) : MiddlewareInterface: accepts a string service name, callable, RequestHandlerInterface, MiddlewareInterface, or array of such values, and returns a MiddlewareInterface, raising an exception if it cannot determine what to do.
  • pipeline(...$middleware) : MiddlewarePipe: passes each argument to prepare(), and the result to MiddlewarePipe::pipe(), returning the pipeline when complete.

• #543 adds the following factory classes, each within the Zend\Expressive\Container namespace:

  • ApplicationPipelineFactory: creates and returns a Zend\Stratigility\MiddlewarePipe to use as the application middleware pipeline.
  • DispatchMiddlewareFactory: creates and returns a Zend\Expressive\Router\DispatchMiddleware instance.
  • EmitterFactory: creates and returns a Zend\HttpHandlerRunner\Emitter\EmitterStack instance composing an SapiEmitter from that same namespace as the only emitter on the stack. This is used as a dependency for the Zend\HttpHandlerRunner\RequestHandlerRunner service.
  • MiddlewareContainerFactory: creates and returns a Zend\Expressive\MiddlewareContainer instance decorating the PSR-11 container passed to the factory.
  • MiddlewareFactoryFactory: creates and returns a Zend\Expressive\MiddlewareFactory instance decorating a MiddlewareContainer instance as pulled from the container.
  • RequestHandlerRunnerFactory: creates and returns a Zend\HttpHandlerRunner\RequestHandlerRunner instance, using the services Zend\Expressive\Application, Zend\HttpHandlerRunner\Emitter\EmitterInterface, Zend\Expressive\ServerRequestFactory, and Zend\Expressive\ServerRequestErrorResponseGenerator.
  • ServerRequestFactoryFactory: creates and returns a callable factory for generating a PSR-7 ServerRequestInterface instance; this returned factory is a dependency for the Zend\HttpHandlerRunner\RequestHandlerRunner service.
  • ServerRequestErrorResponseGeneratorFactory: creates and returns a callable that accepts a PHP Throwable in order to generate a PSR-7 ResponseInterface instance; this returned factory is a dependency for the Zend\HttpHandlerRunner\RequestHandlerRunner service, which uses it to generate a response in the scenario that the ServerRequestFactory is unable to create a request instance.

• #551 and #554 add the following constants under the Zend\Expressive namespace:

  • DEFAULT_DELEGATE can be used to refer to the former DefaultDelegate FQCN service, and maps to the Zend\Expressive\Handler\NotFoundHandler service.
  • IMPLICIT_HEAD_MIDDLEWARE can be used to refer to the former Zend\Expressive\Middleware\ImplicitHeadMiddleware service, and maps to the Zend\Expressive\Router\Middleware\ImplicitHeadMiddleware service.
  • IMPLICIT_OPTIONS_MIDDLEWARE can be used to refer to the former Zend\Expressive\Middleware\ImplicitOptionsMiddleware service, and maps to the Zend\Expressive\Router\Middleware\ImplicitOptionsMiddleware service.
  • NOT_FOUND_MIDDLEWARE can be used to refer to the former Zend\Expressive\Middleware\NotFoundMiddleware service, and maps to the Zend\Expressive\Handler\NotFoundHandler service.

Changed

• #579 updates the version constraint for zend-expressive-router to use 3.0.0rc4 or later.

• #579 updates the version constraint for zend-stratigility to use 3.0.0rc1 or later.

• #543 adds a dependency on zendframework/zend-httphandlerrunner 1.0.0

• #542 modifies the composer.json to no longer suggest the pimple/pimple package, but rather the zendframework/zend-pimple-config package.

• #542 modifies the composer.json to no longer suggest the aura/di package, but rather the zendframework/zend-auradi-config package.

• #543 updates the Zend\Expressive\ConfigProvider to reflect new, removed, and updated services and their factories.

• #554 updates the ConfigProvider to add entries for the following constants as follows:

  • IMPLICIT_HEAD_MIDDLEWARE aliases to the Zend\Expressive\Router\Middleware\ImplicitHeadMiddleware service.
  • IMPLICIT_OPTIONS_MIDDLEWARE aliases to the Zend\Expressive\Router\Middleware\ImplicitOptionsMiddleware service.

• #543 updates Zend\Expressive\Handler\NotFoundHandler to implement the PSR-15 RequestHandlerInterface. As Zend\Expressive\Middleware\NotFoundHandler is removed, Zend\Expressive\Container\NotFoundHandlerFactory has been re-purposedto create an instance of Zend\Expressive\Handler\NotFoundHandler.

• #561 modifies the Zend\Expressive\Handler\NotFoundHandler to compose a response factory instead of a response prototype.

• #543 refactors Zend\Expressive\Application completely.

  The class no longer extends Zend\Stratigility\MiddlewarePipe, and instead implements the PSR-15 MiddlewareInterface and RequestHandlerInterface.

  It now requires the following dependencies via constructor injection, in the following order:

  • Zend\Expressive\MiddlewareFactory
  • Zend\Stratigility\MiddlewarePipe; this is the pipeline representing the application.
  • Zend\Expressive\Router\RouteCollector
  • Zend\HttpHandlerRunner\RequestHandlerRunner

  It removes all "getter" methods (as detailed in the "Removed" section of this release), but retains the following methods, with the changes described below. Please note: in most cases, these methods accept the same arguments as in the version 2 series, with the exception of callable double-pass middleware (these may be decorated manually using Zend\Stratigility\doublePassMiddleware()), and http-interop middleware (no longer supported; rewrite as PSR-15 middleware).

  • pipe($middlewareOrPath, $middleware = null) : void passes its arguments to the composed MiddlewareFactory's prepare() method; if two arguments are provided, the second is passed to the factory, and the two together are passed to Zend\Stratigility\path() in order to decorate them to work as middleware. The prepared middleware is then piped to the composed MiddlewarePipe instance.

    As a result of switching to use the MiddlewareFactory to prepare middleware, you may now pipe RequestHandlerInterface instances as well.

  • route(string $path, $middleware, array $methods = null, string $name) : Route passes its $middleware argument to the `Middleware...

zend-expressive 3.0.0rc4

Added

• Nothing.

Changed

• Forward ports a change made in #581 to how the ApplicationConfigInjectionDelegator::injectPipelineFromConfig() method works. Previously, it would auto-inject routing and dispatch middleware if routes were configured, but no middleware_pipeline was present. Considering that this method will always be called manually, this functionality was removed; the method now becomes a no-op if no middleware_pipeline is present.

Deprecated

• Nothing.

Removed

• Nothing.

Fixed

• Nothing.

zend-expressive 2.2.0

Added

• #581 adds the class Zend\Expressive\ConfigProvider, and exposes it to the zend-component-installer Composer plugin. We recommend updating your config/config.php to reference it, as well as the Zend\Expressive\Router\ConfigProvider shipped with zend-expressive-router versions 2.4 and up.

• #581 adds the class Zend\Expressive\Container\ApplicationConfigInjectionDelegator. The class can act as a delegator factory, and, when enabled, will inject routes and pipeline middleware defined in configuration.

  Additionally, the class exposes two static methods:

  • injectPipelineFromConfig(Application $app, array $config)
  • injectRoutesFromConfig(Application $app, array $config)

  These may be called to modify an Application instance based on an array of configuration. See thd documentation for more details.

• #581 adds the class Zend\Expressive\Handler\NotFoundHandler; the class takes over the functionality previously provided in Zend\Expressive\Delegate\NotFoundDelegate.

Changed

• #581 updates the minimum supported zend-stratigility version to 2.2.0.

• #581 updates the minimum supported zend-expressive-router version to 2.4.0.

Deprecated

• #581 deprecates the following classes and traits:

  • Zend\Expressive\AppFactory: if you are using this, you will need to switch to direct usage of Zend\Expressive\Application or a Zend\Stratigility\MiddlewarePipe instance.

  • Zend\Expressive\ApplicationConfigInjectionTrait: if you are using it, it is marked internal, and deprecated; it will be removed in version 3.

  • Zend\Expressive\Container\NotFoundDelegateFactory: the NotFoundDelegate will be renamed to Zend\Expressive\Handler\NotFoundHandler in version 3, making this factory obsolete.

  • Zend\Expressive\Delegate\NotFoundDelegate: this class becomes Zend\Expressive\Handler\NotFoundHandler in v3, and the new class is added in version 2.2 as well.

  • Zend\Expressive\Emitter\EmitterStack: the emitter concept is extracted from zend-diactoros to a new component, zend-httphandlerrunner. This latter component is used in version 3, and defines the EmitterStack class. Unless you are extending it or interacting with it directly, this change should not affect you; the Zend\Diactoros\Response\EmitterInterface service will be directed to the new class in that version.

  • Zend\Expressive\IsCallableInteropMiddlewareTrait: if you are using it, it is marked internal, and deprecated; it will be removed in version 3.

  • Zend\Expressive\MarshalMiddlewareTrait: if you are using it, it is marked internal, and deprecated; it will be removed in version 3.

  • Zend\Expressive\Middleware\DispatchMiddleware: this functionality has been moved to zend-expressive-router, under the Zend\Expressive\Router\Middleware namespace.

  • Zend\Expressive\Middleware\ImplicitHeadMiddleware: this functionality has been moved to zend-expressive-router, under the Zend\Expressive\Router\Middleware namespace.

  • Zend\Expressive\Middleware\ImplicitOptionsMiddleware: this functionality has been moved to zend-expressive-router, under the Zend\Expressive\Router\Middleware namespace.

  • Zend\Expressive\Middleware\NotFoundHandler: this will be removed in version 3, where you can instead pipe Zend\Expressive\Handler\NotFoundHandler directly instead.

  • Zend\Expressive\Middleware\RouteMiddleware: this functionality has been moved to zend-expressive-router, under the Zend\Expressive\Router\Middleware namespace.

• #581 deprecates the following methods from Zend\Expressive\Application:

  • pipeRoutingMiddleware()
  • pipeDispatchMiddleware()
  • getContainer(): this method is removed in version 3; container access will only be via the bootstrap.
  • getDefaultDelegate(): the concept of a default delegate is removed in version 3.
  • getEmitter(): emitters move to a different collaborator in version 3.
  • injectPipelineFromConfig() andd injectRoutesFromConfig() are methods defined by the ApplicationConfigInjectionTrait, which will be removed in version 3. Use the ApplicationConfigInjectionDelegator instead.

Removed

• Nothing.

Fixed

• Nothing.