joshuaestes/hal

This package is abandoned and no longer maintained. No replacement package was suggested.

Provides HAL json/xml support

dev-master / 1.0.x-dev 2013-04-27 21:46 UTC

Requires (Dev)

• phpunit/phpunit: *

MIT

• Joshua Estes

• json
• xml
• hal

README

This package is used to create hal json. It's quick and dirty and the only reason it exists is for my own education. Feel free to use it.

Usage

<?php

use JoshuaEstes\Hal\Link;
use JoshuaEstes\Hal\Resource;

// This is required, you need to give the location of where the user is at
$resource = new Resource(new Link('/location', 'self'));

// Define a new resource
$productResource        = new Resource(new Link('/product/123', 'self'), 'products');
$productResource->title = 'Test Product';

// Add the resource to your main resource
$resource->addResource($productResource);

// You can add more links too
$resource->addLink(new Link('/location/next', 'next'));
$resource->addLink(new Link('/location/previous', 'previous'));

// Now you can dump the json
echo $resource->asJson();

Testing

Be sure to install composer.phar

php composer.phar install --dev
php bin/phpunit