README

Siren hypermedia type implementation for PHP

Introduction

Siren is a hypermedia specification for representing entities. As HTML is used for visually representing documents on a Web site, Siren is a specification for presenting entities via a Web API. Siren offers structures to communicate information about entities, actions for executing state transitions, and links for client navigation.

See siren specification

Installing with composer

composer.phar require jefersondaniel/siren-php

Encoding a resource

$collection = new SirenPHP\Entity(
    '/collection/1',
    ['count' => 3],
    ['collection']
);
$entity = new SirenPHP\Entity(
    '/book/1',
    ['name' => 'The Book 1'],
    ['book']
);
$collection->appendEntity(['item'], $entity);
$link = new SirenPHP\Link(['next'], '/collection/2');
$collection->appendLink($link);
  
echo (string) $collection;