README

Symfony bundle that allows you easily create JSON/XML API response from the different types of objects.

Getting Started

Composer

The best way to install ResponseBuilderBundle is through Composer.

Add itr/responsebuilder-bundle as a dependency in your project's composer.json file:

{
    "require": {
        "itr/responsebuilder-bundle": "dev-master"
    }
}

Install your dependencies:

$ php composer.phar update itr/responsebuilder-bundle

Enable the bundle

<?php
// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...
        new Itr\ResponseBuilderBundle\ItrResponseBuilderBundle(),
    );
}

Configuration

You can specify default builder format in your config.yml file:

itr_response_builder:
    default_format: json
    # default_format: json

Basic Usage

ResponseBuilder

You can get ResponseBuilderFactory class directly:

<?php
    // creates factory object
    $responseBuilderFactory = new ResponseBuilderFactory('json');
    // gets default builder (here default format is json)
    $responseBuilder = $responseBuilderFactory->getDefault();
    // gets builder by specified format
    $responseBuilder = $responseBuilder->getBuilderForFormat('yml');

Or from service container for example from symfony controller:

<?php
    $responseBuilderFactory = $this->get('response_builder_factory');
    // gets default builder (default format could be specified in the configurations file like described above)
    $responseBuilder = $responseBuilderFactory->getDefault();

ParameterBag

Simple example:

<?php
    $pb = new ParameterBag();
    $pb->{'level.second.third'} = 'hi';
    $array = $pb->toArray();
    // array('level' => array('second' => array('third' => 'hi'));

    $responseBuilderFactory = $this->get('response_builder_factory');
    $responseBuilder = $responseBuilderFactory->getDefault();
    // return Response object with parameter bag processed into specified format (json or xml)
    $response = $responseBuilder->build($pb);

Simple Doctrine entity example:

Let say we have account entity like this:

<?php
    class Account
    {
        private $id;

        private $username;

        private $email;

        // getters and setters below
        ...
    }

Now you can process it this way:

<?php
    $account = new Account();
    $account->setUsername('noname');
    $account->setEmail('test@example.com');
    $account->setPassword('123456');

    $pb = new ParameterBag();
    $pb->{'account'} = $account;
    $array = $pb->toArray();

    /*
        Account entity processed as array:

        array('account' => array(
                'username' => 'noname',
                'email' => 'test@example.com',
                'password' => '123456',
        );
    */

    // then you can change any value by accessing it directly by its path:
    $pb->{'account.username'} = 'some new username';

    $responseBuilderFactory = $this->get('response_builder_factory');
    $responseBuilder = $responseBuilderFactory->getDefault();
    $response = $responseBuilder->build($pb);

Complex Doctrine entity example:

Let say account also have reference on a profile object:

<?php
    class Account
    {
        private $id;

        private $username;

        private $email;

        // Profile
        private $profile;

        // getters and setters below
        ...
    }

Profile entity:

<?php
    class Profile
    {
        private $id;

        private $fullname;

        private $age;

        // getters and setters below
        ...
    }

Processing entity with subentity:

<?php
    $profile = new Profile();
    $profile->setFullname('Jack Jonson');
    $profile->setAge(37);

    $account = new Account();
    $account->setUsername('noname');
    $account->setEmail('test@example.com');
    $account->setPassword('123456');
    $account->setProfile($profile);

    $pb = new ParameterBag();
    $pb->{'account'} = $account;
    $array = $pb->toArray();

    /*
        Entity with sub entity will be processed like this:

        array('account' => array(
                'username' => 'noname',
                'email' => 'test@example.com',
                'password' => '123456',
                'profile' => array(
                    'fullname' => 'Jack Jonson',
                    'age' => 37,
                )
        );
    */

TODO

ParameterBag code refactoring.

itr / responsebuilder-bundle

Maintainers

Details