AbstractSitePage
in package
implements
SitePage
An abstract implementation of a SitePage SitePages are used to define metadata like subaction options, titles and user security levels
Tags
Table of Contents
Interfaces
- SitePage
- An interface defining a SitePage SitePages are used to define metadata like subaction options, titles and user security levels
Properties
- $accessLevel : int
- $isSearchable : bool
- $name : string
- $options : array<string|int, string>
- $path : string
- $searchableFields : array<string|int, string>
- $subTitle : string
- $title : string
Methods
- __construct() : mixed
- Default constructor for extenders of AbstractSitePage
- getAccessLevel() : int
- Gets the access level for the page
- getName() : string
- Gets the name of the page
- getOptions() : array<string|int, string>
- Get the user facing action options associated with the page.
- getPath() : string
- Gets the relative directory path of 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
- Sets the access level for the page
- setIsSearchable() : void
- Enable/Disable user facing searching
- setName() : void
- Sets the name of the page
- setOptions() : void
- Set the user facing action options associated with the page.
- setPath() : mixed
- Sets the path of 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.
Properties
$accessLevel
protected
int
$accessLevel
The security restriction for the page
$isSearchable
protected
bool
$isSearchable
= false
Should UIs with search capability show a search box for this page?
$name
protected
string
$name
The name of the page
$options
protected
array<string|int, string>
$options
= array()
The UI displayed subnavigation for the page
$path
protected
string
$path
The relative directory path to the page
$searchableFields
protected
array<string|int, string>
$searchableFields
= array()
The columns search implementors should use when querying a DataRepository
$subTitle
protected
string
$subTitle
The UI display subtitle of the page
$title
protected
string
$title
The UI display title of the page
Methods
__construct()
Default constructor for extenders of AbstractSitePage
public
__construct(string $name, string $path, int $accessLevel) : mixed
Parameters
- $name : string
-
The name of the page
- $path : string
-
The relative directory path to the page
- $accessLevel : int
-
The security restriction for the page
getAccessLevel()
Gets the access level for the page
public
getAccessLevel() : int
Return values
int —The access level for the page
getName()
Gets the name of the page
public
getName() : string
Return values
string —$name The name of the page
getOptions()
Get the user facing action options associated with the page.
public
abstract getOptions() : array<string|int, string>
Return values
array<string|int, string> —$options
getPath()
Gets the relative directory path of the page
public
getPath() : string
Return values
string —The relative directory path of the page
getSearchableFields()
Get the field names that should be searched.
public
abstract getSearchableFields() : array<string|int, string>
Return values
array<string|int, string> —$searchableFields
getSubTitle()
Get the user facing subtitle of the page.
public
abstract getSubTitle() : string
Return values
string —$subTitle
getTitle()
Get the user facing title of the page.
public
abstract getTitle() : string
Return values
string —$title
isAdminPage()
Is this page restricted to administrative users?
public
abstract isAdminPage() : bool
Return values
boolisPublicPage()
Should this page be available to all users?
public
abstract isPublicPage() : bool
Return values
boolisSearchable()
Does this page have user facing searchable content?
public
abstract isSearchable() : bool
Return values
bool —$isSearchable
setAccessLevel()
Sets the access level for the page
public
setAccessLevel([int $accessLevel = 0 ]) : void
Parameters
- $accessLevel : int = 0
-
The access level for the page (Defaults to 0)
setIsSearchable()
Enable/Disable user facing searching
public
abstract setIsSearchable(mixed $isSearchable) : void
Parameters
- $isSearchable : mixed
setName()
Sets the name of the page
public
setName(string $name) : void
Parameters
- $name : string
-
The name of the page
setOptions()
Set the user facing action options associated with the page.
public
abstract setOptions(mixed $options) : void
Parameters
- $options : mixed
setPath()
Sets the path of the page
public
setPath(string $path) : mixed
Parameters
- $path : string
-
The relative directory path of the page
setSearchableFields()
Explicitly define the field names that should be searched.
public
abstract setSearchableFields(mixed $searchableFields) : void
Parameters
- $searchableFields : mixed
setSubTitle()
Set the user facing subtitle of the page.
public
abstract setSubTitle(mixed $subTitle) : void
Parameters
- $subTitle : mixed
setTitle()
Set the user facing title of the page.
public
abstract setTitle(mixed $title) : void
Parameters
- $title : mixed