alterway/rest-hal-bundle

manage HAL Rest API with Symfony2 http://stateless.co/hal_specification.html

v0.0.2 2013-12-27 15:07 UTC

Requires

• php: ~5.3
• nocarrier/hal: ~0.9.4
• sensio/framework-extra-bundle: ~2.2
• symfony/symfony: ~2.2

Requires (Dev)

• behat/behat: ~2.5
• behat/gherkin: ~2.3
• behat/mink-browserkit-driver: ~1.1
• behat/mink-extension: ~1.2
• behat/mink-sahi-driver: ~1.1
• behat/symfony2-extension: ~1.1
• kriswallsmith/buzz: ~0.5
• phpunit/phpunit: 3.7.*

MIT

• La Ruche Qui Dit Oui!
• Alter Way
• Jean-François Lépine

README

# RestHalBundle

Bundle to manage Hal API with Symfony2.

## Installation

Edit your composer.json:

"require": {
    "alterway/rest-hal-bundle" : "master"
}

And run Composer:

php composer.phar update alterway/rest-hal-bundle

Add the following line at the end of your autoload.php:

Doctrine\Common\Annotations\AnnotationRegistry::registerLoader(array($loader, 'loadClass'));

Enable your bundle in your AppKernel.php:

// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...
        new Alterway\Bundle\RestHalBundle\AwRestHalBundle(),
    );
}

Usage

Resource

A resource is a PHP class who represents informations about elements of your applications.

For example:

// src/Alterway/DemoBundle/ApiResource/UserResource.php

namespace Alterway\DemoBundle\ApiResource;

use Alterway\Bundle\RestHalBundle\ApiResource\Resource;

class UserResource extends Resource
{
    public function __construct(RouterInterface $router, User $user)
    {
        parent::__construct($router);
        $this->user = $user;
    }

    protected function prepare()
    {
        $this->addLink('next', '/users?page=2');
        $this->addLink('search', '/users?id={user_id}');
    }

    protected function generateUri()
    {
        return $this->router->generate('demo.user', array('id' => 1));
    }
}

Controller

With annotations:

Remember to enable annotations :

sensio_framework_extra:
router:  { annotations: true }
request: { converters: true }
view:    { annotations: true }
cache:   { annotations: true }

// some controller or yours

use Alterway\DemoBundle\ApiResource\UserResource;

/**
 * @Hal(code="200")
 */
public function userWithAnnotateAction(Request $request)
{
    $user = new User;
    return new UserResource($this->get('router'), $user);
}

Without annotations:

// some controller or yours

use Alterway\Bundle\HalRestBundle\Response\HalResponse;
use Alterway\DemoBundle\ApiResource\UserResource;

public function userWithoutAnnotateAction(Request $request)
{
    $user = new User;
    $resource = new UserResource($this->get('router'), $user);
    return new HalResponse($resource, 200);
}

## Contribute

Install dev dependencies:

php composer.phar update

Run Behat:

./vendor/bin/behat @AwRestHalBundle

Copyright

Copyright (c) 2013 La Ruche Qui Dit Oui!. See LICENSE for details.

Contributors

• Jean-François Lépine (Halleck45)
• Benoît Merlet (trompette)
• Antoine Lévêque (gh0stonio)

Sponsors

• Alter Way
• La Ruche Qui Dit Oui !