All notable changes to this project will be documented in this file, in reverse chronological order by release.
- Nothing.
- Nothing.
- Nothing.
- Nothing.
- Nothing.
- Nothing.
- Nothing.
- #151 updates the
HalControllerPluginFactory
to work correctly under v2 releases of zend-servicemanager.
- Nothing.
- Nothing.
- Nothing.
- #149 updates the zend-hydrator dependency to allow either the 1.1 or 2.2 series, allowing usage with zend-stdlib v2 releases.
-
#142 and #145 add support for Zend Framework v3 component releases, retaining support for v2 versions as well; specifically, zend-eventmanager, zend-mvc, zend-stdlib, and zend-servicemanager v3 may now be used with this module.
-
#99 adds accessors for the
$entity
and$id
properties ofZF\Hal\Entity
. -
#124 adds a new interface
ZF\Hal\Link\SelfLinkInjectorInterface
and default implementationZF\Hal\Link\SelfLinkInjector
; these are now used as collaborators to theHal
plugin to simplify internal logic, and allow users to provide alternate strategies for generating theself
relational link. -
#125 adds a new service,
ZF\Hal\Link\LinkUrlBuilder
. This class composes theServerUrl
andUrl
view helpers in order to provide the functionality required to build a route-based link URL. TheHal
plugin now consumes this instead of implementing the logic internally.The upshot is: you can replace the URL generation semantics for your application entirely by pointing the service to your own implementation.
-
#125 adds service factories for each of the
LinkExtractor
andLinkCollectionExtractor
, which now allows users to provide substitutions for their functionality. (Extractors pull links and link collections in order to generate the relational links for a HAL-JSON payload.) -
#139 adds the new method
Hal::resetEntityHashStack()
; this method can be used when rendering multiple responses and/or payloads within the same request cycle, in order to allow re-using the same entity instances (normally, they would be skipped when discovered on subsequent iterations).
- #99 deprecates usage of property
access on
ZF\Hal\Entity
to retrieve the identifier and underlying entity instance. - #125 deprecates the usage of
Hal::setServerUrlHelper()
andHal::setUrlHelper()
; these will each now raise an exception indicating the user should use aLinkUrlBuilder
for URL generation instead. - #125 deprecates passing a
ServerUrlHelper
andUrlHelper
to the constructor ofZF\Hal\Exctractor\LinkExtractor
; it now expects aLinkUrlBuilder
instance instead. (This class is primarily an internal detail of theHal
plugin.)
- #145 removes support for PHP 5.5.
- Nothing.
- Nothing.
- Nothing.
- Nothing.
- #111 removes some code errantly left in a comment from a previous merge conflict.
- #112 removes conditionals based on PHP 5.4, as the minimum version is now 5.5.
- #127 fixes an issue in the
HalJsonStrategy
plugin whereby the wrongContent-Type
header was being used when anApiProblem
response was handled; these now correctly returnapplication/problem+json
instead ofapplication/hal+json
.
- #123 updates the component to use zend-hydrator for hydrator functionality; this provides forward compatibility with zend-hydrator, and backwards compatibility with hydrators from older versions of zend-stdlib.
- Nothing.
- Nothing.
- Nothing.
- Nothing.
- Nothing.
- Nothing.
- #122 updates the
zend-stdlib dependency to reference
>=2.5.0,<2.7.0
to ensure hydrators will work as expected following extraction of hydrators to the zend-hydrator repository.