SitePage
in
An interface defining a SitePage SitePages are used to define metadata like subaction options, titles and user security levels
Tags
Table of Contents
Methods
- getAccessLevel() : mixed
- Get the access level required for viewing the page.
- getName() : string
- Get the short name of the page.
- getOptions() : array<string|int, string>
- Get the user facing action options associated with the page.
- getPath() : string
- Get the relative path to the page.
- getSearchableFields() : array<string|int, string>
- Get the field names that should be searched.
- getSubTitle() : string
- Get the user facing subtitle of the page.
- getTitle() : string
- Get the user facing title of the page.
- isAdminPage() : bool
- Is this page restricted to administrative users?
- isPublicPage() : bool
- Should this page be available to all users?
- isSearchable() : bool
- Does this page have user facing searchable content?
- setAccessLevel() : void
- Set the access level required for viewing the page.
- setIsSearchable() : void
- Enable/Disable user facing searching
- setName() : void
- Set the short name of the page.
- setOptions() : void
- Set the user facing action options associated with the page.
- setPath() : mixed
- Set the relative path to the page.
- setSearchableFields() : void
- Explicitly define the field names that should be searched.
- setSubTitle() : void
- Set the user facing subtitle of the page.
- setTitle() : void
- Set the user facing title of the page.
Methods
getAccessLevel()
Get the access level required for viewing the page.
public
getAccessLevel() : mixed
getName()
Get the short name of the page.
public
getName() : string
Return values
stringgetOptions()
Get the user facing action options associated with the page.
public
getOptions() : array<string|int, string>
Return values
array<string|int, string> —$options
getPath()
Get the relative path to the page.
public
getPath() : string
Return values
string —$path
getSearchableFields()
Get the field names that should be searched.
public
getSearchableFields() : array<string|int, string>
Return values
array<string|int, string> —$searchableFields
getSubTitle()
Get the user facing subtitle of the page.
public
getSubTitle() : string
Return values
string —$subTitle
getTitle()
Get the user facing title of the page.
public
getTitle() : string
Return values
string —$title
isAdminPage()
Is this page restricted to administrative users?
public
isAdminPage() : bool
Return values
boolisPublicPage()
Should this page be available to all users?
public
isPublicPage() : bool
Return values
boolisSearchable()
Does this page have user facing searchable content?
public
isSearchable() : bool
Return values
bool —$isSearchable
setAccessLevel()
Set the access level required for viewing the page.
public
setAccessLevel(mixed $accessLevel) : void
Parameters
- $accessLevel : mixed
setIsSearchable()
Enable/Disable user facing searching
public
setIsSearchable(bool $isSearchable) : void
Parameters
- $isSearchable : bool
setName()
Set the short name of the page.
public
setName(string $name) : void
Parameters
- $name : string
setOptions()
Set the user facing action options associated with the page.
public
setOptions(array<string|int, string> $options) : void
Parameters
- $options : array<string|int, string>
setPath()
Set the relative path to the page.
public
setPath(string $path) : mixed
Parameters
- $path : string
-
@return void
setSearchableFields()
Explicitly define the field names that should be searched.
public
setSearchableFields(array<string|int, string> $searchableFields) : void
Parameters
- $searchableFields : array<string|int, string>
setSubTitle()
Set the user facing subtitle of the page.
public
setSubTitle(string $subTitle) : void
Parameters
- $subTitle : string
setTitle()
Set the user facing title of the page.
public
setTitle(string $title) : void
Parameters
- $title : string