1. class
  2. Filament
  3. \
  4. Actions
  5. \
  6. Exports
  7. \
  8. ExportColumn

ExportColumn

class ExportColumn extends Component (View source)

Traits

CanAggregateRelatedModels
CanFormatState
HasCellState
Conditionable
Configurable
EvaluatesClosures
Macroable
Tappable

Properties

protected string $evaluationIdentifier
static protected Closure>> $macros from  Macroable
protected string|Closure|null $columnToAvg from  CanAggregateRelatedModels
protected string $relationshipToAvg from  CanAggregateRelatedModels
protected string $relationshipsToCount from  CanAggregateRelatedModels
protected string $relationshipsToExistenceCheck from  CanAggregateRelatedModels
protected string|Closure|null $columnToMax from  CanAggregateRelatedModels
protected string $relationshipToMax from  CanAggregateRelatedModels
protected string|Closure|null $columnToMin from  CanAggregateRelatedModels
protected string $relationshipToMin from  CanAggregateRelatedModels
protected string|Closure|null $columnToSum from  CanAggregateRelatedModels
protected string $relationshipToSum from  CanAggregateRelatedModels
protected Closure|null $formatStateUsing from  CanFormatState
protected int|Closure|null $characterLimit from  CanFormatState
protected string|Closure|null $characterLimitEnd from  CanFormatState
protected int|Closure|null $wordLimit from  CanFormatState
protected string|Closure|null $wordLimitEnd from  CanFormatState
protected string|Closure|null $prefix from  CanFormatState
protected string|Closure|null $suffix from  CanFormatState
protected bool $isListedAsJson from  CanFormatState
protected mixed $defaultState from  HasCellState
protected mixed $getStateUsing from  HasCellState
protected string|Closure|null $separator from  HasCellState
protected bool|Closure $isDistinctList from  HasCellState
protected string|null $inverseRelationshipName from  HasCellState
protected string $name
protected string|Closure|null $label
protected Exporter|null $exporter
protected bool|Closure $isEnabledByDefault

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

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
CanAggregateRelatedModels
avg(string|array|Closure|null $relationship, string|Closure|null $column)

No description

from  CanAggregateRelatedModels
CanAggregateRelatedModels
counts(string|array|Closure|null $relationships)

No description

from  CanAggregateRelatedModels
CanAggregateRelatedModels
exists(string|array|Closure|null $relationships)

No description

from  CanAggregateRelatedModels
CanAggregateRelatedModels
max(string|array|Closure|null $relationship, string|Closure|null $column)

No description

from  CanAggregateRelatedModels
CanAggregateRelatedModels
min(string|array|Closure|null $relationship, string|Closure|null $column)

No description

from  CanAggregateRelatedModels
CanAggregateRelatedModels
sum(string|array|Closure|null $relationship, string|Closure|null $column)

No description

from  CanAggregateRelatedModels
string|null
getColumnToAvg()

No description

from  CanAggregateRelatedModels
string|array|null
getRelationshipToAvg()

No description

from  CanAggregateRelatedModels
string|array|null
getRelationshipsToCount()

No description

from  CanAggregateRelatedModels
string|array|null
getRelationshipsToExistenceCheck()

No description

from  CanAggregateRelatedModels
string|null
getColumnToMax()

No description

from  CanAggregateRelatedModels
string|array|null
getRelationshipToMax()

No description

from  CanAggregateRelatedModels
string|null
getColumnToMin()

No description

from  CanAggregateRelatedModels
string|array|null
getRelationshipToMin()

No description

from  CanAggregateRelatedModels
string|null
getColumnToSum()

No description

from  CanAggregateRelatedModels
string|array|null
getRelationshipToSum()

No description

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

No description

from  CanFormatState
CanFormatState
words(int|Closure|null $words = 100, string|Closure|null $end = '...')

No description

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

No description

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

No description

from  CanFormatState
CanFormatState
formatStateUsing(Closure|null $callback)

No description

from  CanFormatState
mixed
formatState(mixed $state)

No description

from  CanFormatState
string|null
getFormattedState()

No description

from  CanFormatState
int|null
getCharacterLimit()

No description

from  CanFormatState
string|null
getCharacterLimitEnd()

No description

from  CanFormatState
int|null
getWordLimit()

No description

from  CanFormatState
string|null
getWordLimitEnd()

No description

from  CanFormatState
string|null
getPrefix()

No description

from  CanFormatState
string|null
getSuffix()

No description

from  CanFormatState
CanFormatState
listAsJson(bool $condition = true)

No description

from  CanFormatState
bool
isListedAsJson()

No description

from  CanFormatState
HasCellState
inverseRelationship(string|null $name)

No description

from  HasCellState
HasCellState
distinctList(bool|Closure $condition = true)

No description

from  HasCellState
HasCellState
getStateUsing(mixed $callback)

No description

from  HasCellState
HasCellState
state(mixed $state)

