trait Viewable

Provides standard implementation for the Viewable interface.

Methods

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 39
string pageTitle()

Return title of this page.

Return Value

string

at line 49
setPageTitle(string $pageTitle)

Set the title of this page.

Parameters

string $pageTitle Title of this page.

at line 59
Template template()

Return the template object required by this page.

Return Value

Template

at line 69
setTemplate(string $template)

Set the template used by this page.

Parameters

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

at line 86
string theme()

Return the theme used by this page.

Return Value

string

at line 98
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 115
array metadata()

Return page-specific metadata overrides.

Return Value

array

at line 125
setMetadata(array $metadata)

Set page-specific overrides of the site metadata.

Parameters

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