trait Listable

Provides standard implementation for common parts of the Listable interface (excepting pagination and setMetadata()).

Methods

setOrder(string $field)

Sets the primary column to order query results by.

setOrderType(string $orderType)

Sets the sort type (ascending or descending) for the primary order column of a result set.

setSecondaryOrder(string $field)

Sets the secondary column to order query results by.

setSecondaryOrderType(string $orderType)

Sets the sort type (ascending or descending) for the secondary order column of a result set.

string
pageTitle()

Return title of this page.

setPageTitle(string $pageTitle)

Set the title of this page.

template()

Return the template object required by this page.

setTemplate(string $template)

Set the template used by this page.

string
theme()

Return the theme used by this page.

setTheme(string $theme)

Set (change) the theme.

array
metadata()

Return page-specific metadata overrides.

setMetadata(array $metadata)

Set page-specific overrides of the site metadata.

Details

at line 46
setOrder(string $field)

Sets the primary column to order query results by.

Parameters

string $field Name of the primary column to order the query results by.

at line 56
setOrderType(string $orderType)

Sets the sort type (ascending or descending) for the primary order column of a result set.

Parameters

string $orderType Ascending (ASC) or descending (DESC) order.

at line 66
setSecondaryOrder(string $field)

Sets the secondary column to order query results by.

Parameters

string $field Name of the secondary column to order the query results by.

at line 76
setSecondaryOrderType(string $orderType)

Sets the sort type (ascending or descending) for the secondary order column of a result set.

Parameters

string $orderType Ascending (ASC) or descending (DESC) order.

at line 88
string pageTitle()

Return title of this page.

Return Value

string

at line 98
setPageTitle(string $pageTitle)

Set the title of this page.

Parameters

string $pageTitle Title of this page.

at line 108
Template template()

Return the template object required by this page.

Return Value

Template

at line 118
setTemplate(string $template)

Set the template used by this page.

Parameters

string $template Name of template (alphanumeric and underscore characters only).

at line 135
string theme()

Return the theme used by this page.

Return Value

string

at line 147
setTheme(string $theme)

Set (change) the theme.

You must ensure that the new theme directory contains the HTML template files that you need.

Parameters

string $theme Name of theme directory (alphanumeric and underscores only).

at line 164
array metadata()

Return page-specific metadata overrides.

Return Value

array

at line 174
setMetadata(array $metadata)

Set page-specific overrides of the site metadata.

Parameters

array $metadata Array of metadata as key => value pairs.