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

Group

class Group extends FilterItem

Properties

Collection $group from  FilterItem
protected array|string $id

Element id.

 from  FilterItem
protected string $label

Label of presenter.

 from  FilterItem
protected array|string $value from  FilterItem
protected array|string $defaultValue from  FilterItem
protected string $column from  FilterItem
protected Presenter|null $presenter

Presenter object.

 from  FilterItem
protected string $query

Query for filter.

 from  FilterItem
protected Filter $parent from  FilterItem
protected string $view from  FilterItem
mixed $input

Input value from presenter.
protected Closure|null $builder
protected string $name

Methods

__construct($column, string $label = '', Closure $builder = null)

Group constructor.

FilterItem
setParent(Filter $filter)

No description

from  FilterItem
bool
isRender()

是否可以渲染

from  FilterItem
FilterItem[]|mixed
siblings(null $index = null)

Get siblings of current filter.

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

Get previous filter.

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

Get next filter.

from  FilterItem
array|mixed|null|void
condition(array $inputs)

No description

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

Select filter.

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

No description

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

No description

from  FilterItem
View|string
render()

No description

mixed
__call($method, $params)

No description

from  FilterItem
$this
default(null $default = null)

Set default value for filter.

from  FilterItem
array|string
getId()

Get element id.

from  FilterItem
FilterItem
setId(string $id)

Set element id.

from  FilterItem
string
getColumn()

Get column name of current filter.

from  FilterItem
array|string
getValue()

Get value of current filter.

from  FilterItem
mixed
setPresenter(Presenter $presenter)

Set presenter object of filter.

from  FilterItem
Text
setupDefaultPresenter()

Setup default presenter.

from  FilterItem
string
formatLabel(string $label)

Format label.

from  FilterItem
string
formatName(string $column)

Format name.

from  FilterItem
array|string
formatId(string $column)

Format id.

from  FilterItem
mixed
buildCondition()

Build conditions of filter.

from  FilterItem
array
buildRelationQuery()

Build query condition of model relation.

from  FilterItem
array
variables()

No description

Text
url()

No description

from  FilterItem
Text
email()

No description

from  FilterItem
Text
integer()

No description

from  FilterItem
Text
decimal(mixed $options)

No description

from  FilterItem
Text
currency(mixed $options)

No description

from  FilterItem
Text
percentage(mixed $options)

No description

from  FilterItem
Text
ip()

No description

from  FilterItem
Text
mac()

No description

from  FilterItem
Text
mobile(mixed $mask)

No description

from  FilterItem
Text
inputmask(mixed $options, mixed $icon)

No description

from  FilterItem
Text
placeholder(mixed $placeholder)

No description

from  FilterItem
Group
equal(string $label = '', string $operator = '=')

Filter out equal records.

Group
notEqual(string $label = '')

Filter out not equal records.

Group
gt(string $label = '')

Filter out greater then records.

Group
lt(string $label = '')

Filter out less then records.

Group
where(string $label, Closure $builder)

Specify a where query.

Group
like(string $label = '', string $operator = 'like')

Specify a where like query.

Group
contains(string $label = '')

Alias of like method.

Group
ilike(string $label = '')

Specify a where ilike query.

Group
nlt(string $label = '')

Filter out not less then records.

Group
ngt(string $label = '')

Filter out not greater than records.

Group
match(string $label = '')

Filter out records that match the regex.

Group
startWith(string $label = '')

Filter out records which starts with input query.

Group
endWith(string $label = '')

Filter out records which ends with input query.

initialize()

Initialize a group filter.

$this
joinGroup(string $label, array $condition)

Join a query to group.

Details

at line 35
__construct($column, string $label = '', Closure $builder = null)

Group constructor.

Parameters

$column
string $label
Closure $builder

in FilterItem at line 112
FilterItem setParent(Filter $filter)

No description

Parameters

Filter $filter

Return Value

FilterItem

in FilterItem at line 123
bool isRender()

是否可以渲染

Return Value

bool

in FilterItem at line 135
FilterItem[]|mixed siblings(null $index = null)

Get siblings of current filter.

Parameters

null $index

Return Value

FilterItem[]|mixed

in FilterItem at line 151
FilterItem[]|mixed previous(int $step = 1)

Get previous filter.

Parameters

int $step

Return Value

FilterItem[]|mixed

in FilterItem at line 165
FilterItem[]|mixed next(int $step = 1)

Get next filter.

Parameters

int $step

Return Value

FilterItem[]|mixed

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

No description

Parameters

array $inputs

Return Value

array|mixed|null|void

in FilterItem at line 199
Select select(array|Collection $options = [])

Select filter.

Parameters

array|Collection $options

Return Value

Select