No description

from  HasCellState
HasCellState
default(mixed $state)

No description

from  HasCellState
bool
isDistinctList()

No description

from  HasCellState
mixed
getDefaultState()

No description

from  HasCellState
mixed
getState()

No description

from  HasCellState
mixed
getStateFromRecord()

No description

from  HasCellState
HasCellState
separator(string|Closure|null $separator = ',')

No description

from  HasCellState
string|null
getSeparator()

No description

from  HasCellState
bool
hasRelationship(Model $record)

No description

from  HasCellState
bool
queriesRelationships(Model $record) deprecated

No description

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

No description

from  HasCellState
array
getRelationshipResults(Model $record, array|null $relationships = null)

No description

from  HasCellState
string
getRelationshipAttribute(string|null $name = null)

No description

from  HasCellState
string
getInverseRelationshipName(Model $record)

No description

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

No description

from  HasCellState
__construct(string $name)

No description

static ExportColumn
make(string $name)

No description

ExportColumn
name(string $name)

No description

ExportColumn
label(string|Closure|null $label)

No description

ExportColumn
exporter(Exporter|null $exporter)

No description

ExportColumn
enabledByDefault(bool|Closure $condition)

No description

string
getName()

No description

Exporter|null
getExporter()

No description

bool
isEnabledByDefault()

No description

Model|null
getRecord()

No description

string|null
getLabel()

No description

Builder
applyRelationshipAggregates(Builder $query)

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

at line 138
protected array resolveDefaultClosureDependencyForEvaluationByName(string $parameterName)

No description

Parameters

string $parameterName

Return Value

array

at line 148
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 CanAggregateRelatedModels at line 50
CanAggregateRelatedModels avg(string|array|Closure|null $relationship, string|Closure|null $column)

No description

Parameters

string|array|Closure|null $relationship
string|Closure|null $column

Return Value

CanAggregateRelatedModels

in CanAggregateRelatedModels at line 61
CanAggregateRelatedModels counts(string|array|Closure|null $relationships)

No description

Parameters

string|array|Closure|null $relationships

Return Value

CanAggregateRelatedModels

in CanAggregateRelatedModels at line 71
CanAggregateRelatedModels exists(string|array|Closure|null $relationships)

No description

Parameters

string|array|Closure|null $relationships

Return Value

CanAggregateRelatedModels

in CanAggregateRelatedModels at line 81
CanAggregateRelatedModels max(string|array|Closure|null $relationship, string|Closure|null $column)

No description

Parameters

string|array|Closure|null $relationship
string|Closure|null $column

Return Value

CanAggregateRelatedModels

in CanAggregateRelatedModels at line 92
CanAggregateRelatedModels min(string|array|Closure|null $relationship, string|Closure|null $column)

No description

Parameters

string|array|Closure|null $relationship
string|Closure|null $column

Return Value

CanAggregateRelatedModels

in CanAggregateRelatedModels at line 103
CanAggregateRelatedModels sum(string|array|Closure|null $relationship, string|Closure|null $column)

No description

Parameters

string|array|Closure|null $relationship
string|Closure|null $column

Return Value

CanAggregateRelatedModels

in CanAggregateRelatedModels at line 111
string|null getColumnToAvg()

No description

Return Value

string|null

in CanAggregateRelatedModels at line 119
string|array|null getRelationshipToAvg()

No description

Return Value

string|array|null

| array<int | string, string | Closure> | null

in CanAggregateRelatedModels at line 127
string|array|null getRelationshipsToCount()

No description

Return Value

string|array|null

| array<int | string, string | Closure> | null

in CanAggregateRelatedModels at line 135
string|array|null getRelationshipsToExistenceCheck()

No description

Return Value

string|array|null

| array<int | string, string | Closure> | null

in CanAggregateRelatedModels at line 140
string|null getColumnToMax()

No description

Return Value

string|null

in CanAggregateRelatedModels at line 148
string|array|null getRelationshipToMax()

No description

Return Value

string|array|null

| array<int | string, string | Closure> | null

in CanAggregateRelatedModels at line 153
string|null getColumnToMin()

No description

Return Value

string|null

in CanAggregateRelatedModels at line 161
string|array|null getRelationshipToMin()

No description

Return Value

string|array|null

| array<int | string, string | Closure> | null

in CanAggregateRelatedModels at line 166
string|null getColumnToSum()

No description

Return Value

string|null

in CanAggregateRelatedModels at line 174
string|array|null getRelationshipToSum()

No description

Return Value

string|array|null

| array<int | string, string | Closure> | null

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

No description

Parameters

int|Closure|null $length
string|Closure|null $end

Return Value

CanFormatState

in CanFormatState at line 34
CanFormatState words(int|Closure|null $words = 100, string|Closure|null $end = '...')

No description

Parameters

int|Closure|null $words
string|Closure|null $end

