1. class
  2. Filament
  3. \
  4. Tables
  5. \
  6. Filters
  7. \
  8. QueryBuilder

QueryBuilder

class QueryBuilder extends BaseFilter (View source)

Traits

HasConstraints
BelongsToTable
CanBeHidden
CanResetState
CanSpanColumns
HasColumns
HasDefaultState
HasFormSchema
HasIndicators
HasLabel
HasName
InteractsWithTableQuery
Conditionable
Conditionable
Configurable
EvaluatesClosures
Macroable
Tappable

Properties

protected string $evaluationIdentifier from  EvaluatesClosures
static protected Closure>> $macros from  Macroable
protected Table $table from  BelongsToTable
protected bool|Closure $isHidden from  CanBeHidden
protected bool|Closure $isVisible from  CanBeHidden
protected array<string,mixed> $resetState from  CanResetState
protected array|int|string|Closure|null $columnSpan from  CanSpanColumns
protected array|int|string|Closure|null $columnStart from  CanSpanColumns
protected array|int|string|null $columns from  HasColumns
protected mixed $defaultState from  HasDefaultState
protected Component[] $formSchema from  HasFormSchema
protected Closure|null $modifyFormFieldUsing from  HasFormSchema
protected string|Closure|null $indicateUsing from  HasIndicators
protected Htmlable|Closure|null $indicator from  HasIndicators
protected string|Closure|null $label from  HasLabel
protected bool $shouldTranslateLabel from  HasLabel
protected string $name from  HasName
protected Closure|null $modifyQueryUsing from  InteractsWithTableQuery
protected Closure|null $modifyBaseQueryUsing from  InteractsWithTableQuery
protected Constraint[] $constraints from  HasConstraints
protected array|null $constraintPickerColumns
protected string|Closure|null $constraintPickerWidth

Methods

static mixed
configureUsing(Closure $modifyUsing, Closure|null $during = null, bool $isImportant = false)

No description

from  Configurable
Configurable
configure()

No description

from  Configurable
void
setUp()

No description

mixed
evaluate(mixed $value, array $namedInjections = [], array $typedInjections = [])

No description

from  EvaluatesClosures
mixed
resolveClosureDependencyForEvaluation(ReflectionParameter $parameter, array $namedInjections, array $typedInjections)

No description

from  EvaluatesClosures
array
resolveDefaultClosureDependencyForEvaluationByName(string $parameterName)

No description

from  EvaluatesClosures
array
resolveDefaultClosureDependencyForEvaluationByType(string $parameterType)

No description

from  EvaluatesClosures
string|null
getTypedReflectionParameterClassName(ReflectionParameter $parameter)

No description

from  EvaluatesClosures
static void
macro(string $name, callable $macro)

No description

from  Macroable
static void
mixin(object $mixin, bool $replace = true)

No description

from  Macroable
static void
flushMacros()

No description

from  Macroable
static mixed
__callStatic(string $method, array $parameters)

No description

from  Macroable
mixed
__call(string $method, array $parameters)

No description

from  Macroable
static callable|null
getMacro(string $method)

No description

from  Macroable
BelongsToTable
table(Table $table)

No description

from  BelongsToTable
Table
getTable()

No description

from  BelongsToTable
HasTable
getLivewire()

No description

from  BelongsToTable
array
getState()

No description

from  BelongsToTable
CanBeHidden
hidden(bool|Closure $condition = true)

No description

from  CanBeHidden
CanBeHidden
hiddenOn(string|array $livewireComponents)

No description

from  CanBeHidden
CanBeHidden
visible(bool|Closure $condition = true)

No description

from  CanBeHidden
CanBeHidden
visibleOn(string|array $livewireComponents)

No description

from  CanBeHidden
bool
isHidden()

No description

from  CanBeHidden
bool
isVisible()

No description

from  CanBeHidden
CanResetState
resetState(array|Closure|null $state)

No description

from  CanResetState
array
getResetState()

No description

from  CanResetState
CanSpanColumns
columnSpan(array|int|string|Closure|null $span)

No description

from  CanSpanColumns
CanSpanColumns
columnSpanFull()

No description

from  CanSpanColumns
CanSpanColumns
columnStart(array|int|string|Closure|null $start)

No description

from  CanSpanColumns
array|int|string|Closure|null
getColumnSpan()

No description

from  CanSpanColumns
array|int|string|Closure|null
getColumnStart()

No description

from  CanSpanColumns
HasColumns
columns(array|int|string|null $columns = 2)

No description

