leexikang / fractal-commands by leexikang

Laravel commands for fractal
40
0
1
Package Data
Maintainer Username: leexikang
Maintainer Contact: leexikang@gmail.com (Min San)
Package Create Date: 2017-03-14
Package Last Update: 2017-03-17
Language: PHP
License: MIT
Last Refreshed: 2024-03-26 03:01:10
Package Statistics
Total Downloads: 40
Monthly Downloads: 1
Daily Downloads: 0
Total Stars: 0
Total Watchers: 1
Total Forks: 0
Total Open Issues: 0

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); 

:warning: 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