QuickFilter
class QuickFilter extends TwillBaseFilter (View source)
Properties
| protected string|null | $label | from TwillBaseFilter | |
| protected string|null | $queryString | from TwillBaseFilter | |
| protected bool | $enabled | from TwillBaseFilter | |
| protected Closure|null | $apply | from TwillBaseFilter | |
| protected Closure|null | $amount | ||
| protected string|null | $scope | ||
| protected bool | $isDefaultQuickFilter |
Methods
No description
Set the query string to use in the url
When passing a boolean, the filter will only be enabled when it is true.
When passing a boolean, the filter will be disabled when it is true.
No description
No description
The scope to apply.
No description
Details
Builder
applyFilter(Builder $builder)
No description
final
__construct()
No description
static TwillBaseFilter
make()
No description
TwillBaseFilter
label(string $label)
Set a label to use for the filter.
string|null
getLabel()
No description
TwillBaseFilter
queryString(string $queryString)
Set the query string to use in the url
string
getQueryString()
No description
TwillBaseFilter
onlyEnableWhen(bool $enable = true)
When passing a boolean, the filter will only be enabled when it is true.
TwillBaseFilter
disable(bool $disable = true)
When passing a boolean, the filter will be disabled when it is true.
TwillBaseFilter
apply(Closure $closure)
The closure to apply the filter.
bool
isEnabled()
No description
QuickFilter
amount(Closure $callback)
The callback that will tell the filter how many results there are.
bool
isDefault()
No description
QuickFilter
default()
No description
QuickFilter
scope(string $scope)
The scope to apply.
array
toArray()
No description