in FilterItem at line 209
MultipleSelect multipleSelect(array|Collection $options = [])

No description

Parameters

array|Collection $options

Return Value

MultipleSelect

in FilterItem at line 219
Radio radio(array|Collection $options = [])

No description

Parameters

array|Collection $options

Return Value

Radio

at line 202
View|string render()

No description

Return Value

View|string

in FilterItem at line 245
mixed __call($method, $params)

No description

Parameters

$method
$params

Return Value

mixed

Exceptions

Exception

in FilterItem at line 261
$this default(null $default = null)

Set default value for filter.

Parameters

null $default

Return Value

$this

in FilterItem at line 275
array|string getId()

Get element id.

Return Value

array|string

in FilterItem at line 287
FilterItem setId(string $id)

Set element id.

Parameters

string $id

Return Value

FilterItem

in FilterItem at line 298
string getColumn()

Get column name of current filter.

Return Value

string

in FilterItem at line 310
array|string getValue()

Get value of current filter.

Return Value

array|string

in FilterItem at line 320
mixed setPresenter(Presenter $presenter)

Set presenter object of filter.

Parameters

Presenter $presenter

Return Value

mixed

in FilterItem at line 331
protected Text setupDefaultPresenter()

Setup default presenter.

Return Value

Text

in FilterItem at line 343
protected string formatLabel(string $label)

Format label.

Parameters

string $label

Return Value

string

in FilterItem at line 357
protected string formatName(string $column)

Format name.

Parameters

string $column

Return Value

string

in FilterItem at line 383
protected array|string formatId(string $column)

Format id.

Parameters

string $column

Return Value

array|string

in FilterItem at line 393
protected mixed buildCondition()

Build conditions of filter.

Return Value

mixed

in FilterItem at line 409
protected array buildRelationQuery()

Build query condition of model relation.

Return Value

array

at line 187
array variables()

No description

Return Value

array

in FilterItem at line 32
Text url()

No description

Return Value

Text

in FilterItem at line 32
Text email()

No description

Return Value

Text

in FilterItem at line 32
Text integer()

No description

Return Value

Text

in FilterItem at line 32
Text decimal(mixed $options)

No description

Parameters

mixed $options

Return Value

Text

in FilterItem at line 32
Text currency(mixed $options)

No description

Parameters

mixed $options

Return Value

Text

in FilterItem at line 32
Text percentage(mixed $options)

No description

Parameters

mixed $options

Return Value

Text

in FilterItem at line 32
Text ip()

No description

Return Value

Text

in FilterItem at line 32
Text mac()

No description

Return Value

Text

in FilterItem at line 32
Text mobile(mixed $mask)

No description

Parameters

mixed $mask

Return Value

Text

in FilterItem at line 32
Text inputmask(mixed $options, mixed $icon)

No description

Parameters

mixed $options
mixed $icon

Return Value

Text

in FilterItem at line 32
Text placeholder(mixed $placeholder)

No description

Parameters

mixed $placeholder

Return Value

Text

at line 59
Group equal(string $label = '', string $operator = '=')

Filter out equal records.

Parameters

string $label
string $operator

Return Value

Group

at line 75
Group notEqual(string $label = '')

Filter out not equal records.

Parameters

string $label

Return Value

Group

at line 87
Group gt(string $label = '')

Filter out greater then records.

Parameters

string $label

Return Value

Group

at line 99
Group lt(string $label = '')

Filter out less then records.

Parameters

string $label

Return Value

Group

at line 112
Group where(string $label, Closure $builder)

Specify a where query.

Parameters

string $label
Closure $builder

Return Value

Group

at line 129
Group like(string $label = '', string $operator = 'like')

Specify a where like query.

Parameters

string $label
string $operator

Return Value

Group

at line 145
Group contains(string $label = '')

Alias of like method.

Parameters

string $label

Return Value

Group

at line 157
Group ilike(string $label = '')

Specify a where ilike query.

Parameters

string $label

Return Value

Group

at line 218
Group nlt(string $label = '')

Filter out not less then records.

Parameters

string $label

Return Value

Group

at line 230
Group ngt(string $label = '')

Filter out not greater than records.

Parameters

string $label

Return Value

Group

at line 242
Group match(string $label = '')

Filter out records that match the regex.

Parameters

string $label

Return Value

Group

at line 256
Group startWith(string $label = '')

Filter out records which starts with input query.

Parameters

string $label

Return Value

Group

at line 272
Group endWith(string $label = '')

Filter out records which ends with input query.

Parameters

string $label

Return Value

Group

at line 284
protected initialize()

Initialize a group filter.

at line 301
protected $this joinGroup(string $label, array $condition)

Join a query to group.

Parameters

string $label
array $condition

Return Value

$this