1. class
  2. Poppy
  3. \
  4. System
  5. \
  6. Classes
  7. \
  8. Grid
  9. \
  10. Filter
  11. \
  12. AbstractFilter

AbstractFilter

abstract class AbstractFilter extends Filter

Class AbstractFilter.

Properties

protected Grid $grid from  AbstractTool
protected bool $disabled from  AbstractTool
protected string $view
bool $expand 是否展开 from  Filter
protected Model $model 当前的模型 from  Filter
protected array $filters from  Filter
protected string $action 搜索表单的筛选条件 from  Filter
protected string $filterId from  Filter
protected string $name from  Filter
protected Collection $scopes from  Filter
protected Layout $layout from  Filter
protected bool $thisFilterLayoutOnly

Set this filter only in the layout.

 from  Filter
protected array $layoutOnlyFilterColumns

Columns of filter that are layout-only.

 from  Filter
protected mixed $primaryKey

Primary key of giving model.

 from  Filter
static protected array $supports from  Filter
Collection $group
protected array|string $id

Element id.
protected string $label

Label of presenter.
protected array|string $value
protected array|string $defaultValue
protected string $column
protected Presenter $presenter

Presenter object.
protected string $query

Query for filter.
protected Filter $parent

Methods

$this
disable(bool $disable = true)

Toggle this button.

from  AbstractTool
allowed()

If the tool is allowed.

from  AbstractTool
$this
setGrid(Grid $grid)

Set parent grid.

from  AbstractTool
Grid
getGrid()

No description

from  AbstractTool
render()

Render this filter.

string
__toString()

Render this filter.

Filter
filter()

No description

from  FilterButton
__construct($column, string $label = '')

AbstractFilter constructor.

Filter
setAction(string $action)

Set action of search form.

from  Filter
Model
getModel()

Get grid model.

from  Filter
string
getFilterId()

Get filter ID.

from  Filter
$this
setFilterId(string $id)

Set ID of search form.

from  Filter
string
getName()

No description

from  Filter
$this
setName($name)

No description

from  Filter
removeFilterByID(mixed $id)

Remove filter by filter id.

from  Filter
array
conditions()

Get all conditions of the filters.

from  Filter
$this
layoutOnly()

Set this filter layout only.

from  Filter
AbstractFilter
use(AbstractFilter $filter)

Use a custom filter.

from  Filter
array
filters()

Get all filters.

from  Filter
mixed
scope(string $key, string $label = '')

No description

from  Filter
Collection
getScopes()

Get all filter scopes.

from  Filter
Scope|null
getCurrentScope()

Get current scope.

from  Filter
Filter
column(int|float $width, Closure $closure)

Add a new layout column.

from  Filter
array|Collection|mixed
execute(bool $toArray = true)

Execute the filter with conditions.

from  Filter
bool
chunk(callable $callback, int $count = 100)

No description

from  Filter
array
renderSkeleton()

No description

string
urlWithoutFilters()

Get url without filter queryString.

from  Filter
string
urlWithoutScopes()

Get url without scope queryString.

from  Filter
AbstractFilter
resolveFilter(string $abstract, array $arguments)

No description

from  Filter
AbstractFilter|$this
__call(string $method, $params)

No description

static 
extend(string $name, string $filterClass)

No description

from  Filter
initLayout()

Initialize filter layout.

from  Filter
array
sanitizeInputs($inputs)

No description

from  Filter
AbstractFilter
addFilter(AbstractFilter $filter)

Add a filter to grid.

from  Filter
array
scopeConditions()

Get scope conditions.

from  Filter
string
fullUrlWithoutQuery(Arrayable|array|string $keys)

Get full url without query strings.

from  Filter
AbstractFilter
equal(mixed $column, mixed $label)

No description

from  Filter
AbstractFilter
notEqual(mixed $column, mixed $label)

No description

from  Filter
AbstractFilter
leftLike(mixed $column, mixed $label)

No description

from  Filter
AbstractFilter
like(mixed $column, mixed $label)

No description

from  Filter
AbstractFilter
contains(mixed $column, mixed $label)

No description

from  Filter
AbstractFilter
startsWith(mixed $column, mixed $label)

No description

from  Filter
AbstractFilter
endsWith(mixed $column, mixed $label)

No description

from  Filter
AbstractFilter
ilike(mixed $column, mixed $label)

No description

from  Filter
AbstractFilter
gt(mixed $column, mixed $label)

No description

from  Filter
AbstractFilter
lt(mixed $column, mixed $label)

