Tools
class Tools extends AbstractFilter implements Renderable
Properties
| protected Grid | $grid | Parent grid. |
|
| protected bool | $disabled | from AbstractTool | |
| protected string | $view | from AbstractFilter | |
| 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 | from AbstractFilter | |
| protected array|string | $id | Element id. |
from AbstractFilter |
| protected string | $label | Label of presenter. |
from AbstractFilter |
| protected array|string | $value | from AbstractFilter | |
| protected array|string | $defaultValue | from AbstractFilter | |
| protected string | $column | from AbstractFilter | |
| protected Presenter | $presenter | Presenter object. |
from AbstractFilter |
| protected string | $query | Query for filter. |
from AbstractFilter |
| protected Filter | $parent | from AbstractFilter | |
| protected Collection | $tools | Collection of tools. |
Methods
Render header tools bar.
Execute the filter with conditions.
Get full url without query strings.
Get siblings of current filter.
Disable filter button.
Disable batch actions.
Append default tools.
Details
in
AbstractTool at line 27
$this
disable(bool $disable = true)
Toggle this button.
in
AbstractTool at line 37
allowed()
If the tool is allowed.
in
AbstractTool at line 49
$this
setGrid(Grid $grid)
Set parent grid.
in
AbstractTool at line 59
Grid
getGrid()
No description
at line 124
render()
Render header tools bar.
in
AbstractFilter at line 297
string
__toString()
Render this filter.
in
FilterButton at line 35
protected Filter
filter()
No description
at line 35
__construct(Grid $grid)
Create a new Tools instance.
in
Filter at line 193
string
getFilterId()
Get filter ID.
in
Filter at line 205
$this
setFilterId(string $id)
Set ID of search form.
in
Filter at line 215
string
getName()
No description
in
Filter at line 225
$this
setName($name)
No description
in
Filter at line 239
removeFilterByID(mixed $id)
Remove filter by filter id.
in
Filter at line 251
array
conditions()
Get all conditions of the filters.
in
Filter at line 290
$this
layoutOnly()
Set this filter layout only.
in
Filter at line 304
AbstractFilter
use(AbstractFilter $filter)
Use a custom filter.
in
Filter at line 314
array
filters()
Get all filters.
in
Filter at line 325
mixed
scope(string $key, string $label = '')
No description
in
Filter at line 337
Collection
getScopes()
Get all filter scopes.
in
Filter at line 378
array|Collection|mixed
execute(bool $toArray = true)
Execute the filter with conditions.
in
Filter at line 399
bool
chunk(callable $callback, int $count = 100)
No description
in
AbstractFilter at line 283
array
renderSkeleton()
No description
in
Filter at line 449
string
urlWithoutFilters()
Get url without filter queryString.
in
Filter at line 478
string
urlWithoutScopes()
Get url without scope queryString.
in
Filter at line 490
AbstractFilter
resolveFilter(string $abstract, array $arguments)
No description
in
AbstractFilter at line 310
AbstractFilter|$this
__call(string $method, $params)
No description
in
Filter at line 520
static
extend(string $name, string $filterClass)
No description
in
Filter at line 532
protected
initLayout()
Initialize filter layout.
in
Filter at line 542
protected array
sanitizeInputs($inputs)
No description
in
Filter at line 563
protected AbstractFilter
addFilter(AbstractFilter $filter)
Add a filter to grid.
in
Filter at line 582
protected array
scopeConditions()
Get scope conditions.
in
Filter at line 598
protected string
fullUrlWithoutQuery(Arrayable|array|string $keys)
Get full url without query strings.
in
Filter at line 46
AbstractFilter
equal(mixed $column, mixed $label)
No description
in
Filter at line 46
AbstractFilter
notEqual(mixed $column, mixed $label)
No description
in
Filter at line 46
AbstractFilter
leftLike(mixed $column, mixed $label)
No description
in
Filter at line 46
AbstractFilter
like(mixed $column, mixed $label)
No description
in
Filter at line 46
AbstractFilter
contains(mixed $column, mixed $label)
No description
in
Filter at line 46
AbstractFilter
startsWith(mixed $column, mixed $label)
No description
in
Filter at line 46
AbstractFilter
endsWith(mixed $column, mixed $label)
No description
in
Filter at line 46
AbstractFilter
ilike(mixed $column, mixed $label)
No description
in
Filter at line 46
AbstractFilter
gt(mixed $column, mixed $label)
No description
in
Filter at line 46
AbstractFilter
lt(mixed $column, mixed $label)
No description
in
Filter at line 46
BetweenDate
betweenDate(mixed $column, mixed $label)
No description
in
Filter at line 46
AbstractFilter
in(mixed $column, mixed $label)
No description
in
Filter at line 46
AbstractFilter
notIn(mixed $column, mixed $label)
No description
in
Filter at line 46
AbstractFilter
where(mixed $callback, mixed $label, mixed $column)
No description
in
AbstractFilter at line 237
AbstractFilter
date()
Date filter.
in
AbstractFilter at line 247
AbstractFilter
day()
Day filter.
in
AbstractFilter at line 257
AbstractFilter
month()
Month filter.
in
AbstractFilter at line 267
AbstractFilter
year()
Year filter.
in
Filter at line 46
AbstractFilter
hidden(mixed $name, mixed $value)
No description
in
Filter at line 46
AbstractFilter
group(mixed $column, mixed $label, mixed $builder)
No description
in
AbstractFilter at line 109
setParent(Filter $filter)
No description
in
AbstractFilter at line 121
AbstractFilter[]|mixed
siblings(null $index = null)
Get siblings of current filter.
in
AbstractFilter at line 137
AbstractFilter[]|mixed
previous(int $step = 1)
Get previous filter.
in
AbstractFilter at line 151
AbstractFilter[]|mixed
next(int $step = 1)
Get next filter.
in
AbstractFilter at line 165
array|mixed|null
condition(array $inputs)
Get query condition from filter.
in
AbstractFilter at line 185
Select
select(array|Collection $options = [])
Select filter.
in
AbstractFilter at line 195
MultipleSelect
multipleSelect(array|Collection $options = [])
No description
in
AbstractFilter at line 205
Radio
radio(array|Collection $options = [])
No description
in
AbstractFilter at line 215
Checkbox
checkbox(array|Collection $options = [])
No description
in
AbstractFilter at line 227
DateTime
datetime(array|Collection $options = [])
Datetime filter.
in
AbstractFilter at line 324
DateTime
time()
Time filter.
in
AbstractFilter at line 336
$this
default(null $default = null)
Set default value for filter.
in
AbstractFilter at line 350
array|string
getId()
Get element id.
in
AbstractFilter at line 362
$this
setId(string $id)
Set element id.
in
AbstractFilter at line 374
string
getColumn()
Get column name of current filter.
in
AbstractFilter at line 386
array|string
getValue()
Get value of current filter.
in
AbstractFilter at line 398
mixed
setPresenter(Presenter $presenter)
Set presenter object of filter.
in
AbstractFilter at line 410
protected void
setupDefaultPresenter()
Setup default presenter.
in
AbstractFilter at line 422
protected string
formatLabel(string $label)
Format label.
in
AbstractFilter at line 436
protected string
formatName(string $column)
Format name.
in
AbstractFilter at line 462
protected array|string
formatId($columns)
Format id.
in
AbstractFilter at line 472
protected Presenter
presenter()
Get presenter object of filter.
in
AbstractFilter at line 482
protected mixed
buildCondition()
Build conditions of filter.
in
AbstractFilter at line 498
protected array
buildRelationQuery()
Build query condition of model relation.
in
AbstractFilter at line 518
protected array
variables()
Variables for filter view.
in
AbstractFilter at line 33
Text
url()
No description
in
AbstractFilter at line 33
Text
email()
No description
in
AbstractFilter at line 33
Text
integer()
No description
in
AbstractFilter at line 33
Text
decimal(mixed $options)
No description
in
AbstractFilter at line 33
Text
currency(mixed $options)
No description
in
AbstractFilter at line 33
Text
percentage(mixed $options)
No description
in
AbstractFilter at line 33
Text
ip()
No description
in
AbstractFilter at line 33
Text
mac()
No description
in
AbstractFilter at line 33
Text
mobile(mixed $mask)
No description
in
AbstractFilter at line 33
Text
inputmask(mixed $options, mixed $icon)
No description
in
AbstractFilter at line 33
Text
placeholder(mixed $placeholder)
No description
at line 51
$this
append(AbstractTool|string $tool)
Append tools.
at line 69
$this
prepend(AbstractTool|string $tool)
Prepend a tool.
at line 82
void
disableFilterButton(bool $disable = true)
Disable filter button.
at line 101
void
disableRefreshButton(bool $disable = true)
deprecated
deprecated
Disable refresh button.
at line 112
void
disableBatchActions(bool $disable = true)
Disable batch actions.
at line 150
protected
appendDefaultTools()
Append default tools.