1. class
  2. Filament
  3. \
  4. Tables
  5. \
  6. Columns
  7. \
  8. Summarizers
  9. \
  10. Summarizer

Summarizer

class Summarizer extends ViewComponent (View source)

Traits

BelongsToColumn
CanBeHidden
CanFormatState
HasLabel
InteractsWithTableQuery
HasExtraAttributes
Conditionable
Configurable
EvaluatesClosures
Macroable
Tappable

Properties

protected string $evaluationIdentifier
static protected Closure>> $macros from  Macroable
protected string $view
protected string|Closure|null $defaultView from  ViewComponent
protected array<string,mixed> $viewData from  ViewComponent
protected string $viewIdentifier
protected Column $column from  BelongsToColumn
protected bool|Closure $isHidden from  CanBeHidden
protected bool|Closure $isVisible from  CanBeHidden
protected Closure|null $formatStateUsing from  CanFormatState
protected string|Closure|null $placeholder from  CanFormatState
protected Htmlable|Closure|null $prefix from  CanFormatState
protected Htmlable|Closure|null $suffix from  CanFormatState
protected bool|Closure $isHtml from  CanFormatState
protected bool|Closure $isMarkdown from  CanFormatState
protected string|Closure|null $label from  HasLabel
protected bool $shouldTranslateLabel from  HasLabel
protected Closure|null $modifyQueryUsing from  InteractsWithTableQuery
protected Builder|null $query from  InteractsWithTableQuery
protected array $extraAttributes from  HasExtraAttributes
protected string|null $id
protected array<string,mixed> $selectedState
protected Closure|null $using

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

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
ViewComponent
view(string|null $view, array $viewData = [])

No description

from  ViewComponent
ViewComponent
defaultView(string|Closure|null $view)

No description

from  ViewComponent
array
extractPublicMethods()

No description

from  ViewComponent
ViewComponent
viewData(array $data)

No description

from  ViewComponent
string
getView()

No description

from  ViewComponent
string|null
getDefaultView()

No description

from  ViewComponent
string
toHtml()

No description

from  ViewComponent
View
render()

No description

from  ViewComponent
BelongsToColumn
column(Column $column)

No description

from  BelongsToColumn
Column
getColumn()

No description

from  BelongsToColumn
Table
getTable()

No description

from  BelongsToColumn
HasTable
getLivewire()

No description

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

No description

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

No description

from  CanBeHidden
bool
isHidden()

No description

from  CanBeHidden
bool
isVisible()

No description

from  CanBeHidden
CanFormatState
formatStateUsing(Closure|null $callback)

No description

from  CanFormatState
CanFormatState
limit(int $length = 100, string|null $end = '...')

No description

from  CanFormatState
CanFormatState
money(string|Closure|null $currency = null, int $divideBy = 0, string|Closure|null $locale = null)

No description

from  CanFormatState
CanFormatState
numeric(int|Closure|null $decimalPlaces = null, ArgumentValue $decimalSeparator = ArgumentValue::Default, ArgumentValue $thousandsSeparator = ArgumentValue::Default, int|Closure|null $maxDecimalPlaces = null, string|Closure|null $locale = null)

No description

from  CanFormatState
CanFormatState
placeholder(string|Closure|null $placeholder)

No description

from  CanFormatState
CanFormatState
markdown(bool|Closure $condition = true)

No description

from  CanFormatState
CanFormatState
prefix(Htmlable|Closure|null $prefix)

No description

from  CanFormatState
CanFormatState
suffix(Htmlable|Closure|null $suffix)

No description

from  CanFormatState
CanFormatState
html(bool|Closure $condition = true)

No description

from  CanFormatState
mixed
formatState(mixed $state)

No description

from  CanFormatState
bool
isHtml()

No description

from  CanFormatState
Htmlable|null
getPrefix()

No description

from  CanFormatState
Htmlable|null
getSuffix()

No description

from  CanFormatState
bool
isMarkdown()

No description

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

No description

from  HasLabel
HasLabel
translateLabel(bool $shouldTranslateLabel = true)

No description

from  HasLabel
string|null
getLabel()

No description

from  HasLabel
string|null
getDefaultLabel()

No description

from  HasLabel
InteractsWithTableQuery
query(Builder|Closure|null $query)

No description

from  InteractsWithTableQuery
Builder|null
getQuery()

No description

from  InteractsWithTableQuery
bool
hasQueryModification()

No description

from  InteractsWithTableQuery
HasExtraAttributes
extraAttributes(array|Closure $attributes, bool $merge = false)

No description

from  HasExtraAttributes
array
getExtraAttributes()

No description

from  HasExtraAttributes
ComponentAttributeBag
getExtraAttributeBag()

No description

from  HasExtraAttributes
__construct(string|null $id = null)

No description

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

No description

Summarizer
id(string|null $id)

No description

Summarizer
using(Closure|null $using)

No description

Summarizer
selectedState(array $state)

No description

mixed
getState()

No description

mixed
getSelectedState()

No description

mixed
summarize(Builder $query, string $attribute)

No description

array
getSelectStatements(string $column)

No description

string|null
getId()

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

at line 176
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 ViewComponent at line 34
ViewComponent view(string|null $view, array $viewData = [])

No description

Parameters

string|null $view
array $viewData

Return Value

ViewComponent

in ViewComponent at line 52
ViewComponent defaultView(string|Closure|null $view)

No description

Parameters

string|Closure|null $view

Return Value