from  HasColumns
array|int|string|null
getColumns()

No description

from  HasColumns
HasDefaultState
default(mixed $state = true)

No description

from  HasDefaultState
mixed
getDefaultState()

No description

from  HasDefaultState
HasFormSchema
form(array|Closure|null $schema)

No description

from  HasFormSchema
HasFormSchema
modifyFormFieldUsing(Closure|null $callback)

No description

from  HasFormSchema
array
getFormSchema()

No description

from  HasFormSchema
bool
hasFormSchema()

No description

from  HasFormSchema
Field|null
getFormField()

No description

from  HasFormSchema
ComponentContainer
getForm()

No description

from  HasFormSchema
HasIndicators
indicator(Htmlable|Closure|null $indicator)

No description

from  HasIndicators
HasIndicators
indicateUsing(Closure|null $callback)

No description

from  HasIndicators
array
getIndicators()

No description

from  HasIndicators
Htmlable
getIndicator()

No description

from  HasIndicators
HasLabel
label(string|Closure|null $label)

No description

from  HasLabel
HasLabel
translateLabel(bool $shouldTranslateLabel = true)

No description

from  HasLabel
string
getLabel()

No description

from  HasLabel
HasName
name(string $name)

No description

from  HasName
string
getName()

No description

from  HasName
Builder
apply(Builder $query, array $data = [])

No description

from  InteractsWithTableQuery
Builder
applyToBaseQuery(Builder $query, array $data = [])

No description

from  InteractsWithTableQuery
InteractsWithTableQuery
query(Closure|null $callback)

No description

from  InteractsWithTableQuery
InteractsWithTableQuery
baseQuery(Closure|null $callback)

No description

from  InteractsWithTableQuery
InteractsWithTableQuery
modifyQueryUsing(Closure|null $callback)

No description

from  InteractsWithTableQuery
InteractsWithTableQuery
modifyBaseQueryUsing(Closure|null $callback)

No description

from  InteractsWithTableQuery
bool
hasQueryModificationCallback()

No description

from  InteractsWithTableQuery
bool
hasBaseQueryModificationCallback()

No description

from  InteractsWithTableQuery
__construct(string $name)

No description

from  BaseFilter
static BaseFilter
make(string|null $name = null)

No description

from  BaseFilter
static string|null
getDefaultName()

No description

int
getActiveCount()

No description

HasConstraints
constraints(array $constraints)

No description

from  HasConstraints
array
getConstraints()

No description

from  HasConstraints
Constraint|null
getConstraint(string $name)

No description

from  HasConstraints
int
countRules(array $rules, RuleBuilder $ruleBuilder)

No description

Builder
applyRulesToQuery(Builder $query, array $rules, RuleBuilder $ruleBuilder)

No description

Builder
applyRulesToBaseQuery(Builder $query, array $rules, RuleBuilder $ruleBuilder)

No description

QueryBuilder
constraintPickerColumns(array|int|string|null $columns = 2)

No description

array|int|string|null
getConstraintPickerColumns(string|null $breakpoint = null)

No description

QueryBuilder
constraintPickerWidth(string|Closure|null $width)

No description

string|null
getConstraintPickerWidth()

No description

RuleBuilder
getRuleBuilder()

No description

RuleBuilder
getNestedRuleBuilder(ComponentContainer $ruleBuilderBlockContainer, string $orGroupIndex)

No description

void
tapOperatorFromRule(array $rule, ComponentContainer $ruleBuilderBlockContainer, Closure $callback)

No description

Details

in Configurable at line 10
static mixed configureUsing(Closure $modifyUsing, Closure|null $during = null, bool $isImportant = false)

No description

Parameters

Closure $modifyUsing
Closure|null $during
bool $isImportant

Return Value

mixed

in Configurable at line 20
Configurable configure()

No description

Return Value

Configurable

at line 26
protected void setUp()

No description

Return Value

void

in EvaluatesClosures at line 23
mixed evaluate(mixed $value, array $namedInjections = [], array $typedInjections = [])

No description

Parameters

mixed $value
array $namedInjections
array $typedInjections

Return Value

mixed

in EvaluatesClosures at line 42
protected mixed resolveClosureDependencyForEvaluation(ReflectionParameter $parameter, array $namedInjections, array $typedInjections)

No description

Parameters

ReflectionParameter $parameter
array $namedInjections
array $typedInjections

Return Value

mixed

in EvaluatesClosures at line 104
protected array resolveDefaultClosureDependencyForEvaluationByName(string $parameterName)

No description

