laminas-api-tools/api-tools-hal

Release Notes for 1.8.0

Feature release (minor)

1.8.0

• Total issues resolved: 0
• Total pull requests resolved: 1
• Total contributors: 1

Enhancement

• 37: Support for PHP 8.1 thanks to @snapshotpl

Release Notes for 1.7.0

Added

• Adds support for PHP 8.0

Removed

• Drops support for PHP versions prior to 7.3.

• Drops support for laminas-eventmanager v2 releases.

• Drops support for laminas-hydrator v2 releases.

• Drops support for laminas-mvc v2 releases.

• Drops support for laminas-stdlib v2 releases.

1.7.0

• Total issues resolved: 1
• Total pull requests resolved: 3
• Total contributors: 3

Enhancement

• 32: Provide Psalm integration thanks to @weierophinney
• 31: Adopt laminas-coding-standard v2 and bump minimum version of dependencies thanks to @weierophinney
• 27: PHP8 Support thanks to @javabudd
• 25: Psalm integration thanks to @boesing

Release Notes for 1.6.1

1.6.1

• Total issues resolved: 0
• Total pull requests resolved: 2
• Total contributors: 1

Bug

• 29: Fix ArrayObject extraction on PHP 7.4+ thanks to @weierophinney

Enhancement

• 28: Adopt Laminas CI workflow for GHA thanks to @weierophinney

Based on https://github.com/zfcampus/zf-hal/releases/tag/1.6.0 (commit f324ee1ab6efca9d598fe315cc25849efc588a19 in this repo)

Added

• zfcampus/zf-hal#172 adds support for laminas-hydrator v3 releases (while retaining support for v1 and v2).

Changed

• Nothing.

Deprecated

• Nothing.

Removed

• Nothing.

Fixed

• Nothing.

Based on https://github.com/zfcampus/zf-hal/releases/tag/1.5.0 (commit d09c013d511bb62a99bfd716669111087f007c90 in this repo)

Added

• zfcampus/zf-hal#158 adds support for PHP 7.1 and 7.2.

• zfcampus/zf-hal#167 adds a new event, fromLink.pre, triggered from the Laminas\ApiTools\Hal\Plugin\Hal::fromLink method.
  This event can be used in conjunction with Laminas\ApiTools\Rest\RestController::create() to manipulate the generated
  link for purpose of modifying it for the Link HTTP response header.

Changed

• zfcampus/zf-hal#163 updates Laminas\ApiTools\Hal\Link\Link to implement the PSR-13 LinkInterface, and modifies
  some internals to make use of its idempotency.

• zfcampus/zf-hal#165 modifies the JsonSerializableEntity to implement the native PHP JsonSerializable
  interface instead of the polyfill from laminas-stdlib, as all versions of PHP we support
  provide that interface in default installs now.

Deprecated

• zfcampus/zf-hal#163 both adds and deprecates the method Laminas\ApiTools\Hal\Link\LinkCollection::idempotentAdd();
  in version 3, if released, that method will replace the add() method. Its
  internals largely replace functionality in Laminas\ApiTools\Hal\Plugin\Hal::injectPropertyAsLink().

• zfcampus/zf-hal#163 deprecates the "url" key when creating a new link from an array, in
  favor of an "href" key.

Removed

• zfcampus/zf-hal#158 removes support for HHVM.

Fixed

• zfcampus/zf-hal#161 fixes initialization of the hal view helper, ensuring it receives an
  event manager instance within its factory. Previously, listeners attached within delegator
  factories could be overwritten.

Based on https://github.com/zfcampus/zf-hal/releases/tag/1.4.2 (commit 805b7e9622eb4394a39f977cc6af3f3c35d9d074 in this repo)

Added

• Nothing.

Deprecated

• Nothing.

Removed

• Nothing.

Fixed

• zfcampus/zf-hal#151 updates the
  HalControllerPluginFactory to work correctly under v2 releases of
  laminas-servicemanager.

Based on https://github.com/zfcampus/zf-hal/releases/tag/1.4.1 (commit 2b88aa92f9cb8e88dae5184179d579023f681973 in this repo)

Added

• Nothing.

Deprecated

• Nothing.

Removed

• Nothing.

Fixed

• zfcampus/zf-hal#149 updates the laminas-hydrator
  dependency to allow either the 1.1 or 2.2 series, allowing usage with
  laminas-stdlib v2 releases.

Based on https://github.com/zfcampus/zf-hal/releases/tag/1.4.0 (commit 2ef1c018b441fbc5b19819907f02ecc944627ef3 in this repo)

Added

• zfcampus/zf-hal#142 and
  zfcampus/zf-hal#145 add support for Laminas
  Framework v3 component releases, retaining support for v2 versions as well;
  specifically, laminas-eventmanager, laminas-mvc, laminas-stdlib, and
  laminas-servicemanager v3 may now be used with this module.

• zfcampus/zf-hal#142 and
  zfcampus/zf-hal#145 add support for PHP 7.

• zfcampus/zf-hal#99 adds accessors for the
  $entity and $id properties of Laminas\ApiTools\Hal\Entity.

• zfcampus/zf-hal#124 adds a new interface
  Laminas\ApiTools\Hal\Link\SelfLinkInjectorInterface and default implementation
  Laminas\ApiTools\Hal\Link\SelfLinkInjector; these are now used as collaborators to the
  Hal plugin to simplify internal logic, and allow users to provide alternate
  strategies for generating the self relational link.

• zfcampus/zf-hal#125 adds a new service,
  Laminas\ApiTools\Hal\Link\LinkUrlBuilder. This class composes the ServerUrl and Url
  view helpers in order to provide the functionality required to build a
  route-based link URL. The Hal 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.

• zfcampus/zf-hal#125 adds service factories for
  each of the LinkExtractor and LinkCollectionExtractor, 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.)

• zfcampus/zf-hal#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).

Deprecated

• zfcampus/zf-hal#99 deprecates usage of property
  access on Laminas\ApiTools\Hal\Entity to retrieve the identifier and underlying entity
  instance.
• zfcampus/zf-hal#125 deprecates the usage of
  Hal::setServerUrlHelper() and Hal::setUrlHelper(); these will each now
  raise an exception indicating the user should use a LinkUrlBuilder for URL
  generation instead.
• zfcampus/zf-hal#125 deprecates passing a
  ServerUrlHelper and UrlHelper to the constructor of
  Laminas\ApiTools\Hal\Exctractor\LinkExtractor; it now expects a LinkUrlBuilder instance
  instead. (This class is primarily an internal detail of the Hal plugin.)

Removed

• zfcampus/zf-hal#145 removes support for PHP 5.5.

Fixed

• Nothing.