Return Value

CanFormatState

in CanFormatState at line 42
CanFormatState prefix(string|Closure|null $prefix)

No description

Parameters

string|Closure|null $prefix

Return Value

CanFormatState

in CanFormatState at line 49
CanFormatState suffix(string|Closure|null $suffix)

No description

Parameters

string|Closure|null $suffix

Return Value

CanFormatState

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

No description

Parameters

Closure|null $callback

Return Value

CanFormatState

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

No description

Parameters

mixed $state

Return Value

mixed

in CanFormatState at line 91
string|null getFormattedState()

No description

Return Value

string|null

in CanFormatState at line 108
int|null getCharacterLimit()

No description

Return Value

int|null

in CanFormatState at line 113
string|null getCharacterLimitEnd()

No description

Return Value

string|null

in CanFormatState at line 118
int|null getWordLimit()

No description

Return Value

int|null

in CanFormatState at line 123
string|null getWordLimitEnd()

No description

Return Value

string|null

in CanFormatState at line 128
string|null getPrefix()

No description

Return Value

string|null

in CanFormatState at line 133
string|null getSuffix()

No description

Return Value

string|null

in CanFormatState at line 138
CanFormatState listAsJson(bool $condition = true)

No description

Parameters

bool $condition

Return Value

CanFormatState

in CanFormatState at line 145
bool isListedAsJson()

No description

Return Value

bool

in HasCellState at line 27
HasCellState inverseRelationship(string|null $name)

No description

Parameters

string|null $name

Return Value

HasCellState

in HasCellState at line 34
HasCellState distinctList(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

HasCellState

in HasCellState at line 41
HasCellState getStateUsing(mixed $callback)

No description

Parameters

mixed $callback

Return Value

HasCellState

in HasCellState at line 48
HasCellState state(mixed $state)

No description

Parameters

mixed $state

Return Value

HasCellState

in HasCellState at line 55
HasCellState default(mixed $state)

No description

Parameters

mixed $state

Return Value

HasCellState

in HasCellState at line 62
bool isDistinctList()

No description

Return Value

bool

in HasCellState at line 67
mixed getDefaultState()

No description

Return Value

mixed

in HasCellState at line 72
mixed getState()

No description

Return Value

mixed

in HasCellState at line 96
mixed getStateFromRecord()

No description

Return Value

mixed

in HasCellState at line 132
HasCellState separator(string|Closure|null $separator = ',')

No description

Parameters

string|Closure|null $separator

Return Value

HasCellState

in HasCellState at line 139
string|null getSeparator()

No description

Return Value

string|null

in HasCellState at line 144
bool hasRelationship(Model $record)

No description

Parameters

Model $record

Return Value

bool

in HasCellState at line 152
bool queriesRelationships(Model $record) deprecated

deprecated Use `hasRelationship()` instead.

No description

Parameters

Model $record

Return Value

bool

in HasCellState at line 157
Relation|null getRelationship(Model $record, string|null $name = null)

No description

Parameters

Model $record
string|null $name

Return Value

Relation|null

in HasCellState at line 183
array getRelationshipResults(Model $record, array|null $relationships = null)

No description

Parameters

Model $record
array|null $relationships

Return Value

array

in HasCellState at line 233
string getRelationshipAttribute(string|null $name = null)

No description

Parameters

string|null $name

Return Value

string

in HasCellState at line 244
string getInverseRelationshipName(Model $record)

No description

Parameters

Model $record

Return Value

string

in HasCellState at line 284
string|null getRelationshipName(string|null $name = null)

No description

Parameters

string|null $name

Return Value

string|null

at line 29
final __construct(string $name)

No description

Parameters

string $name

at line 34
static ExportColumn make(string $name)

No description

Parameters

string $name

Return Value

ExportColumn

at line 42
ExportColumn name(string $name)

No description

Parameters

string $name

Return Value

ExportColumn

at line 49
ExportColumn label(string|Closure|null $label)

No description

Parameters

string|Closure|null $label

Return Value

ExportColumn

at line 56
ExportColumn exporter(Exporter|null $exporter)

No description

Parameters

Exporter|null $exporter

Return Value

ExportColumn

at line 63
ExportColumn enabledByDefault(bool|Closure $condition)

No description

Parameters

bool|Closure $condition

Return Value

ExportColumn

at line 70
string getName()

No description

Return Value

string

at line 75
Exporter|null getExporter()

No description

Return Value

Exporter|null

at line 80
bool isEnabledByDefault()

No description

Return Value

bool

at line 85
Model|null getRecord()

No description

Return Value

Model|null

at line 90
string|null getLabel()

No description

Return Value

string|null

at line 100
Builder applyRelationshipAggregates(Builder $query)

No description

Parameters

Builder $query

Return Value

Builder

at line 123
Builder applyEagerLoading(Builder $query)

No description

Parameters

Builder $query

Return Value

Builder