Properties

$name

$name : string

Page name

Type

string

$capability

$capability : string

Stores the capability of the action

Type

string

$slug

$slug : string

Page slug

Type

string

$dashicon

$dashicon : string

Page dashicon

Type

string

$menuPosition

$menuPosition : integer

Page menu position

Type

integer

$removePageSubmenu

$removePageSubmenu : boolean

Remove page from submenu when available

Type

boolean

$subPages

$subPages : array<mixed,\MocaBonita\tools\MbPage>

Subpages of this page

Type

array<mixed,\MocaBonita\tools\MbPage>

$mainMenu

$mainMenu : boolean

Store if page is main menu

Type

boolean

$subMenu

$subMenu : boolean

Store if page is subMenu

Type

boolean

$hideMenu

$hideMenu : boolean

Check if it is necessary to hide the menu of this page

Type

boolean

Methods

__construct()

__construct(\MocaBonita\tools\MbPage  $parentPage = null, boolean  $mainMenu = true, integer  $position = 1) 

MbPage construct

Parameters

\MocaBonita\tools\MbPage $parentPage
boolean $mainMenu
integer $position

create()

create(string  $name) : \MocaBonita\tools\MbPage

Create a new MbPage

Parameters

string $name

Returns

\MocaBonita\tools\MbPage

getName()

getName() : string

Get name

Returns

string

setName()

setName(string  $name) : \MocaBonita\tools\MbPage

Set name

Parameters

string $name

Returns

\MocaBonita\tools\MbPage

getCapability()

getCapability() : string

Get capability

Returns

string

setCapability()

setCapability(string  $capability) : \MocaBonita\tools\MbPage

Set capability

Parameters

string $capability

Returns

\MocaBonita\tools\MbPage

getSlug()

getSlug() : string

Get slug

Returns

string

setSlug()

setSlug(string  $slug, boolean  $sanitize = true) : \MocaBonita\tools\MbPage

Set slug

Parameters

string $slug
boolean $sanitize

Returns

\MocaBonita\tools\MbPage

getDashicon()

getDashicon() : string

Get dashicon

Returns

string

setDashicon()

setDashicon(string  $dashicon) : \MocaBonita\tools\MbPage

Set dashicon

Parameters

string $dashicon

Returns

\MocaBonita\tools\MbPage

getMenuPosition()

getMenuPosition() : integer

Get menu position

Returns

integer

setMenuPosition()

setMenuPosition(integer  $menuPosition) : \MocaBonita\tools\MbPage

Set menu position

Parameters

integer $menuPosition

Returns

\MocaBonita\tools\MbPage

getParentPage()

getParentPage() : \MocaBonita\tools\MbPage

Get parent page

Throws

\MocaBonita\tools\MbException

Returns

\MocaBonita\tools\MbPage

isRemovePageSubmenu()

isRemovePageSubmenu() : boolean

Is remove page submenu

Returns

boolean

setRemovePageSubmenu()

setRemovePageSubmenu(boolean  $removePageSubmenu = true) : \MocaBonita\tools\MbPage

Set remove page submenu

Parameters

boolean $removePageSubmenu

Returns

\MocaBonita\tools\MbPage

getSubPages()

getSubPages() : array<mixed,\MocaBonita\tools\MbPage>

Get sub pages

Returns

array<mixed,\MocaBonita\tools\MbPage>

getSubPage()

getSubPage(string  $pageSlug) : \MocaBonita\tools\MbPage|null

Get sub page

Parameters

string $pageSlug

Returns

\MocaBonita\tools\MbPage|null

addSubPage()

addSubPage(string  $name, string  $slug = null) : \MocaBonita\tools\MbPage

Add sub page

Parameters

string $name
string $slug

Returns

\MocaBonita\tools\MbPage

subpage

isMainMenu()

isMainMenu() : boolean

Is main menu

Returns

boolean

setMainMenu()

setMainMenu(boolean  $mainMenu = true) : \MocaBonita\tools\MbPage

Set main menu

Parameters

boolean $mainMenu

Returns

\MocaBonita\tools\MbPage

isSubMenu()

isSubMenu() : boolean

Is submenu

Returns

boolean

setSubMenu()

setSubMenu(boolean  $subMenu = true) : \MocaBonita\tools\MbPage

Set submenu

Parameters

boolean $subMenu

Returns

\MocaBonita\tools\MbPage

isHideMenu()

isHideMenu() : boolean

Is hide menu

Returns

boolean

setHideMenu()

setHideMenu(boolean  $hideMenu = true) : \MocaBonita\tools\MbPage

Set hide menu

Parameters

boolean $hideMenu

Returns

\MocaBonita\tools\MbPage

getMbAction()

getMbAction(string  $actionName) : \MocaBonita\tools\MbAction|null

Get MbAction

Parameters

string $actionName

Returns

\MocaBonita\tools\MbAction|null

addMbAction()

addMbAction(string  $actionName, string|callable|mixed  $action = null) : \MocaBonita\tools\MbAction

add new MbAction

Parameters

string $actionName
string|callable|mixed $action

Returns

\MocaBonita\tools\MbAction

addMenuWordpress()

addMenuWordpress() : void

Add Menu in Wordpress

Throws

\MocaBonita\tools\MbException