kwattro/hypermedia-collection-json

Hypermedia Collection+Json Library for PHP

dev-master / 0.1.x-dev 2014-08-27 00:06 UTC

Requires

• php: >=5.3.2
• doctrine/collections: 1.*
• jms/serializer: 0.17.*@dev

Requires (Dev)

• phpspec/phpspec: 2.0@dev

MIT

• Christophe Willemsen

• json
• rest
• api
• hypermedia
• collection

README

! WIP Status

Link to the Collection+Json Specification : https://github.com/collection-json/spec

Installation

Add the library to your composer.json file

{
    "require": {
        // your other deps,
        "kwattro/hypermedia-collection-json": "0.1@dev"
    }
}

Usage

Usage of the library is simple :

Create a new Collection :

require_once 'vendor/autoload.php';

use Kwattro\Hypermedia\CollectionJson\Collection;

$collection = new Collection();
$collection->addHref('http://example.com/api/movies');

Add items to the collection

use Kwattro\Hypermedia\CollectionJson\Collection;
use Kwattro\Hypermedia\CollectionJson\Item;

$collection = new Collection();
$item = new Item();
$item->addData(array('name' => 'John', 'city' => 'Paradise City');
$item->addHref('http://example.com/user/1234/john');
$collection->addItem($item);

(De-)Serializing

In order to serialize/deserialize objects, you just need to call the Serializer create static method :

use Kwattro\Hypermedia\CollectionJson\Serializer;

// $myCollection = ... creating collection and items objects

$json = Serializer::create()->serialize($myCollection); // Returns a Json representation

// Deserializing :
$myObject = Serializer::create()->deserialize($json); // Returns a Collection object

Tests

The lib is using phpspec

Running the test suite

bin/phpspec run

TO-DO

• Implementing JMS/Serializer (partially done)
• Full compliant with Hypermedia Spec