Skip to content

Latest commit

 

History

History
194 lines (120 loc) · 6.91 KB

CHANGELOG.md

File metadata and controls

194 lines (120 loc) · 6.91 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

Unreleased

Added

  • New class Art4\JsonApiClient\Serializer\ArraySerializer to create an array from an Art4\JsonApiClient\AccessInterface

Changed

  • Support for PHP 5.5 dropped, PHP >=5.6 is now required

Deprecated

  • Art4\JsonApiClient\AccessInterface::asArray() will be removed in v1.0, use Art4\JsonApiClient\Serializer\ArraySerializer::serialize() instead

0.9.1 - 2017-12-21

Changed

  • Change Code Style to PSR-2
  • Tests in Travis for PHP 7.2 and nightly added

0.9 - 2017-06-06

Added

  • New method Utils\Helper::parseResponseBody() to parse a JSON API response body
  • New method Utils\Helper::isValidResponseBody() to validate a JSON API response body
  • New method Utils\Helper::isValidRequestBody() to validate a JSON API request body with optional item id

Deprecated

  • Utils\Helper::parse() will be removed in v1.0, use Utils\Helper::parseResponseBody() instead
  • Utils\Helper::isValid() will be removed in v1.0, use Utils\Helper::isValidResponseBody() instead

0.8.1 - 2017-06-01

Fixed

  • Fixed a bug in the decission if a data attribute is a ResourceItem or ResourceIdentifier

0.8 - 2017-05-29

Added

  • New method Utils\Helper::parseRequestBody() to parse JSON API with optional item id
  • Run tests with Travis in PHP 7.1

Changed

  • BREAKING: New method Utils\ManagerInterface::getConfig() to get a config value
  • BREAKING: New method Utils\ManagerInterface::setConfig() to set a config value

Removed

  • BREAKING: Drop support for PHP 5.4

0.7 - 2016-11-24

Changed

  • Update license to GPLv3
  • BREAKING: Introducing the ElementInterface to seperate the parsing from the constructor
  • BREAKING: Rename Art4\JsonApiClient\Resource\Collection to Art4\JsonApiClient\ResourceCollection
  • BREAKING: Rename Art4\JsonApiClient\Resource\CollectionInterface to Art4\JsonApiClient\ResourceCollectionInterface
  • BREAKING: Rename Art4\JsonApiClient\Resource\Identifier to Art4\JsonApiClient\ResourceIdentifier
  • BREAKING: Rename Art4\JsonApiClient\Resource\IdentifierInterface to Art4\JsonApiClient\ResourceIdentifierInterface
  • BREAKING: Rename Art4\JsonApiClient\Resource\IdentifierCollection to Art4\JsonApiClient\ResourceIdentifierCollection
  • BREAKING: Rename Art4\JsonApiClient\Resource\IdentifierCollectionInterface to Art4\JsonApiClient\ResourceIdentifierCollectionInterface
  • BREAKING: Rename Art4\JsonApiClient\Resource\Item to Art4\JsonApiClient\ResourceItem
  • BREAKING: Rename Art4\JsonApiClient\Resource\ItemInterface to Art4\JsonApiClient\ResourceItemInterface
  • BREAKING: Rename Art4\JsonApiClient\Resource\ItemLink to Art4\JsonApiClient\ResourceItemLink
  • BREAKING: Rename Art4\JsonApiClient\Resource\ItemLinkInterface to Art4\JsonApiClient\ResourceItemLinkInterface
  • BREAKING: Rename Art4\JsonApiClient\Resource\NullResource to Art4\JsonApiClient\ResourceNull
  • BREAKING: Rename Art4\JsonApiClient\Resource\NullResourceInterface to Art4\JsonApiClient\ResourceNullInterface

Removed

  • BREAKING: Remove the Resource\ResourceInterface and its methods

0.6.3 - 2016-04-26

Fixed

  • Prevent PHP bug in json_decode(), if option JSON_BIGINT_AS_STRING is not implemented, see #28

0.6.2 - 2016-04-15

Fixed

  • links in document object can contain objects, see #26

0.6.1 - 2015-12-28

Added

  • New Resource\ItemLink object; was seperated from Link object

Fixed

  • links and pagination are now parsed spec conform, see #23

0.6 - 2015-11-06

Added

  • Helper::isValid() checks if a string is valid JSON API

Fixed

  • BREAKING: pagination links moved from Pagination to DocumentLink and RelationshipLink

Removed

  • BREAKING: object Pagination was removed

0.5 - 2015-10-12

Added

  • Dot-notation support in AccessInterface::has() and AccessInterface::get()
  • Every object has now his own interface, eg. DocumentInterface, MetaInterface or Resource\ItemInterface

Changed

  • BREAKING: object PaginationLink was renamed to Pagination
  • BREAKING: nearly all classes was set to final and can't be extended anymore. Implement the new interfaces instead. See also #18.

0.4 - 2015-09-01

Added

  • Introduce Utils\Manager and Utils\Factory for injecting own classes into the client
  • Every object inside the document implements AccessInterface
  • AccessInterface supports asArray() for transforming an object into an array
  • A Resource\IdentifierCollection that is either empty or holds only Resource\Identifier objects

Fixed

  • Relationship::get('data') returns a Resource\IdentifierCollection object instead of an array

0.3 - 2015-08-24

Added

  • Better documentation

Changed

  • Document::get('data') returns always a ResourceInterface object
  • Document::get('error') returns a ErrorCollection object
  • Document::get('included') returns a Resource\Collection object
  • \Art4\JsonApiClient\Exception\ValidationException will be thrown instead of InvalidArgumentException
  • \Art4\JsonApiClient\Exception\AccessException will be thrown instead of RuntimeException

0.2 - 2015-08-12

Added

  • Documentation, see folder docs/
  • Every object has got a get() and has() method for better value access
  • Every object can list his own keys with keyKeys()

Removed

  • All old getter like getMeta() or hasId() were removed

0.1 - 2015-08-11

Added

  • Validator fits nearly 100% specification
  • Full test coverage