ZF Versioning ============= [![Build Status](https://secure.travis-ci.org/zfcampus/zf-versioning.svg?branch=master)](https://secure.travis-ci.org/zfcampus/zf-versioning) [![Coverage Status](https://coveralls.io/repos/github/zfcampus/zf-versioning/badge.svg?branch=master)](https://coveralls.io/github/zfcampus/zf-versioning?branch=master) Introduction ------------ zf-versioning is a Zend Framework module for automating service versioning through both URIs and `Accept` or `Content-Type` header media types. Information extracted from either the URI or header media type that relates to versioning will be made available in the route match object. In situations where a controller service name is utilizing a sub-namespace matching the regexp `V(\d)`, the matched controller service names will be updated with the currently matched version string. Requirements ------------ Please see the [composer.json](composer.json) file. Installation ------------ Run the following `composer` command: ```console $ composer require zfcampus/zf-versioning ``` Alternately, manually add the following to your `composer.json`, in the `require` section: ```javascript "require": { "zfcampus/zf-versioning": "^1.2" } ``` And then run `composer update` to ensure the module is installed. Finally, add the module name to your project's `config/application.config.php` under the `modules` key: ```php return [ /* ... */ 'modules' => [ /* ... */ 'ZF\Versioning', ], /* ... */ ]; ``` > ### zf-component-installer > > If you use [zf-component-installer](https://github.com/zendframework/zf-component-installer), > that plugin will install zf-versioning as a module for you. Configuration ------------- ### User Configuration The top-level configuration key for user configuration of this module is `zf-versioning`. #### Key: `content-type` The `content-type` key is used for specifying an array of regular expressions that will be used in parsing both `Content-Type` and `Accept` headers for media type based versioning information. A default regular expression is provided in the implementation which should also serve as an example of what kind of regex to create for more specific parsing: ```php '#^application/vnd\.(?P[^.]+)\.v(?P\d+)\.(?P[a-zA-Z0-9_-]+)$#' ``` This rule will match the following pseudo-code route: ``` application/vnd.{api name}.v{version}(.{resource})?+json ``` All captured parts should utilize named parameters. A more specific example, with the top-level key would look like: ```php 'zf-versioning' => [ 'content-type' => [ '#^application/vendor\.(?Pmwop)\.v(?P\d+)\.(?Pstatus|user)$#', ], ], ``` #### Key: `default_version` The `default_version` key provides the default version number to use in case a version is not provided by the client. `1` is the default for `default_version`. The setting accepts one of the two following possible values: - A PHP `integer` indicating the default version number for *all* routes. - An associative array, where the keys are route names, and the values the default version to use with the associated route. Full Example: ```php // Set v2 as default version for all routes 'zf-versioning' => [ 'default_version' => 2, ], ``` or ```php // Set default version to v2 and v3 for the users and status routes respectively 'zf-versioning' => [ 'default_version' => [ 'myapi.rest.users' => 2, 'myapi.rpc.status' => 3, ], ], ``` #### Key: `uri` The `uri` key is responsible for identifying which routes need to be prepended with route matching information for URL based versioning. This key is an array of route names that is used in the ZF2 `router.routes` configuration. If a particular route is a child route, the chain will happen at the top-most ancestor. The route matching segment consists of a rule of `[/v:version]` while specifying a constraint of digits only for the version parameter. Example: ```php 'zf-versioning' => [ 'uri' => [ 'api', 'status', 'user', ], ], ``` ### System Configuration The following configuration is provided in `config/module.config.php` to enable the module to function: ```php 'service_manager' => [ 'factories' => [ \ZF\Versioning\AcceptListener::class => \ZF\Versioning\Factory\AcceptListenerFactory::class, \ZF\Versioning\ContentTypeListener::class => \ZF\Versioning\Factory\ContentTypeListenerFactory::class, \ZF\Versioning\VersionListener::class => \Zend\ServiceManager\Factory\InvokableFactory::class, ], ], ``` ZF2 Events ---------- `zf-versioning` provides no new events, but does provide 4 distinct listeners: #### ZF\Versioning\PrototypeRouteListener This listener is attached to `ModuleEvent::EVENT_MERGE_CONFIG`. It is responsible for iterating the routes provided in the `zf-versioning.uri` configuration to look for corresponding routes in the `router.routes` configuration. When a match is detected, this listener will apply the versioning route match configuration to the route configuration. #### ZF\Versioning\VersionListener This listener is attached to the `MvcEvent::EVENT_ROUTE` at a priority of `-41`. This listener is responsible for updating controller service names that utilize a versioned namespace naming scheme. For example, if the currently matched route provides a controller name such as `Foo\V1\Bar`, and the currently selected version through URL or media type is `4`, then the controller service name will be updated in the route matches to `Foo\V4\Bar`; #### ZF\Versioning\AcceptListener This listener is attached to the `MvcEvent::EVENT_ROUTE` at a priority of `-40`. This listener is responsible for parsing out information from the provided regular expressions (see the `content-type` configuration key for details) from any `Accept` header that is present in the request, and assigning that information to the route match, with the regex parameter names as keys. #### ZF\Versioning\ContentTypeListener This listener is attached to the `MvcEvent::EVENT_ROUTE` at a priority of `-40`. This listener is responsible for parsing out information from the provided regular expressions (see the `content-type` configuration key for details) from any `Content-Type` header that is present in the request, and assigning that information to the route match, with the regex parameter names as keys. ZF2 Services ------------ `zf-versioning` provides no unique services other than those that serve the purpose of event listeners, namely: - `ZF\Versioning\VersionListener` - `ZF\Versioning\AcceptListener` - `ZF\Versioning\ContentTypeListener`