kkamkou/collection-json.php

PHP implementation of the Collection+JSON

1.1.0 2015-05-01 15:01 UTC

Requires

• php: >=5.3
• ext-json: *

MIT

• Kanstantsin Kamkou

• json
• rest
• api
• collection-json

README

PHP implementation of the Collection+JSON specification

Examples of media type in use can be found here.

Example

More examples are located in the CollectionTest.php test file

use \CollectionJson\Collection;
use \CollectionJson\Property;

$data = new Property\Data('firstName', 'Duck', 'Full name');
$link = new Property\Link('http://example.com', 'homepage', 'Homepage', 'link', 'Link to the homepage');

$item = new Collection\Item('http://example.com/item');
$item->addData($data)->addLink($link);

$collection = new Collection('http://example.com');
$collection->addItem($item);

echo $collection;

Signatures

\CollectionJson\Collection($href);

\CollectionJson\Collection\Item($href, array $setWithData = array(), array $setWithLinks = array());
\CollectionJson\Collection\Template(array $setWithData = array());
\CollectionJson\Collection\Error($title = null, $code = null, $message = null);

\CollectionJson\Property\Data($name, $value = null, $prompt = null);
\CollectionJson\Property\Link($href, $rel, $name = null, $render = null, $prompt = null);
\CollectionJson\Property\Query($href, $rel, $name = null, $prompt = null, array $data = array());

Docker

[sudo] docker build -t collection-json.php .
[sudo] docker run -v "$PWD:/opt/collection-json.php collection-json.php phpcs --standard=psr2 CollectionJson
[sudo] docker run -v "$PWD:/opt/collection-json.php collection-json.php phpunit -c tests/phpunit.xml tests

Tests

phpcs --standard=psr2 CollectionJson
phpunit -c tests/phpunit.xml tests

License

The MIT License (MIT)

Copyright (c) 2013-2015 Kanstantsin Kamkou

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.