trait ListExtendable

Methods

void
listExtendColumns(Lists $host)

Called after the list columns are defined.

listExtendModel(Model $model, null $alias = null)

Controller override: Extend supplied model

listExtendQueryBefore(Builder $query, $alias = null)

Controller override: Extend the query used for populating the list before the default query is processed.

listExtendQuery(Builder $query, $alias = null)

Controller override: Extend the query used for populating the list after the default query is processed.

listFilterExtendQuery(Builder $query, array $scope)

Controller override: Extend the query used for populating the filter options before the default query is processed.

void
listFilterExtendScopesBefore(Filter $host)

Called before the filter scopes are defined.

void
listFilterExtendScopes(Filter $host, $scopes)

Called after the filter scopes are defined.

string
listOverrideColumnValue(Model $record, string $column, string $alias = null)

Replace a table column value (...)

string
listOverrideHeaderValue(string $columnName, string $alias = null)

Replace the entire table header contents (...) with custom HTML

static void
extendListColumns(callable $callback)

Static helper for extending list columns.

Details

at line 17
void listExtendColumns(Lists $host)

Called after the list columns are defined.

Parameters

Lists $host

The hosting list widget

Return Value

void

at line 29
listExtendModel(Model $model, null $alias = null)

Controller override: Extend supplied model

Parameters

Model $model
null $alias

at line 40
listExtendQueryBefore(Builder $query, $alias = null)

Controller override: Extend the query used for populating the list before the default query is processed.

Parameters

Builder $query
$alias

at line 50
listExtendQuery(Builder $query, $alias = null)

Controller override: Extend the query used for populating the list after the default query is processed.

Parameters

Builder $query
$alias

at line 61
listFilterExtendQuery(Builder $query, array $scope)

Controller override: Extend the query used for populating the filter options before the default query is processed.

Parameters

Builder $query
array $scope

at line 72
void listFilterExtendScopesBefore(Filter $host)

Called before the filter scopes are defined.

Parameters

Filter $host

The hosting filter widget

Return Value

void

at line 84
void listFilterExtendScopes(Filter $host, $scopes)

Called after the filter scopes are defined.

Parameters

Filter $host

The hosting filter widget

$scopes

Return Value

void

at line 97
string listOverrideColumnValue(Model $record, string $column, string $alias = null)

Replace a table column value (...)

Parameters

Model $record

The populated model used for the column

string $column

The column to override

string $alias

List alias (optional)

Return Value

string

HTML view

at line 109
string listOverrideHeaderValue(string $columnName, string $alias = null)

Replace the entire table header contents (...) with custom HTML

Parameters

string $columnName

The column name to override

string $alias

List alias (optional)

Return Value

string

HTML view

at line 120
static void extendListColumns(callable $callback)

Static helper for extending list columns.

Parameters

callable $callback

Return Value

void