# Changelog

All notable changes to this project will be documented in this file, in reverse chronological order by release.

## 2.2.1 - 2018-03-09

### Added

- Nothing.

### Changed

- Nothing.

### Deprecated

- Nothing.

### Removed

- Nothing.

### Fixed

- [#53](https://github.com/zendframework/zend-expressive-fastroute/pull/53)
  provides a default value of an empty array for the `FastRouteRouter::$routes`
  property. When no routes were present, and `generateUri()` was called, the
  previous `null` default would cause an error.

## 2.2.0 - 2018-03-08

### Added

- Nothing.

### Changed

- [#52](https://github.com/zendframework/zend-expressive-fastroute/pull/52)
  updates the minimum supported version of zend-expressive-router to 2.4.0.

### Deprecated

- Nothing.

### Removed

- Nothing.

### Fixed

- Nothing.

## 2.1.2 - 2017-12-06

### Added

- Nothing.

### Changed

- Nothing.

### Deprecated

- Nothing.

### Removed

- [#42](https://github.com/zendframework/zend-expressive-fastroute/pull/42)
  removes support for the 3.0.0-dev versions of zend-expressive-router, as it
  contains backwards-incompatible API changes.

### Fixed

- Nothing.

## 2.1.1 - 2017-12-05

### Added

- [#40](https://github.com/zendframework/zend-expressive-fastroute/pull/40) adds
  support for 3.0.0-dev versions of zend-expressive-router, as there are no API
  changes at this time.

### Changed

- [#38](https://github.com/zendframework/zend-expressive-fastroute/pull/38)
  updates the zend-stdlib dependency to also allow v2 releases, as the
  functionality we consume is the same between both major versions.

### Deprecated

- Nothing.

### Removed

- Nothing.

### Fixed

- Nothing.

## 2.1.0 - 2017-08-11

### Added

- [#33](https://github.com/zendframework/zend-expressive-fastroute/pull/33)
  adds PSR-11 Container Interface support.

### Changed

- [#32](https://github.com/zendframework/zend-expressive-fastroute/pull/32)
  changes to the standard route parser from FastRoute.

### Deprecated

- Nothing.

### Removed

- Nothing.

### Fixed

- Nothing.

## 2.0.0 - 2017-01-11

### Added

- [#25](https://github.com/zendframework/zend-expressive-fastroute/pull/25)
  adds support for zend-expressive-router 2.0. This includes a breaking change
  to those _extending_ `Zend\Expressive\Router\ZendRouter`, as the
  `generateUri()` method now expects a third, optional argument,
  `array $options = []`.

  For consumers, this represents new functionality; you may now pass router
  options, such as defaults, via the new argument when generating a URI.

### Deprecated

- Nothing.

### Removed

- Nothing.

### Fixed

- Nothing.

## 1.3.0 - 2016-12-14

### Added

- [#16](https://github.com/zendframework/zend-expressive-fastroute/pull/16) adds
  support for FastRoute's caching features. Enable these with the following
  configuration:

  ```php
  [
      'router' => [
          'fastroute' => [
              'cache_enabled' => true,                   // boolean
              'cache_file'    => 'data/cache/fastroute', // specify any location
          ],
      ],
  ]
  ```

  Once enabled, the first request will build the cache and store it, while
  subsequent requests will read directly from the cache instead of any routes
  injected in the router.

- [#23](https://github.com/zendframework/zend-expressive-fastroute/pull/23)
  adds support for PHP 7.1.

### Changed

- [#24](https://github.com/zendframework/zend-expressive-fastroute/pull/24)
  updates the router to populate a successful `RouteResult` with the associated
  `Zend\Expressive\Route` instance. This allows developers to retrieve
  additional metadata, such as the path, allowed methods, or options.

- [#24](https://github.com/zendframework/zend-expressive-fastroute/pull/24)
  updates the router to always honor `HEAD` and `OPTIONS` requests if the path
  matches, returning a success route result. Dispatchers will need to check the
  associated `Route` instance to determine if the route explicitly supported the
  method, or if the match was implicit (via `Route::implicitHead()` or
  `Route::implicitOptions()`).

### Deprecated

- Nothing.

### Removed

- [#23](https://github.com/zendframework/zend-expressive-fastroute/pull/23)
  removes support for PHP 5.5.

### Fixed

- Nothing.

## 1.2.1 - 2016-12-13

### Added

- Nothing.

### Deprecated

- Nothing.

### Removed

- Nothing.

### Fixed

- [#19](https://github.com/zendframework/zend-expressive-fastroute/pull/19) fixes
  route generation for optional segments with regex char classes: e.g.
  `[/{param:my-[a-z]+}]`

## 1.2.0 - 2016-06-16

### Added

- [#17](https://github.com/zendframework/zend-expressive-fastroute/pull/17) upgraded
  the dependency to [`nikic/fast-route`](https://github.com/nikic/FastRoute) to
  [`^1.0.0`](https://github.com/nikic/FastRoute/releases/tag/v1.0.0).

### Deprecated

- Nothing.

### Removed

- Nothing.

### Fixed

- Nothing.

## 1.1.1 - 2015-05-03

### Added

- [#7](https://github.com/zendframework/zend-expressive-fastroute/pull/7) adds
  support for merging the `defaults` passed in route options with the matched
  parameters when returning a route result. As an example, if you define a route
  as follows:

  ```php
  use Zend\Expressive\Router\Route;

  $route = new Route(
      '/category/{category:[a-z]{3,12}[/resource/{resource:\d+}]',
      'CategoryResource',
      ['GET'],
      'category-resource'
  );
  $route->setOptions(['defaults' => [
      'resource' => 1,
  ]]);
  ```

  and match against the URL path `/category/foobar`, the route result returned
  will now also include a `resource` parameter with a value of `1`.

  This provides feature parity with other routing implementations.

- [#14](https://github.com/zendframework/zend-expressive-fastroute/pull/14) updates
  the FastRoute minimum version to `^0.8.0`. No BC break is expected by this change,
  but you should test your application to confirm.

### Deprecated

- Nothing.

### Removed

- Nothing.

### Fixed

- [#4](https://github.com/zendframework/zend-expressive-fastroute/pull/4) fixes
  URI generation when optional segments are in place, and ensures that if an
  optional segment with a placeholder is missing, but followed by one that is
  present, an exception is raised.
- [#8](https://github.com/zendframework/zend-expressive-fastroute/pull/8) fixes
  URI generation with variable substitution when the variable declaration in the
  route uses `{X,Y}` quantification.

## 1.1.0 - 2016-01-25

### Added

- [#6](https://github.com/zendframework/zend-expressive-fastroute/pull/6)
  updates the FastRoute minimum version to `^0.7.0`. No BC break is expected by
  this change, but you should test your application to confirm.

### Deprecated

- Nothing.

### Removed

- Nothing.

### Fixed

- Nothing.

## 1.0.1 - 2015-12-14

### Added

- Nothing.

### Deprecated

- Nothing.

### Removed

- Nothing.

### Fixed

- [#3](https://github.com/zendframework/zend-expressive-fastroute/pull/3) fixes
  an issue in how the `RouteResult` was marshaled on success. Previously, the
  path was used for the matched route name; now the route name is properly used.

## 1.0.0 - 2015-12-07

First stable release.

### Added

- Nothing.

### Deprecated

- Nothing.

### Removed

- Nothing.

### Fixed

- Nothing.

## 0.3.0 - 2015-12-02

### Added

- Nothing.

### Deprecated

- Nothing.

### Removed

- Nothing.

### Fixed

- Now depends on [zendframework/zend-expressive-router](https://github.com/zendframework/zend-expressive-router)
  instead of zendframework/zend-expressive.

## 0.2.0 - 2015-10-20

### Added

- Nothing.

### Deprecated

- Nothing.

### Removed

- Nothing.

### Fixed

- Updated zend-expressive to RC1.
- Added branch alias for dev-master, pointing to 1.0-dev.

## 0.1.1 - 2015-10-10

### Added

- Nothing.

### Deprecated

- Nothing.

### Removed

- Nothing.

### Fixed

- Moved nikic/fast-route from `require-dev` to `require` section.

## 0.1.0 - 2015-10-10

Initial release.

### Added

- Nothing.

### Deprecated

- Nothing.

### Removed

- Nothing.

### Fixed

- Nothing.