interface Listable

Interface that ensures compliance with \Tfish\View\Listing.

Methods

setOrder(string $field)

Set primary field to sort query results by.

setOrderType(string $order)

Set primary sort order.

setSecondaryOrder(string $field)

Set secondary field to sort query results by.

setSecondaryOrderType(string $secondaryOrder)

Set secondary sort order.

int
contentCount()

Count results matching query conditions.

int
limit()

Return the query limit (number of results to retrieve).

int
start()

Return the query offset (starting position to retrieve results from result set).

int
tag()

Return tag filter.

array
extraParams()

Returns extra parameters used to filter queries.

string
pageTitle()

Return the page title.

setPageTitle(string $pageTitle)

Set the page title.

template()

Return the template name for this page view.

setTemplate(string $template)

Set the template for this page view.

string
theme()

Return the active theme for this page view.

setTheme(string $theme)

Set the theme for this page view.

array
metadata()

Return metadata overrides for this page view.

setMetadata(array $metadata)

Set metadata overrides for this page view.

Details

at line 38
setOrder(string $field)

Set primary field to sort query results by.

Parameters

string $field Name of field.

at line 45
setOrderType(string $order)

Set primary sort order.

Parameters

string $order Order (ASC or DESC).

at line 52
setSecondaryOrder(string $field)

Set secondary field to sort query results by.

Parameters

string $field Name of field.

at line 59
setSecondaryOrderType(string $secondaryOrder)

Set secondary sort order.

Parameters

string $secondaryOrder Order (ASC or DESC).

at line 68
int contentCount()

Count results matching query conditions.

Return Value

int

at line 75
int limit()

Return the query limit (number of results to retrieve).

Return Value

int

at line 82
int start()

Return the query offset (starting position to retrieve results from result set).

Return Value

int

at line 91
int tag()

Return tag filter.

The ID of the tag being used to filter the result set, if any.

Return Value

int

at line 98
array extraParams()

Returns extra parameters used to filter queries.

Also used to build pagination controls.

Return Value

array

at line 107
string pageTitle()

Return the page title.

Return Value

string

at line 114
setPageTitle(string $pageTitle)

Set the page title.

Parameters

string $pageTitle Title of the page.

at line 121
Template template()

Return the template name for this page view.

Return Value

Template

at line 128
setTemplate(string $template)

Set the template for this page view.

Parameters

string $template Name of HTML template, without the file extension, eg. 'article'.

at line 135
string theme()

Return the active theme for this page view.

Return Value

string

at line 142
setTheme(string $theme)

Set the theme for this page view.

Parameters

string $theme Name of the theme directory.

at line 149
array metadata()

Return metadata overrides for this page view.

Return Value

array

at line 156
setMetadata(array $metadata)

Set metadata overrides for this page view.

Parameters

array $metadata Overriden metadata properties.