\pm_Navigation_OverviewPage

Base class for object's overview pages

Summary

Methods
Properties
Constants
getLabel()
getPageTitle()
getHref()
setTabbed()
isTabbed()
getOverviewPage()
getData()
getCurrentItem()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A

Methods

getLabel()

getLabel() : string

Returns page label

Returns

string

getPageTitle()

getPageTitle() : string

Returns page screen title

Returns

string

getHref()

getHref() : string

Returns href for this page

Returns

string

setTabbed()

setTabbed(boolean  $tabbed = true) : $this

Sets whether the page should be rendered as tabs

Parameters

boolean $tabbed

[optional] Default is true.

Returns

$this

isTabbed()

isTabbed() : boolean

Returns whether page should be rendering tabs

Returns

boolean

getOverviewPage()

getOverviewPage() : \pm_Navigation_OverviewPage|null

Returns closest overview page

Returns

\pm_Navigation_OverviewPage|null

getData()

getData() : array

Returns array of object for this page

[
    [
        'id' => string,
        'title' => string,
    ],
    ...
]

Returns

array

getCurrentItem()

getCurrentItem() : array|null

Returns context object for this page

[
    'id' => string,
    'title' => string,
]

Returns

array|null