Parameters

string $parameterName

Return Value

array

in EvaluatesClosures at line 112
protected array resolveDefaultClosureDependencyForEvaluationByType(string $parameterType)

No description

Parameters

string $parameterType

Return Value

array

in EvaluatesClosures at line 117
protected string|null getTypedReflectionParameterClassName(ReflectionParameter $parameter)

No description

Parameters

ReflectionParameter $parameter

Return Value

string|null

in Macroable at line 17
static void macro(string $name, callable $macro)

No description

Parameters

string $name
callable $macro

Return Value

void

in Macroable at line 22
static void mixin(object $mixin, bool $replace = true)

No description

Parameters

object $mixin
bool $replace

Return Value

void

in Macroable at line 37
static void flushMacros()

No description

Return Value

void

in Macroable at line 45
static mixed __callStatic(string $method, array $parameters)

No description

Parameters

string $method
array $parameters

Return Value

mixed

in Macroable at line 67
mixed __call(string $method, array $parameters)

No description

Parameters

string $method
array $parameters

Return Value

mixed

in Macroable at line 86
static protected callable|null getMacro(string $method)

No description

Parameters

string $method

Return Value

callable|null

in BelongsToTable at line 12
BelongsToTable table(Table $table)

No description

Parameters

Table $table

Return Value

BelongsToTable

in BelongsToTable at line 19
Table getTable()

No description

Return Value

Table

in BelongsToTable at line 24
HasTable getLivewire()

No description

Return Value

HasTable

in BelongsToTable at line 32
array getState()

No description

Return Value

array