No description

from  Filter
Between
between(mixed $column, mixed $label)

No description

from  Filter
BetweenDate
betweenDate(mixed $column, mixed $label)

No description

from  Filter
AbstractFilter
in(mixed $column, mixed $label)

No description

from  Filter
AbstractFilter
notIn(mixed $column, mixed $label)

No description

from  Filter
AbstractFilter
where(mixed $callback, mixed $label, mixed $column)

No description

from  Filter
AbstractFilter
date()

Date filter.

AbstractFilter
day()

Day filter.

AbstractFilter
month()

Month filter.

AbstractFilter
year()

Year filter.

AbstractFilter
hidden(mixed $name, mixed $value)

No description

from  Filter
AbstractFilter
group(mixed $column, mixed $label, mixed $builder)

No description

from  Filter
setParent(Filter $filter)

No description

AbstractFilter[]|mixed
siblings(null $index = null)

Get siblings of current filter.

AbstractFilter[]|mixed
previous(int $step = 1)

Get previous filter.

AbstractFilter[]|mixed
next(int $step = 1)

Get next filter.

array|mixed|null
condition(array $inputs)

Get query condition from filter.

Select
select(array|Collection $options = [])

Select filter.

MultipleSelect
multipleSelect(array|Collection $options = [])

No description

Radio
radio(array|Collection $options = [])

No description

Checkbox
checkbox(array|Collection $options = [])

No description

DateTime
datetime(array|Collection $options = [])

Datetime filter.

DateTime
time()

Time filter.

$this
default(null $default = null)

Set default value for filter.

array|string
getId()

Get element id.

$this
setId(string $id)

Set element id.

string
getColumn()

Get column name of current filter.

array|string
getValue()

Get value of current filter.

mixed
setPresenter(Presenter $presenter)

Set presenter object of filter.

void
setupDefaultPresenter()

Setup default presenter.

string
formatLabel(string $label)

Format label.

string
formatName(string $column)

Format name.

array|string
formatId($columns)

Format id.

Presenter
presenter()

Get presenter object of filter.

mixed
buildCondition()

Build conditions of filter.

array
buildRelationQuery()

Build query condition of model relation.

array
variables()

Variables for filter view.

Text
url()

No description

Text
email()

No description

Text
integer()

No description

Text
decimal(mixed $options)

No description

Text
currency(mixed $options)

No description

Text
percentage(mixed $options)

No description

Text
ip()

No description

Text
mac()

No description

Text
mobile(mixed $mask)

No description

Text
inputmask(mixed $options, mixed $icon)

No description

Text
placeholder(mixed $placeholder)

No description

Details

in AbstractTool at line 27
$this disable(bool $disable = true)

Toggle this button.

Parameters

bool $disable

Return Value

$this

in AbstractTool at line 37
allowed()

If the tool is allowed.

in AbstractTool at line 49
$this setGrid(Grid $grid)

Set parent grid.

Parameters

Grid $grid

Return Value

$this

in AbstractTool at line 59
Grid getGrid()

No description

Return Value

Grid

at line 277
render()

Render this filter.

at line 297
string __toString()

Render this filter.

Return Value

string

in FilterButton at line 35
protected Filter filter()

No description

Return Value

Filter

at line 97
__construct($column, string $label = '')

AbstractFilter constructor.

Parameters

$column
string $label

in Filter at line 166
Filter setAction(string $action)

Set action of search form.

Parameters

string $action

Return Value

Filter

in Filter at line 178
Model getModel()

Get grid model.

Return Value

Model

in Filter at line 193
string getFilterId()

Get filter ID.

Return Value

string

in Filter at line 205
$this setFilterId(string $id)

Set ID of search form.

Parameters

string $id

Return Value

$this

in Filter at line 215
string getName()

No description

Return Value

string

in Filter at line 225
$this setName($name)

No description

Parameters

$name

Return Value

$this

in Filter at line 239
removeFilterByID(mixed $id)

Remove filter by filter id.

Parameters

mixed $id

in Filter at line 251
array conditions()

Get all conditions of the filters.

Return Value

array

in Filter at line 290
$this layoutOnly()

Set this filter layout only.

Return Value

$this

in Filter at line 304
AbstractFilter use(AbstractFilter $filter)

Use a custom filter.

Parameters

AbstractFilter $filter

Return Value

AbstractFilter

in Filter at line 314
array filters()

Get all filters.

Return Value

array

in Filter at line 325
mixed scope(string $key, string $label = '')

No description

