vice/laravel-fractal

Fractal helpers for Laravel 5

v0.1.1 2016-07-13 11:26 UTC

Requires

• illuminate/container: 5.*
• illuminate/http: 5.*
• illuminate/pagination: 5.*
• illuminate/support: 5.*
• league/fractal: ^0.13.0

Requires (Dev)

• friendsofphp/php-cs-fixer: 1.*
• mockery/mockery: ^0.9.5
• phpunit/phpunit: ^5.4

MIT

• Max Brokman

README

Fractal lets you present API data in a consistent way, by acting as an anti-corruption layer between your frontend and backend.

Read up on Fractal here.

Installation

Require this package

composer require vice/laravel-fractal

And then add the following to the service providers in app.php

Vice\LaravelFractal\FractalServiceProvider::class,

Usage

To send a JSON representation of a single entity to the frontend simply

public function show($id)
{
    //...

    fractalResponse()->item($thing, new ThingTransformer);
}

To send a JSON representation of a collection of entities to the frontend simply

public function index()
{
    //...

    fractalResponse()->collection($things, new ThingTransformer);
}

The collection method also supports paginators, and will automatically append their state under a meta key

If you need to transform data without immediately using it in a response you may inject Vice\LaravelFractal\FractalService into your controller / class and use it as so:

$json = $this->fractalService->item($thing, new ThingTransformer)->toJson();

Contributing

Please open any issues or pull requests on GitHub. This package is maintained by [e-mail]

For PRs please run the style fixer (vendor/bin/php-cs-fixer fix) before submitting.