betalabs/engine-api-handler

Package providing relation filtering abilities to API-handler

v0.1.7 2019-09-13 17:52 UTC

This package is auto-updated.

Last update: 2020-07-13 19:47:56 UTC


README

This package allows the search and filtering of related tables data using Marcel Gwerder's API handler. It only requires that you extend the class AbstractIndexHandler, implementing the method buildQuery(), which must return Laravel's \Illuminate\Database\Eloquent\Builder object. Then, to return the query results, you must call the method execute() of that class.

For the correct functioning of the package, you must separate the related tables using "->" in the URL, instead of ".". You must also name the Eloquent methods of each related table using the exact same name of that table in the Database.

You also have to put the file apihandler.php inside the config folder of your laravel project.

Installation

Install the package via composer

$ composer require betalabs/engine-api-handler