Parameters

string $key
string $label

Return Value

mixed

in Filter at line 337
Collection getScopes()

Get all filter scopes.

Return Value

Collection

in Filter at line 347
Scope|null getCurrentScope()

Get current scope.

Return Value

Scope|null

in Filter at line 364
Filter column(int|float $width, Closure $closure)

Add a new layout column.

Parameters

int|float $width
Closure $closure

Return Value

Filter

in Filter at line 378
array|Collection|mixed execute(bool $toArray = true)

Execute the filter with conditions.

Parameters

bool $toArray

Return Value

array|Collection|mixed

in Filter at line 399
bool chunk(callable $callback, int $count = 100)

No description

Parameters

callable $callback
int $count

Return Value

bool

at line 283
array renderSkeleton()

No description

Return Value

array

in Filter at line 449
string urlWithoutFilters()

Get url without filter queryString.

Return Value

string

in Filter at line 478
string urlWithoutScopes()

Get url without scope queryString.

Return Value

string

in Filter at line 490
AbstractFilter resolveFilter(string $abstract, array $arguments)

No description

Parameters

string $abstract
array $arguments

Return Value

AbstractFilter

Exceptions

ApplicationException

at line 310
AbstractFilter|$this __call(string $method, $params)

No description

Parameters

string $method
$params

Return Value

AbstractFilter|$this

Exceptions

Exception

in Filter at line 520
static extend(string $name, string $filterClass)

No description

Parameters

string $name
string $filterClass

in Filter at line 532
protected initLayout()

Initialize filter layout.

in Filter at line 542
protected array sanitizeInputs($inputs)

No description

Parameters

$inputs

Return Value

array

in Filter at line 563
protected AbstractFilter addFilter(AbstractFilter $filter)

Add a filter to grid.

Parameters

AbstractFilter $filter

Return Value

AbstractFilter

in Filter at line 582
protected array scopeConditions()

Get scope conditions.

Return Value

array

in Filter at line 598
protected string fullUrlWithoutQuery(Arrayable|array|string $keys)

Get full url without query strings.

Parameters

Arrayable|array|string $keys

Return Value

string

in Filter at line 46
AbstractFilter equal(mixed $column, mixed $label)

No description

Parameters

mixed $column
mixed $label

Return Value

AbstractFilter

in Filter at line 46
AbstractFilter notEqual(mixed $column, mixed $label)

No description

Parameters

mixed $column
mixed $label

Return Value

AbstractFilter

in Filter at line 46
AbstractFilter leftLike(mixed $column, mixed $label)

No description

Parameters

mixed $column
mixed $label

Return Value

AbstractFilter

in Filter at line 46
AbstractFilter like(mixed $column, mixed $label)

No description

Parameters

mixed $column
mixed $label

Return Value

AbstractFilter

in Filter at line 46
AbstractFilter contains(mixed $column, mixed $label)

No description

Parameters

mixed $column
mixed $label

Return Value

AbstractFilter

in Filter at line 46
AbstractFilter startsWith(mixed $column, mixed $label)

No description

Parameters

mixed $column
mixed $label

Return Value

AbstractFilter

in Filter at line 46
AbstractFilter endsWith(mixed $column, mixed $label)

No description

Parameters

mixed $column
mixed $label

Return Value

AbstractFilter

in Filter at line 46
AbstractFilter ilike(mixed $column, mixed $label)

No description

Parameters

mixed $column
mixed $label

Return Value

AbstractFilter

in Filter at line 46
AbstractFilter gt(mixed $column, mixed $label)

No description

Parameters

mixed $column
mixed $label

Return Value

AbstractFilter

in Filter at line 46
AbstractFilter lt(mixed $column, mixed $label)

No description

Parameters

mixed $column
mixed $label

Return Value

AbstractFilter

in Filter at line 46
Between between(mixed $column, mixed $label)

No description

Parameters

mixed $column
mixed $label

Return Value

Between

in Filter at line 46
BetweenDate betweenDate(mixed $column, mixed $label)

No description

Parameters

mixed $column
mixed $label

Return Value

BetweenDate

in Filter at line 46
AbstractFilter in(mixed $column, mixed $label)

No description

Parameters

mixed $column
mixed $label

Return Value

AbstractFilter

in Filter at line 46
AbstractFilter notIn(mixed $column, mixed $label)

No description

Parameters

mixed $column
mixed $label

Return Value

AbstractFilter

in Filter at line 46
AbstractFilter where(mixed $callback, mixed $label, mixed $column)

