weierophinney / hal

ABANDONED; use zendframework/zend-expressive-hal instead.

Hypertext Application Language (HAL) for PSR-7 Applications

ABANDONED

Please use the package zendframework/zend-expressive-hal instead, as development has moved to that repository.

This library provides provides utilities for modeling HAL resources with links and generating PSR-7 responses representing both JSON and XML serializations of them.

Installation

Run the following to install this library:

$ composer require weierophinney/hal

Documentation

Documentation is in the doc tree, and can be compiled using mkdocs:

$ mkdocs build

You may also browse the documentation online.

hal's Issues

Provide a simpler way to use custom extractors

As far as I understood the code, the way to provide a custom extractor is to register it among the hydrators.

Could it be an idea to allow the extractor parameter in the ResourceMetadata classes to be an object, and not only a string, to allow users to pass directly an instance of ExtractionInterface?

Make `$hydrators` optional in `ResourceGenerator` class

If I am not wrong, the $hydrators parameter of the ResourceGenerator class is used only in the ExtractInstance trait, which is not used if only the ResourceGenerator::fromArray method is called.

This suggests that $hydrators may be optional.

The method ResourceGenerator::getHydrators() could have ?ContainerInterface return type and a check could be added in ExtractInstance trait, throwing an exception if $hydrators is null.

Moreover, if #7 makes sense, using hydrators may not be needed even when using fromObject.