💛 Modern API development in Laravel. ✍️ Developed by Gentrit Abazi.

if we try to use the filter method on a column based on an included properties like this :

{base_url}/users?filter[author.name]=Gentrit

the current implementation will crash because author.name won't be in the $whiteListFilter. if we use this modification like this we can find a way to reuse properties :

class User extends Model
{
  use HasFactory;

  public function author()
  {
      return $this->belongsTo(Author::class);
  }

  public static $whiteListFilter = ['id', 'author'];
  public static $whiteListFilteType = [null, Author::class];
}

class Author extends Model
{
  use HasFactory;

  public static $whiteListFilter = ['id', 'name'];
}

The checkFilterColumn will check the first part of the $colum variables (author.name => author) and then check the next part (name => name) against the Author::class

Like this we can filter all properties and sub-properties.

Is it possible to select certain field when requesting nested includes, like so:

include=country.continent

Say i want to select the name and the related continent from the country only, how can this be achieved? Obviousling using something like include=country:name.continent doesn't work. Also i feel like this markup tends to get a little akward when selecting relations and also specific fields, I would suggest something like the following:

include=country(name).continent

Where everything between the parenthesis is related to selecting specific fields of a relation, and the dot notation is still used for querying the relation

Normally when not using a nested include, selecting specific fields can be done like so:

include=country:name

Hi,

In LaravelController, why not use a method for parsing the limit and page parameter? Currently the parameters to retrieve these values are hardcored, like so:

$limit = $request->get('limit', $this->defaults['limit']);
$page = $request->get('page', $this->defaults['page']);

Say for example i don't want to use the 'limit' parameter to determine the number of results, but a 'per_page' parameter. Currently, to override this behaviour, a user would have to override the entire parseResourceOptions method.

I would suggest changing this into the following lines:

$limit = $this->parseLimit($request->get('limit', $this->defaults['limit']));
$page = $this->parsePage($request->get('page', $this->defaults['page']));

So in one of my controllers, i could easily override the behaviour by overriding the specific method; (example):

protected function parseLimit(?int $limit)
{
    return request()->get('per_page', $limit ?: 25);
}

Also, i would suggest the validateResourceOptions in LaravelController to be protected, since validation of pagination parameters may differ after overriding the default pagination parameters.

I've got a question about the NOT operator. Why do we need to pass a "strange" value to use the NOT operator :

{base_url}/users?filter[columnName][operator][not]=value

in this example i first thought that i could directly type [not] in the request url instead i need to use it like this :

{base_url}/users?filter[name][eq][yes]=Alex

to look for all user without a name = Alex

can it be more like this ? (it would be more user friendly, no ?)

{base_url}/users?filter[name][eq][not]=Alex

Thanks for this package, really like it

Dropped support to send array in include. Dropped support to send array in doesntHave. Dropped support to send array in has. Default sort by DESC. Dropped support to send array in withCount. Removed IDs mode. Removed Sideload mode. Dropped support to send array in scope. Dropped support to send array in append. Dropped support to send array in select. Removed Advanced Eager loading. Pagination now starts from 1 not from 0.

Actually it's not possible to filter the same property, if we use the actual api only the last filter is used. For example :

http://localhost:8080/api/items?filterByOr[code][ct]=A&filterByOr[code][ct]=B

this will only consider filterByOr[code][ct]=B because of the way php handle array (and it's totally normal)

To have multiple filters on the same property we could add this api :

{base_url}/items?filterByOr[][code][ct]=A&filterByOr[][code][ct]=B

like that we would have an array of filters : and thus the api would become :

filter / filterByOr
[]
[property]
[operator]
=
VALUE

and now the example in the doc with the filtering is correctly working :

Filter all users whose name start with Gentrit or ends with Abazi.

{base_url}/users?filterByOr[][name][sw]=Gentrit&filterByOr[][name][ew]=Abazi