sarala-io/laravel-companion

Laravel support library for JSON-API developers.

Important: This package is not actively maintained. For bug fixes and new features, please fork. or take a look at sarala-io/sarala, _(*1)

Sarala Laravel Companion

Laravel support package to easily develop REST API following JSON API specification., _(*2)

![Software License][ico-license] ![Coverage Status][ico-scrutinizer] ![Total Downloads][ico-downloads] , _(*3)

Install

Via Composer, _(*4)

``` bash $ composer require sarala-io/laravel-companion, <sub>(*5)</sub>

## Usage
Eloquent model implementation
```php
namespace App;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Builder;
use Sarala\Filterable;

class Post extends Model
{
    use Filterable;

    ...
}

Dedicated query filter implementation ``` php namespace App\Filters;, <sub>(*6)</sub>

use Sarala\FilterAbstract;, <sub>(*7)</sub>

class PostsFilter extends FilterAbstract { protected $lookup = [ 'my' => 'composedByMe' ];, <sub>(*8)</sub>

public function composedByMe()
{
    return $this->builder->composedBy(auth()->user());
}

...

}, <sub>(*9)</sub>

Controller implementation
```php
namespace App\Http\Controllers;

use App\Post;
use App\Filters\PostsFilter;
use App\Http\Transformers\PostTransformer;
use Sarala\JsonApiResponse;
use Illuminate\Http\Request;

class PostController extends Controller
{
    public function index(Request $request, PostsFilter $filters)
    {
        $data = Post::filter($filters)->paginateOrGet($request);

        return new JsonApiResponse($data, new PostTransformer(), 'posts');
    }

    public function show(Post $post, PostsFilter $filter)
    {
        $data = Post::filter($filter)->find($post->id);

        return new JsonApiResponse($data, new PostTransformer(), 'posts');
    }

    ...
}

Change log

Please see CHANGELOG for more information on what has changed recently., <sub>(*10)</sub>

Testing

bash $ composer test, <sub>(*11)</sub>

Contributing

Please see CONTRIBUTING and CODE_OF_CONDUCT for details., <sub>(*12)</sub>

Security

If you discover any security related issues, please email milroy.me@gmail.com instead of using the issue tracker., <sub>(*13)</sub>

Credits

• Milroy Fraser
• All Contributors

License

The MIT License (MIT). Please see License File for more information., <sub>(*14)</sub>