All notable changes to this project will be documented in this file, in reverse chronological order by release.
- #306 adds a cookbook recipe covering flash messages.
- Nothing.
- Nothing.
- Nothing.
Initial stable release.
- #279 updates the documentation to provide automation for pushing to GitHub pages. As part of that work, documentation was re-organized, and a landing page provided. Documentation can now be found at: https://zendframework.github.io/zend-expressive/
- #299 adds component-specific CSS to the documentation.
- #295 adds support for handling PHP 7 engine exceptions in the templated and whoops final handlers.
- Nothing.
- Nothing.
- #280 fixes
references to the
PlatesRenderer
in the error handling documentation. - #284 fixes the reference to maximebf/php-debugbar in the debug bar documentation.
- #285 updates the section on mtymek/blast-base-url in the "Using a Base Path" cookbook recipe to conform to its latest release.
- #286 fixes the documentation of the Composer "serve" command to correct a typo.
- #291 fixes the documentation links to the RC5 -> v1 migration guide in both the CHANGELOG as well as the error messages emitted, ensuring users can locate the correct documentation in order to upgrade.
- #287 updates the
"standalone" quick start to reference calling
$app->pipeRoutingMiddleware()
and$app->pipeDispatchMiddleware()
per the changes in RC6. - #293 adds
a
require 'vendor/autoload.php';
line to the bootstrap script referenced in the zend-servicemanager examples. - #294 updates the namespace referenced in the modulear-layout documentation to provide a better separation between the module/package/whatever, and the application consuming it.
- #298 fixes a typo in a URI generation example.
Seventh release candidate.
- #277 adds a new
class,
Zend\Expressive\ErrorMiddlewarePipe
. It composes aZend\Stratigility\MiddlewarePipe
, but implements the error middleware signature via its own__invoke()
method.
- Nothing.
- Nothing.
- #277 updates the
MarshalMiddlewareTrait
to create and return anErrorMiddlewarePipe
when the$forError
argument provided indicates error middleware is expected. This fix allows defining arrays of error middleware via configuration.
Sixth release candidate.
This release contains backwards compatibility breaks with previous release
candidates. All previous functionality should continue to work, but will
emit E_USER_DEPRECATED
notices prompting you to update your application.
In particular:
- The routing middleware has been split into two separate middleware implementations, one for routing, another for dispatching. This eliminates the need for the route result observer system, as middleware can now be placed between routing and dispatching — an approach that provides for greater flexibility with regards to providing route-based functionality.
- As a result of the above,
Zend\Expressive\Application
no longer implementsZend\Expressive\Router\RouteResultSubjectInterface
, though it retains the methods associated (each emits a deprecation notice). - Configuration for
Zend\Expressive\Container\ApplicationFactory
was modified to implement themiddleware_pipeline
as a single queue, instead of segregating it betweenpre_routing
andpost_routing
. Each item in the queue follows the original middleware specification from those keys, with one addition: apriority
key can be used to allow you to granularly shape the execution order of the middleware pipeline.
A migration guide was written to help developers migrate to RC6 from earlier versions.
- #255 adds
documentation for the base path functionality provided by the
UrlHelper
class of zend-expressive-helpers. - #227 adds a section on creating localized routes, and setting the application locale based on the matched route.
- #244 adds
a recipe on using middleware to detect localized URIs (vs using a routing
parameter), setting the application locale based on the match detected,
and setting the
UrlHelper
base path with the same match. - #260 adds a recipe on how to add debug toolbars to your Expressive applications.
- #261 adds a flow/architectural diagram to the "features" chapter.
- #262 adds a recipe demonstrating creating classes that can intercept multiple routes.
- #270 adds
new methods to
Zend\Expressive\Application
:dispatchMiddleware()
is new middleware for dispatching the middleware matched by routing (this functionality was split fromrouteMiddleware()
).routeResultObserverMiddleware()
is new middleware for notifying route result observers, and exists only to aid migration functionality; it is marked deprecated!pipeDispatchMiddleware()
will pipe the dispatch middleware to theApplication
instance.pipeRouteResultObserverMiddleware()
will pipe the route result observer middleware to theApplication
instance; likerouteResultObserverMiddleware()
, the method only exists for aiding migration, and is marked deprecated.
- #270 adds
Zend\Expressive\MarshalMiddlewareTrait
, which is composed byZend\Expressive\Application
; it provides methods for marshaling middleware based on service names or arrays of services.
- #270 deprecates
the following methods in
Zend\Expressive\Application
, all of which will be removed in version 1.1:attachRouteResultObserver()
detachRouteResultObserver()
notifyRouteResultObservers()
pipeRouteResultObserverMiddleware()
routeResultObserverMiddleware()
- #270 removes the
Zend\Expressive\Router\RouteResultSubjectInterface
implementation fromZend\Expressive\Application
. - #270 eliminates
the
pre_routing
/post_routing
terminology from themiddleware_pipeline
, in favor of individually specifiedpriority
values in middleware specifications.
- #263 typo fixes in documentation
Fifth release candidate.
- #233 adds a documentation page detailing projects using and tutorials written on Expressive.
- #238 adds a cookbook recipe detailing how to handle serving an Expressive application from a subdirectory of your web root.
- #239 adds a cookbook recipe detailing how to create modular Expressive applications.
- #243 adds a
chapter to the helpers section detailing the new
BodyParseMiddleware
.
- Nothing.
- Nothing.
- #234 fixes the
inheritance tree for
Zend\Expressive\Exception\RuntimeException
to inherit fromRuntimeException
and notInvalidArgumentException
. - #237 updates the
Pimple documentation to recommend
xtreamwayz/pimple-container-interop
instead ofmouf/pimple-interop
, as the latter consumed Pimple v1, instead of the current stable v3.
Fourth release candidate.
- #217 adds a cookbook entry to the documentation detailing how to configure zend-view helpers from other components, as well as how to add custom view helpers.
- Nothing.
- Nothing.
- #219 updates the
"Hello World Using a Configuration-Driven Container" usage case to use
zend-stdlib's
Glob::glob()
instead of theglob()
native function, to ensure the documented solution is portable across platforms. - #223 updates the
documentation to refer to the
composer serve
command where relevant, and also details how to create the command for standalone users. - #221 splits the various cookbook entries into separate files, so each is self-contained.
- #224 adds opening
<?php
tags to two configuration file examples, in order to prevent copy-paste errors.
Third release candidate.
- #185 Support casting zend-view models to arrays.
- #192 adds support for specifying arrays of middleware both when routing and when creating pipeline middleware. This feature is opt-in and backwards compatible; simply specify an array value that does not resolve as a callable. Values in the array must be callables, service names resolving to callable middleware, or fully qualified class names that can be instantiated without arguments, and which result in invokable middleware.
- #200,
#206, and
#211 add
functionality for observing computed
RouteResult
s.Zend\Expressive\Application
now implementsZend\Expressive\Router\RouteResultSubjectInterface
, which allows attachingZend\Expressive\RouteResultObserverInterface
implementations and notifying them of computedRouteResult
instances. The following methods are now available on theApplication
instance:attachRouteResultObserver(Router\RouteResultObserverInterface $observer)
detachRouteResultObserver(Router\RouteResultObserverInterface $observer)
notifyRouteResultObservers(RouteResult $result)
;Application
calls this internally withinrouteMiddleware
. This feature enables the ability to notify objects of the calculatedRouteResult
without needing to inject middleware into the system.
- #81 adds a cookbook entry for creating 404 handlers.
- #210 adds a documentation section on the new zendframework/zend-expressive-helpers utilities.
- Nothing.
- #204 removes the
Router
andTemplate
components, as they are now shipped with the following packages, respectively:- zendframework/zend-expressive-router
- zendframework/zend-expressive-template This package has been updated to depend on each of them.
- #187 Inject the route result as an attribute
- #197 updates the
Zend\Expressive\Container\ApplicationFactory
to raise exceptions in cases where received configuration is unusable, instead of silently ignoring it. This is a small backwards compatibility break, but is done to eliminate difficult to identify issues due to bad configuration. - #202 clarifies
that
RouterInterface
implements MUST throw aRuntimeException
ifaddRoute()
is called after eithermatch()
orgenerateUri()
have been called.
Second release candidate.
- Nothing.
- Nothing.
- Nothing.
- Updated branch aliases: dev-master => 1.0-dev, dev-develop => 1.1-dev.
- Point dev dependencies on sub-components to
~1.0-dev
.
First release candidate.
- Nothing.
- Nothing.
- Nothing.
- Nothing.
- Nothing.
- Nothing.
- Nothing.
- #160 updates
EmitterStack
to throw a component-specificInvalidArgumentException
instead of the generic SPL version. - #163 change the
documentation on wiring middleware factories to put them in the
dependencies
section ofroutes.global.php
; this keeps the routing and middleware configuration in the same file.
- #158 documents getting started via the installer + skeleton, and also documents "next steps" in terms of creating and wiring middleware when using the skeleton.
- Nothing.
- Nothing.
- Nothing.
- Nothing.
- Nothing.
- Nothing.
- #156 updates how
the routing middleware pulls middleware from the container; in order to work
with zend-servicemanager v3 and allow
has()
queries to query abstract factories, a second, boolean argument is now passed.
- Nothing.
- Nothing.
- #131 modifies the
repository to remove the concrete router and template renderer
implementations, along with any related factories; these are now in their own
packages. The classes removed include:
Zend\Expressive\Container\Template\PlatesRendererFactory
Zend\Expressive\Container\Template\TwigRendererFactory
Zend\Expressive\Container\Template\ZendViewRendererFactory
Zend\Expressive\Router\AuraRouter
Zend\Expressive\Router\FastRouteRouter
Zend\Expressive\Router\ZendRouter
Zend\Expressive\Template\PlatesRenderer
Zend\Expressive\Template\TwigRenderer
Zend\Expressive\Template\Twig\TwigExtension
Zend\Expressive\Template\ZendViewRenderer
Zend\Expressive\Template\ZendView\NamespacedPathStackResolver
Zend\Expressive\Template\ZendView\ServerUrlHelper
Zend\Expressive\Template\ZendView\UrlHelper
- Nothing.
- Nothing.
- Nothing.
- Nothing.
- Nothing.
- #132 adds
Zend\Expressive\Router\ZendRouter
, replacingZend\Expressive\Router\Zf2Router
. - #139 adds:
Zend\Expressive\Template\TemplateRendererInterface
, replacingZend\Expressive\Template\TemplateInterface
.Zend\Expressive\Template\PlatesRenderer
, replacingZend\Expressive\Template\Plates
.Zend\Expressive\Template\TwigRenderer
, replacingZend\Expressive\Template\Twig
.Zend\Expressive\Template\ZendViewRenderer
, replacingZend\Expressive\Template\ZendView
.
- #143 adds
the method
addDefaultParam($templateName, $param, $value)
toTemplateRendererInterface
, allowing users to specify global and template-specific default parameters to use when rendering. To implement the feature, the patch also providesZend\Expressive\Template\DefaultParamsTrait
to simplify incorporating the feature in implementations. - #133 adds a
stipulation to
Zend\Expressive\Router\RouterInterface
thataddRoute()
should aggregateRoute
instances only, and delay injection untilmatch()
and/orgenerateUri()
are called; all shipped routers now follow this. This allows manipulatingRoute
instances before callingmatch()
orgenerateUri()
— for instance, to inject options or a name. - #133 re-instates
the
Route::setName()
method, as the changes to lazy-inject routes means that setting names and options after adding them to the application now works again.
- Nothing.
- #132 removes
Zend\Expressive\Router\Zf2Router
, renaming it toZend\Expressive\Router\ZendRouter
. - #139 removes:
Zend\Expressive\Template\TemplateInterface
, renaming it toZend\Expressive\Template\TemplateRendererInterface
.Zend\Expressive\Template\Plates
, renaming it toZend\Expressive\Template\PlatesRenderer
.Zend\Expressive\Template\Twig
, renaming it toZend\Expressive\Template\TwigRenderer
.Zend\Expressive\Template\ZendView
, renaming it toZend\Expressive\Template\ZendViewRenderer
.
- Nothing.
- #149 adds
verbiage to the
RouterInterface::generateUri()
method, specifying that the returned URI MUST NOT be escaped. TheAuraRouter
implementation has been updated to internally usegenerateRaw()
to follow this guideline, and retain parity with the other existing implementations.
- Nothing.
- Nothing.
- #140 updates the
AuraRouter to use the request method from the request object, and inject that
under the
REQUEST_METHOD
server parameter key before passing the server parameters for matching. This simplifies testing.
- #128 adds
container factories for each supported template implementation:
Zend\Expressive\Container\Template\PlatesFactory
Zend\Expressive\Container\Template\TwigFactory
Zend\Expressive\Container\Template\ZendViewFactory
- #128 adds
custom
url
andserverUrl
zend-view helper implementations, to allow integration with any router and with PSR-7 URI instances. The newly addedZendViewFactory
will inject these into theHelperPluginManager
by default.
- Nothing.
- Nothing.
- #128 fixes an
expectation in the
WhoopsErrorHandler
tests to ensure the tests can run successfully.
- Nothing.
- Nothing.
- Nothing.
- #125 fixes the
WhoopsErrorHandler
to ensure it pushes the "pretty page handler" into the Whoops runtime.
- #116 adds
Application::any()
to complement the various HTTP-specific routing methods; it has the same signature asget()
,post()
,patch()
, et al, but allows any HTTP method. - #120 renames the
router classes for easier discoverability, to better reflect their usage, and
for better naming consistency.
Aura
becomesAuraRouter
,FastRoute
becomesFastRouteRouter
andZf2
becomesZf2Router
.
- Nothing.
- #120 removes the
classes
Zend\Expressive\Router\Aura
,Zend\Expressive\Router\FastRoute
, andZend\Expressive\Router\Zf
, per the "Added" section above.
- Nothing.
- #112 adds a chapter to the documentation on using Aura.Di (v3beta) with zend-expressive.
- Nothing.
- Nothing.
- #118 fixes an
issue whereby route options specified via configuration were not being pushed
into generated
Route
instances before being passed to the underlying router.
Initial tagged release.
- Everything.
- Nothing.
- Nothing.
- Nothing.