ViewComponent

in ViewComponent at line 62
protected array extractPublicMethods()

No description

Return Value

array

in ViewComponent at line 70
ViewComponent viewData(array $data)

No description

Parameters

array $data

Return Value

ViewComponent

in ViewComponent at line 83
string getView()

No description

Return Value

string

in ViewComponent at line 99
string|null getDefaultView()

No description

Return Value

string|null

in ViewComponent at line 104
string toHtml()

No description

Return Value

string

in ViewComponent at line 109
View render()

No description

Return Value

View

in BelongsToColumn at line 13
BelongsToColumn column(Column $column)

No description

Parameters

Column $column

Return Value

BelongsToColumn

in BelongsToColumn at line 20
Column getColumn()

No description

Return Value

Column

in BelongsToColumn at line 25
Table getTable()

No description

Return Value

Table

in BelongsToColumn at line 30
HasTable getLivewire()

No description

Return Value

HasTable

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

No description

Parameters

bool|Closure $condition

Return Value

CanBeHidden

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

No description

Parameters

bool|Closure $condition

Return Value

CanBeHidden

in CanBeHidden at line 27
bool isHidden()

No description

Return Value

bool

in CanBeHidden at line 36
bool isVisible()

No description

Return Value

bool

in CanFormatState at line 28
CanFormatState formatStateUsing(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

CanFormatState

in CanFormatState at line 35
CanFormatState limit(int $length = 100, string|null $end = '...')

No description

Parameters

int $length
string|null $end

Return Value

CanFormatState

in CanFormatState at line 48
CanFormatState money(string|Closure|null $currency = null, int $divideBy = 0, string|Closure|null $locale = null)

No description

Parameters

string|Closure|null $currency
int $divideBy
string|Closure|null $locale

Return Value

CanFormatState

in CanFormatState at line 72
CanFormatState numeric(int|Closure|null $decimalPlaces = null, ArgumentValue $decimalSeparator = ArgumentValue::Default, ArgumentValue $thousandsSeparator = ArgumentValue::Default, int|Closure|null $maxDecimalPlaces = null, string|Closure|null $locale = null)

No description

Parameters

int|Closure|null $decimalPlaces
ArgumentValue $decimalSeparator
ArgumentValue $thousandsSeparator
int|Closure|null $maxDecimalPlaces
string|Closure|null $locale

Return Value

CanFormatState

in CanFormatState at line 107
CanFormatState placeholder(string|Closure|null $placeholder)

No description

Parameters

string|Closure|null $placeholder

Return Value

CanFormatState

in CanFormatState at line 114
CanFormatState markdown(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanFormatState

in CanFormatState at line 121
CanFormatState prefix(Htmlable|Closure|null $prefix)

No description

Parameters

Htmlable|Closure|null $prefix

Return Value

CanFormatState

in CanFormatState at line 128
CanFormatState suffix(Htmlable|Closure|null $suffix)

No description

Parameters

Htmlable|Closure|null $suffix

Return Value

CanFormatState

in CanFormatState at line 135
CanFormatState html(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanFormatState

in CanFormatState at line 142
mixed formatState(mixed $state)

No description

Parameters

mixed $state

Return Value

mixed

in CanFormatState at line 201
bool isHtml()

No description

Return Value

bool

in CanFormatState at line 206
Htmlable|null getPrefix()

No description

Return Value

Htmlable|null

in CanFormatState at line 211
Htmlable|null getSuffix()

No description

Return Value

Htmlable|null

in CanFormatState at line 216
bool isMarkdown()

No description

Return Value

bool

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|null getLabel()

No description

Return Value

string|null

in HasLabel at line 42
string|null getDefaultLabel()

No description

Return Value

string|null

in InteractsWithTableQuery at line 14
InteractsWithTableQuery query(Builder|Closure|null $query)

No description

Parameters

Builder|Closure|null $query

Return Value

InteractsWithTableQuery

in InteractsWithTableQuery at line 27
Builder|null getQuery()

No description

Return Value

Builder|null

in InteractsWithTableQuery at line 32
bool hasQueryModification()

No description

Return Value

bool

in HasExtraAttributes at line 18
HasExtraAttributes extraAttributes(array|Closure $attributes, bool $merge = false)

No description

Parameters

array|Closure $attributes
bool $merge

Return Value

HasExtraAttributes

in HasExtraAttributes at line 32
array getExtraAttributes()

No description

Return Value

array

in HasExtraAttributes at line 43
ComponentAttributeBag getExtraAttributeBag()

No description

Return Value

ComponentAttributeBag

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

No description

Parameters

string|null $id

at line 44
static Summarizer make(string|null $id = null)

No description

Parameters

string|null $id

Return Value

Summarizer

at line 52
Summarizer id(string|null $id)

No description

Parameters

string|null $id

Return Value

Summarizer

at line 59
Summarizer using(Closure|null $using)

No description

Parameters

Closure|null $using

Return Value

Summarizer

at line 69
Summarizer selectedState(array $state)

No description

Parameters

array $state

Return Value

Summarizer

at line 76
mixed getState()

No description

Return Value

mixed

at line 150
mixed getSelectedState()

No description

Return Value

mixed

at line 155
mixed summarize(Builder $query, string $attribute)

No description

Parameters

Builder $query
string $attribute

Return Value

mixed

at line 163
array getSelectStatements(string $column)

No description

Parameters

string $column

Return Value

array

at line 168
string|null getId()

No description

Return Value

string|null