1. class
  2. Filament
  3. \
  4. Tables
  5. \
  6. Grouping
  7. \
  8. Group

Group

class Group extends Component (View source)

Traits

Conditionable
Configurable
EvaluatesClosures
Macroable
Tappable

Properties

protected string $evaluationIdentifier from  EvaluatesClosures
static protected Closure>> $macros from  Macroable
protected string|null $column
protected Closure|null $getDescriptionFromRecordUsing
protected Closure|null $getKeyFromRecordUsing
protected Closure|null $getTitleFromRecordUsing
protected Closure|null $groupQueryUsing
protected Closure|null $orderQueryUsing
protected Closure|null $scopeQueryUsing
protected Closure|null $scopeQueryByKeyUsing
protected string|null $label
protected string $id
protected bool $isCollapsible
protected bool $isTitlePrefixedWithLabel
protected bool $isDate

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

from  Configurable
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
__construct(string|null $id = null)

No description

static Group
make(string|null $id = null)

No description

Group
collapsible(bool $condition = true)

No description

Group
column(string|null $column)

No description

Group
date(bool $condition = true)

No description

Group
id(string $id)

No description

Group
label(string|null $label)

No description

Group
getDescriptionFromRecordUsing(Closure|null $callback)

No description

Group
getDescriptionUsing(Closure|null $callback) deprecated

No description

Group
getTitleFromRecordUsing(Closure|null $callback)

No description

Group
getKeyFromRecordUsing(Closure|null $callback)

No description

Group
groupQueryUsing(Closure|null $callback)

No description

Group
orderQueryUsing(Closure|null $callback)

No description

Group
scopeQueryUsing(Closure|null $callback)

No description

Group
scopeQueryByKeyUsing(Closure|null $callback)

No description

Group
titlePrefixedWithLabel(bool $condition = true)

No description

bool
isCollapsible()

No description

bool
isTitlePrefixedWithLabel()

No description

string
getColumn()

No description

string
getId()

No description

string
getLabel()

No description

string|null
getDescription(Model $record, string|null $title)

No description

string|null
getStringKey(Model $record)

No description

mixed
getKey(Model $record)

No description

string|null
getTitle(Model $record)

No description

Builder
groupQuery(Builder $query, Model $model)

No description

Builder
orderQuery(Builder $query, string $direction)

No description

Builder
getSortColumnForQuery(Builder $query, string $sortColumn, array|null $relationships = null, Relation|null $lastRelationship = null)

No description

Builder
scopeQuery(Builder $query, Model $record)

No description

Builder
scopeQueryByKey(Builder $query, string $key)

No description

Builder
applyDefaultScopeToQuery(Builder $query, string $column, mixed $value)

No description

Relation|null
getRelationship(Model $record, string|null $name = null)

No description

string
getRelationshipAttribute(string|null $name = null)

No description

string|null
getRelationshipName(string|null $name = null)

No description

bool
isDate()

No description

Builder
applyEagerLoading(Builder $query)

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

in Configurable at line 30
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

at line 46
final __construct(string|null $id = null)

No description

Parameters

string|null $id

at line 51
static Group make(string|null $id = null)

No description

Parameters

string|null $id

Return Value

Group

at line 59
Group collapsible(bool $condition = true)

No description

Parameters

bool $condition

Return Value

Group

at line 66
Group column(string|null $column)

No description

Parameters

string|null $column

Return Value

Group

at line 73
Group date(bool $condition = true)

No description

Parameters

bool $condition

Return Value

Group

at line 80
Group id(string $id)

No description

Parameters

string $id

Return Value

Group

at line 87
Group label(string|null $label)

No description

Parameters

string|null $label

Return Value

Group

at line 94
Group getDescriptionFromRecordUsing(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

Group

at line 104
Group getDescriptionUsing(Closure|null $callback) deprecated

deprecated Use the `getDescriptionFromRecordUsing()` method instead.

No description

Parameters

Closure|null $callback

Return Value

Group

at line 111
Group getTitleFromRecordUsing(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

Group

at line 118
Group getKeyFromRecordUsing(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

Group

at line 125
Group groupQueryUsing(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

Group

at line 132
Group orderQueryUsing(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

Group

at line 139
Group scopeQueryUsing(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

Group

at line 146
Group scopeQueryByKeyUsing(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

Group

at line 153
Group titlePrefixedWithLabel(bool $condition = true)

No description

Parameters

bool $condition

Return Value

Group

at line 160
bool isCollapsible()

No description

Return Value

bool

at line 165
bool isTitlePrefixedWithLabel()

No description

Return Value

bool

at line 170
string getColumn()

No description

Return Value

string

at line 175
string getId()

No description

Return Value

string

at line 180
string getLabel()

No description

Return Value

string

at line 190
string|null getDescription(Model $record, string|null $title)

No description

Parameters

Model $record
string|null $title

Return Value

string|null

at line 209
string|null getStringKey(Model $record)

No description

Parameters

Model $record

Return Value

string|null

at line 228
mixed getKey(Model $record)

No description

Parameters

Model $record

Return Value

mixed

at line 249
string|null getTitle(Model $record)

No description

Parameters

Model $record

Return Value

string|null

at line 284
Builder groupQuery(Builder $query, Model $model)

No description

Parameters

Builder $query
Model $model

Return Value

Builder

at line 306
Builder orderQuery(Builder $query, string $direction)

No description

Parameters

Builder $query
string $direction

Return Value

Builder

at line 322
protected Builder getSortColumnForQuery(Builder $query, string $sortColumn, array|null $relationships = null, Relation|null $lastRelationship = null)

No description

Parameters

Builder $query
string $sortColumn
array|null $relationships
Relation|null $lastRelationship

Return Value

Builder

at line 353
Builder scopeQuery(Builder $query, Model $record)

No description

Parameters

Builder $query
Model $record

Return Value

Builder

at line 375
Builder scopeQueryByKey(Builder $query, string $key)

No description

Parameters

Builder $query
string $key

Return Value

Builder

at line 400
protected Builder applyDefaultScopeToQuery(Builder $query, string $column, mixed $value)

No description

Parameters

Builder $query
string $column
mixed $value

Return Value

Builder

at line 409
Relation|null getRelationship(Model $record, string|null $name = null)

No description

Parameters

Model $record
string|null $name

Return Value

Relation|null

at line 431
string getRelationshipAttribute(string|null $name = null)

No description

Parameters

string|null $name

Return Value

string

at line 442
string|null getRelationshipName(string|null $name = null)

No description

Parameters

string|null $name

Return Value

string|null

at line 453
bool isDate()

No description

Return Value

bool

at line 458
Builder applyEagerLoading(Builder $query)

No description

Parameters

Builder $query

Return Value

Builder