Index
A
- Field::apply() — Method in class Field
- Apply filter to query
- Filterer::addSortable() — Method in class Filterer
- Add sortable column
- Filterer::addFilterColumn() — Method in class Filterer
- Add filter column with a callback
- Filterer::addIdColumn() — Method in class Filterer
- Add ID column
- AndGroup — Class in namespace Meiko\Filterable\Groups
- AND Group
- AndGroup::apply() — Method in class AndGroup
- Apply fields to query
- Group::addField() — Method in class Group
- Add new field to group
- OrGroup::apply() — Method in class OrGroup
- Apply fields to query
- Sort::apply() — Method in class Sort
- Apply sort to query
B
- $Field#baseClassname — Property in class Field
- Base classname
- $Filterer#baseClassname — Property in class Filterer
- Base classname
C
- $Field#callback — Property in class Field
- Possible query callback
- Filterer::checkForRequiredColumns() — Method in class Filterer
- Check for required columns in filter
D
- $Sort#direction — Property in class Sort
- Sort direction
F
- Field — Class in namespace Meiko\Filterable
- Filter field
- Filterable — Class in namespace Meiko\Filterable
- Filterable trait class
- Filterer — Class in namespace Meiko\Filterable
- Main filterer class
- $Filterer#filterColumnCallbacks — Property in class Filterer
- Filter column callbacks
- $Group#fields — Property in class Group
- Group fields
G
- Field::getKey() — Method in class Field
- Get field key
- Field::getType() — Method in class Field
- Get field comparison type based on field value
- Field::getModelId() — Method in class Field
- Resolve model id from key
- Field::getValue() — Method in class Field
- Get field value
- $Filterer#groups — Property in class Filterer
- Filter groups
- Filterer::getSearchQuery() — Method in class Filterer
- Get search query
- Filterer::getSortables() — Method in class Filterer
- Get sortables
- Filterer::getGroups() — Method in class Filterer
- Get filter groups
- Filterer::getSearchGroup() — Method in class Filterer
- Get search filter group
- Group — Class in namespace Meiko\Filterable\Groups
- Abstract base group
I
- Field::isIdKey() — Method in class Field
- Is filter key an id key
- $Filterer#idColumns — Property in class Filterer
- ID columns
- $Filterer#ignorePrefix — Property in class Filterer
- Ignore keys prefixed with _
- $Filterer#ignoreKeys — Property in class Filterer
- Ignore "include" and "page" keys
K
O
- OrGroup — Class in namespace Meiko\Filterable\Groups
- OR group
P
- Filterer::parseSortable() — Method in class Filterer
- Parse sortable strings
- Filterer::parseRequest() — Method in class Filterer
- Parse HTTP request
Q
- $Filterer#queryKey — Property in class Filterer
- Key for searching
R
- $Filterer#requiredColumns — Property in class Filterer
- Required filter columns
- Filterer::requireColumn() — Method in class Filterer
- Require specific column in filter
S
- Field::setBaseClassname() — Method in class Field
- Set base classname to use against id-filters
- Filterable::scopeFilters() — Method in class Filterable
- Apply filterer to query
- $Filterer#searchQuery — Property in class Filterer
- Search query
- $Filterer#sortables — Property in class Filterer
- Sortables
- $Filterer#sortableColumns — Property in class Filterer
- Sortable columns
- $Filterer#searchableColumns — Property in class Filterer
- Searchable columns
- $Filterer#sortKey — Property in class Filterer
- Key for sortables
- Filterer::setSearchableColumns() — Method in class Filterer
- Set searchable columns
- Filterer::setSortableColumns() — Method in class Filterer
- Set sortable columns
- Filterer::setBaseClassname() — Method in class Filterer
- Set base classname to use against id-filters
- Sort — Class in namespace Meiko\Filterable
- Sortable column
T
- $Field#types — Property in class Field
- Available comparison types and their query counterparts
V
- $Field#value — Property in class Field
- Filter value
W
- $Field#wildcard — Property in class Field
- Query wildcard character
_
- Field::__construct() — Method in class Field
- Create a new field instance
- Sort::__construct() — Method in class Sort
- Create new sortable column instance