in CanBeHidden at line 15
CanBeHidden hidden(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanBeHidden

in CanBeHidden at line 25
CanBeHidden hiddenOn(string|array $livewireComponents)

No description

Parameters

string|array $livewireComponents

Return Value

CanBeHidden

in CanBeHidden at line 40
CanBeHidden visible(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanBeHidden

in CanBeHidden at line 50
CanBeHidden visibleOn(string|array $livewireComponents)

No description

Parameters

string|array $livewireComponents

Return Value

CanBeHidden

in CanBeHidden at line 65
bool isHidden()

No description

Return Value

bool

in CanBeHidden at line 74
bool isVisible()

No description

Return Value

bool

in CanResetState at line 17
CanResetState resetState(array|Closure|null $state)

No description

Parameters

array|Closure|null $state

Return Value

CanResetState

in CanResetState at line 27
array getResetState()

No description

Return Value

array

in CanSpanColumns at line 22
CanSpanColumns columnSpan(array|int|string|Closure|null $span)

No description

Parameters

array|int|string|Closure|null $span

Return Value

CanSpanColumns

in CanSpanColumns at line 29
CanSpanColumns columnSpanFull()

No description

Return Value

CanSpanColumns

in CanSpanColumns at line 39
CanSpanColumns columnStart(array|int|string|Closure|null $start)

No description

Parameters

array|int|string|Closure|null $start

Return Value

CanSpanColumns

in CanSpanColumns at line 49
array|int|string|Closure|null getColumnSpan()

No description

Return Value

array|int|string|Closure|null

in CanSpanColumns at line 57
array|int|string|Closure|null getColumnStart()

No description

Return Value

array|int|string|Closure|null

in HasColumns at line 15
HasColumns columns(array|int|string|null $columns = 2)

No description

Parameters

array|int|string|null $columns

Return Value

HasColumns

in HasColumns at line 25
array|int|string|null getColumns()

No description

Return Value

array|int|string|null

in HasDefaultState at line 9
HasDefaultState default(mixed $state = true)

No description

Parameters

mixed $state

Return Value

HasDefaultState

in HasDefaultState at line 16
mixed getDefaultState()

No description

Return Value

mixed

in HasFormSchema at line 22
HasFormSchema form(array|Closure|null $schema)

No description

Parameters

array|Closure|null $schema

Return Value

HasFormSchema

in HasFormSchema at line 29
HasFormSchema modifyFormFieldUsing(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

HasFormSchema

in HasFormSchema at line 39
array getFormSchema()

No description

Return Value

array

in HasFormSchema at line 68
bool hasFormSchema()

No description

Return Value

bool

in HasFormSchema at line 73
Field|null getFormField()

No description

Return Value

Field|null

in HasFormSchema at line 78
ComponentContainer getForm()

No description

Return Value

ComponentContainer

in HasIndicators at line 16
HasIndicators indicator(Htmlable|Closure|null $indicator)

No description

Parameters

Htmlable|Closure|null $indicator

Return Value

HasIndicators

in HasIndicators at line 23
HasIndicators indicateUsing(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

HasIndicators

in HasIndicators at line 33
array getIndicators()

No description

Return Value

array

in HasIndicators at line 63
Htmlable getIndicator()

No description

Return Value

Htmlable

in HasLabel at line 13
HasLabel label(string|Closure|null $label)

No description

Parameters

string|Closure|null $label

Return Value

HasLabel

in HasLabel at line 20
HasLabel translateLabel(bool $shouldTranslateLabel = true)

No description

Parameters

bool $shouldTranslateLabel

Return Value

HasLabel

in HasLabel at line 27
string getLabel()

No description

Return Value

string

in HasName at line 9
HasName name(string $name)

No description

Parameters

string $name

Return Value

HasName

in HasName at line 16
string getName()

No description

Return Value

string

in InteractsWithTableQuery at line 17
Builder apply(Builder $query, array $data = [])

No description

Parameters

Builder $query
array $data

Return Value

Builder

in InteractsWithTableQuery at line 43
Builder applyToBaseQuery(Builder $query, array $data = [])

No description

Parameters

Builder $query
array $data

Return Value

Builder

in InteractsWithTableQuery at line 66
InteractsWithTableQuery query(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

InteractsWithTableQuery

in InteractsWithTableQuery at line 73
InteractsWithTableQuery baseQuery(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

InteractsWithTableQuery

in InteractsWithTableQuery at line 80
InteractsWithTableQuery modifyQueryUsing(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

InteractsWithTableQuery

in InteractsWithTableQuery at line 87
InteractsWithTableQuery modifyBaseQueryUsing(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

InteractsWithTableQuery

in InteractsWithTableQuery at line 94
protected bool hasQueryModificationCallback()

No description

Return Value

bool

in InteractsWithTableQuery at line 99
protected bool hasBaseQueryModificationCallback()

No description

Return Value

bool

in BaseFilter at line 26
final __construct(string $name)

No description

Parameters

string $name

in BaseFilter at line 31
static BaseFilter make(string|null $name = null)

No description

Parameters

string|null $name

Return Value

BaseFilter

at line 52
static string|null getDefaultName()

No description

Return Value

string|null

at line 57
int getActiveCount()

No description

Return Value

int

in HasConstraints at line 16
HasConstraints constraints(array $constraints)

No description

Parameters

array $constraints

Return Value

HasConstraints

in HasConstraints at line 32
array getConstraints()

No description

Return Value

array

in HasConstraints at line 37
Constraint|null getConstraint(string $name)

No description

Parameters

string $name

Return Value

Constraint|null

at line 65
protected int countRules(array $rules, RuleBuilder $ruleBuilder)

No description

Parameters

array $rules
RuleBuilder $ruleBuilder

Return Value

int

at line 98
Builder applyRulesToQuery(Builder $query, array $rules, RuleBuilder $ruleBuilder)

No description

Parameters

Builder $query
array $rules
RuleBuilder $ruleBuilder

Return Value

Builder

at line 136
Builder applyRulesToBaseQuery(Builder $query, array $rules, RuleBuilder $ruleBuilder)

No description

Parameters

Builder $query
array $rules
RuleBuilder $ruleBuilder

Return Value

Builder

at line 166
QueryBuilder constraintPickerColumns(array|int|string|null $columns = 2)

No description

Parameters

array|int|string|null $columns

Return Value

QueryBuilder

at line 185
array|int|string|null getConstraintPickerColumns(string|null $breakpoint = null)

No description

Parameters

string|null $breakpoint

Return Value

array|int|string|null

at line 203
QueryBuilder constraintPickerWidth(string|Closure|null $width)

No description

Parameters

string|Closure|null $width

Return Value

QueryBuilder

at line 210
string|null getConstraintPickerWidth()

No description

Return Value

string|null

at line 215
protected RuleBuilder getRuleBuilder()

No description

Return Value

RuleBuilder

at line 226
protected RuleBuilder getNestedRuleBuilder(ComponentContainer $ruleBuilderBlockContainer, string $orGroupIndex)

No description

Parameters

ComponentContainer $ruleBuilderBlockContainer
string $orGroupIndex

Return Value

RuleBuilder

at line 243
protected void tapOperatorFromRule(array $rule, ComponentContainer $ruleBuilderBlockContainer, Closure $callback)

No description

Parameters

array $rule
ComponentContainer $ruleBuilderBlockContainer
Closure $callback

Return Value

void