[2.x] Update check for filtering column from include

[Angelinsky7]

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.

[gentritabazi]

If we set: public static $whiteListFilter = ['author.name']; there is no crash/problem here ?

[Angelinsky7]

yes but imagine that we have hundred of field in the sub-property and that this author object is used in hundred of other classes this becomes a nightmare to maintain.
with this solution we can define each properties only once

[gentritabazi]

Thank you very much for the contribution but I think this can be made more easier without whiteListFilteType.

[Angelinsky7]

of course, but i didn't know how to make the checkFilterColumn find the correct class.

[gentritabazi]

Hmm...

author is relationship we can grab class from relationship 🚀

[Angelinsky7]

oh ! i didn't know that (i'm pretty new to laravel) if you give me an hint to the documentation i'ld be happy to make the correct modification. (and now that i think about it, we could maybe handle both of the syntax, the author.name in the whitelist and the author)

[gentritabazi]

I think this is can be more easy for example if we want to filter all columns of author we can do something like:

$whiteListFilter = ['author.*'].

[Angelinsky7]

i also like your idea and i could also add it.
but remains my issue : i would like to use the filters set in the author model without needing to care about anything else.
For example, each time i use the author model in a relationship i would like to be able to disable the possibility to filter by created_at or updated_at fields (it's an example)
My proposal is (i hope) resolving this.

[gentritabazi]

Also ['*'] is perfect 🤩

[Angelinsky7]

So the list of possible values could be

• a field in the model
• a star for all fields and relationships (and sub-fields) in the model
• a relationship in the model (using sub-field of this relationship)
• a relationship with a star (to use all field in the relationship)

[gentritabazi]

When you set ['*'] this is mean you can filter anything including relations.

[Angelinsky7]

@gentritabazi01 normally everything is there now. i hope that everything will work correctly.

[gentritabazi]

Did you make tests locally for all cases ?

[Angelinsky7]

Yes of course, but because we don't have unit tests i would gladly prefere that you also test it 😅

[gentritabazi]

Put extra line here.

[gentritabazi]

Before line 320.

[gentritabazi]

To much code here,

Can you update like this:

---

List of all valid syntax for $whiteListFilter:

public static $whiteListFilter = ['*'];
public static $whiteListFilter = ['id', 'title', 'author'];
public static $whiteListFilter = ['id', 'title', 'author.*'];  

If the filter is ['*'] then all properties and sub-properties can be used for filtering.
If the filter is a list of model properties then only the selected properties can be filtered.
If some of the filter are a relationship then only the $whiteListFilter properties of the sub-property's model can be filtered.
If some of the filter contains a .* the all sub-properties of the relationship model can be filtered.

[gentritabazi]

This pull request has been close since there has not been any recent activity.

Please open a new pull request for related feature.