No description

Parameters

mixed $callback
mixed $label
mixed $column

Return Value

AbstractFilter

at line 237
AbstractFilter date()

Date filter.

Return Value

AbstractFilter

at line 247
AbstractFilter day()

Day filter.

Return Value

AbstractFilter

at line 257
AbstractFilter month()

Month filter.

Return Value

AbstractFilter

at line 267
AbstractFilter year()

Year filter.

Return Value

AbstractFilter

in Filter at line 46
AbstractFilter hidden(mixed $name, mixed $value)

No description

Parameters

mixed $name
mixed $value

Return Value

AbstractFilter

in Filter at line 46
AbstractFilter group(mixed $column, mixed $label, mixed $builder)

No description

Parameters

mixed $column
mixed $label
mixed $builder

Return Value

AbstractFilter

at line 109
setParent(Filter $filter)

No description

Parameters

Filter $filter

at line 121
AbstractFilter[]|mixed siblings(null $index = null)

Get siblings of current filter.

Parameters

null $index

Return Value

AbstractFilter[]|mixed

at line 137
AbstractFilter[]|mixed previous(int $step = 1)

Get previous filter.

Parameters

int $step

Return Value

AbstractFilter[]|mixed

at line 151
AbstractFilter[]|mixed next(int $step = 1)

Get next filter.

Parameters

int $step

Return Value

AbstractFilter[]|mixed

at line 165
array|mixed|null condition(array $inputs)

Get query condition from filter.

Parameters

array $inputs

Return Value

array|mixed|null

at line 185
Select select(array|Collection $options = [])

Select filter.

Parameters

array|Collection $options

Return Value

Select

at line 195
MultipleSelect multipleSelect(array|Collection $options = [])

No description

Parameters

array|Collection $options

Return Value

MultipleSelect

at line 205
Radio radio(array|Collection $options = [])

No description

Parameters

array|Collection $options

Return Value

Radio

at line 215
Checkbox checkbox(array|Collection $options = [])

No description

Parameters

array|Collection $options

Return Value

Checkbox

at line 227
DateTime datetime(array|Collection $options = [])

Datetime filter.

Parameters

array|Collection $options

Return Value

DateTime

at line 324
DateTime time()

Time filter.

Return Value

DateTime

at line 336
$this default(null $default = null)

Set default value for filter.

Parameters

null $default

Return Value

$this

at line 350
array|string getId()

Get element id.

Return Value

array|string

at line 362
$this setId(string $id)

Set element id.

Parameters

string $id

Return Value

$this

at line 374
string getColumn()

Get column name of current filter.

Return Value

string

at line 386
array|string getValue()

Get value of current filter.

Return Value

array|string

at line 398
mixed setPresenter(Presenter $presenter)

Set presenter object of filter.

Parameters

Presenter $presenter

Return Value

mixed

at line 410
protected void setupDefaultPresenter()

Setup default presenter.

Return Value

void

at line 422
protected string formatLabel(string $label)

Format label.

Parameters

string $label

Return Value

string

at line 436
protected string formatName(string $column)

Format name.

Parameters

string $column

Return Value

string

at line 462
protected array|string formatId($columns)

Format id.

Parameters

$columns

Return Value

array|string

at line 472
protected Presenter presenter()

Get presenter object of filter.

Return Value

Presenter

at line 482
protected mixed buildCondition()

Build conditions of filter.

Return Value

mixed

at line 498
protected array buildRelationQuery()

Build query condition of model relation.

Return Value

array

at line 518
protected array variables()

Variables for filter view.

Return Value

array

at line 33
Text url()

No description

Return Value

Text

at line 33
Text email()

No description

Return Value

Text

at line 33
Text integer()

No description

Return Value

Text

at line 33
Text decimal(mixed $options)

No description

Parameters

mixed $options

Return Value

Text

at line 33
Text currency(mixed $options)

No description

Parameters

mixed $options

Return Value

Text

at line 33
Text percentage(mixed $options)

No description

Parameters

mixed $options

Return Value

Text

at line 33
Text ip()

No description

Return Value

Text

at line 33
Text mac()

No description

Return Value

Text

at line 33
Text mobile(mixed $mask)

No description

Parameters

mixed $mask

Return Value

Text

at line 33
Text inputmask(mixed $options, mixed $icon)

No description

Parameters

mixed $options
mixed $icon

Return Value

Text

at line 33
Text placeholder(mixed $placeholder)

No description

Parameters

mixed $placeholder

Return Value

Text