pm_Navigation_OverviewPage
extends pm_Navigation_Page
in package
Base class for object's overview pages
Tags
Table of Contents
- getCurrentItem() : array<string|int, mixed>|null
- Returns context object for this page
- getData() : array<string|int, mixed>
- Returns array of object for this page
- getHref() : string
- Returns href for this page
- getLabel() : string
- Returns page label
- getOverviewPage() : pm_Navigation_OverviewPage|null
- Returns closest overview page
- getPageTitle() : string
- Returns page screen title
- isTabbed() : bool
- Returns whether page should be rendering tabs
- setTabbed() : $this
- Sets whether the page should be rendered as tabs
Methods
getCurrentItem()
Returns context object for this page
public
getCurrentItem() : array<string|int, mixed>|null
[
'id' => string,
'title' => string,
]
Return values
array<string|int, mixed>|null —getData()
Returns array of object for this page
public
abstract getData() : array<string|int, mixed>
[
[
'id' => string,
'title' => string,
],
...
]
Return values
array<string|int, mixed> —getHref()
Returns href for this page
public
getHref() : string
Return values
string —getLabel()
Returns page label
public
getLabel() : string
Return values
string —getOverviewPage()
Returns closest overview page
public
getOverviewPage() : pm_Navigation_OverviewPage|null
Return values
pm_Navigation_OverviewPage|null —getPageTitle()
Returns page screen title
public
getPageTitle() : string
Return values
string —isTabbed()
Returns whether page should be rendering tabs
public
isTabbed() : bool
Return values
bool —setTabbed()
Sets whether the page should be rendered as tabs
public
setTabbed([bool $tabbed = true ]) : $this
Parameters
- $tabbed : bool = true
-
[optional] Default is true.