min/fractalcommands

Laravel commands for fractal

dev-master / 0.1.4.x-dev 2017-03-17 06:48 UTC

This package is not auto-updated.

Last update: 2024-12-21 21:36:50 UTC


README

Fractal-commands commands for using Fractal on Laravel's project.

For more about Fractal Please go to Fractal Document.

Install

composer require min/fractalcommands
add service provider

dd class to config/app.php

Min\FractalCommands\FractalCommandsServiceProvider::class

Commands

  • php artisan fractal:init (create App/Api/Tranformer/ and Controllers/ApiControler)
  • php artisan tranformer:create {Tranformer} --model={model} (Create Tranformer in App\Api\Tranformer)

Usages

To use fractal on your controller, extend the Controller first which is created by the fractal:init command. Then call the tranform method povided by the Api Controller and pass the Sepcific tranformer class.

$this->transform(Post::all(), new PostTransformer); 

To tranform single item (model), use tranform command

$this->transform(Post::find(1), new PostTransformer); 

⚠️ Call the parenet's (ApiController) constructor if you want to extend the Controller's constructor

parent::__construct(); 

The tranformer:create command will create the layout for your Tranformer in the App/Api/Tranformer Directory.

Licence

MIT