Skip to content

Commit

Permalink
Hotfix docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
gentritabazi committed Jun 22, 2021
1 parent 73038a5 commit 58f63e4
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions docs/filtering.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,13 @@ 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 `['*']` 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.

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.

For more advanced use cases, [custom filter](advanced_usage?id=custom-filter) can be used.

Expand Down

0 comments on commit 58f63e4

Please sign in to comment.