trait HasFilters (View source)

Properties

protected BaseFilter> $filters
protected Closure|null $filtersFormSchema
protected int $filtersFormColumns
protected string|Closure|null $filtersFormMaxHeight
protected MaxWidth|string|Closure|null $filtersFormWidth
protected FiltersLayout|Closure|null $filtersLayout
protected Closure|null $modifyFiltersTriggerActionUsing
protected bool|Closure|null $persistsFiltersInSession
protected bool|Closure $shouldDeselectAllRecordsWhenFiltered
protected bool|Closure $hasDeferredFilters
protected Closure|null $modifyFiltersApplyActionUsing

Methods

deferFilters(bool|Closure $condition = true)

No description

bool
hasDeferredFilters()

No description

filtersApplyAction(Closure|null $callback)

No description

deselectAllRecordsWhenFiltered(bool|Closure $condition = true)

No description

filters(array $filters, FiltersLayout|string|Closure|null $layout = null)

No description

pushFilters(array $filters)

No description

filtersFormColumns(int|array|Closure|null $columns)

No description

filtersFormMaxHeight(string|Closure|null $height)

No description

filtersFormWidth(MaxWidth|string|Closure|null $width)

No description

filtersLayout(FiltersLayout|Closure|null $filtersLayout)

No description

filtersTriggerAction(Closure|null $callback)

No description

persistFiltersInSession(bool|Closure $condition = true)

No description

array
getFilters()

No description

BaseFilter|null
getFilter(string $name)

No description

getFiltersForm()

No description

filtersFormSchema(Closure|null $schema)

No description

array
getFiltersFormSchema()

No description

getFiltersTriggerAction()

No description

getFiltersApplyAction()

No description

int|array
getFiltersFormColumns()

No description

string|null
getFiltersFormMaxHeight()

No description

MaxWidth|string|null
getFiltersFormWidth()

No description

FiltersLayout
getFiltersLayout()

No description

bool
isFilterable()

No description

bool
persistsFiltersInSession()

No description

bool
int
getActiveFiltersCount()

No description

bool
isFiltered()

No description

Details

HasFilters deferFilters(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

HasFilters

bool hasDeferredFilters()

No description

Return Value

bool

HasFilters filtersApplyAction(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

HasFilters

HasFilters deselectAllRecordsWhenFiltered(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

HasFilters

HasFilters filters(array $filters, FiltersLayout|string|Closure|null $layout = null)

No description

Parameters

array $filters
FiltersLayout|string|Closure|null $layout

Return Value

HasFilters

HasFilters pushFilters(array $filters)

No description

Parameters

array $filters

Return Value

HasFilters

HasFilters filtersFormColumns(int|array|Closure|null $columns)

No description

Parameters

int|array|Closure|null $columns

Return Value

HasFilters

HasFilters filtersFormMaxHeight(string|Closure|null $height)

No description

Parameters

string|Closure|null $height

Return Value

HasFilters

HasFilters filtersFormWidth(MaxWidth|string|Closure|null $width)

No description

Parameters

MaxWidth|string|Closure|null $width

Return Value

HasFilters

HasFilters filtersLayout(FiltersLayout|Closure|null $filtersLayout)

No description

Parameters

FiltersLayout|Closure|null $filtersLayout

Return Value

HasFilters

HasFilters filtersTriggerAction(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

HasFilters

HasFilters persistFiltersInSession(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

HasFilters

array getFilters()

No description

Return Value

array

BaseFilter|null getFilter(string $name)

No description

Parameters

string $name

Return Value

BaseFilter|null

Form getFiltersForm()

No description

Return Value

Form

HasFilters filtersFormSchema(Closure|null $schema)

No description

Parameters

Closure|null $schema

Return Value

HasFilters

array getFiltersFormSchema()

No description

Return Value

array

Action getFiltersTriggerAction()

No description

Return Value

Action

Action getFiltersApplyAction()

No description

Return Value

Action

int|array getFiltersFormColumns()

No description

Return Value

int|array

| array<string, int | null>

string|null getFiltersFormMaxHeight()

No description

Return Value

string|null

MaxWidth|string|null getFiltersFormWidth()

No description

Return Value

MaxWidth|string|null

FiltersLayout getFiltersLayout()

No description

Return Value

FiltersLayout

bool isFilterable()

No description

Return Value

bool

bool persistsFiltersInSession()

No description

Return Value

bool

bool shouldDeselectAllRecordsWhenFiltered()

No description

Return Value

bool

int getActiveFiltersCount()

No description

Return Value

int

bool isFiltered()

No description

Return Value

bool