\MocaBonitaMocaBonita

getInstance()

getInstance() : static

The singleton pattern is useful when we need to make sure that we only have a single instance of a class for the entire request lifecycle in a Web application. This usually occurs when we have global objects (such as a configuration class) or a resource (Such as an event queue).

Returns

__clone()

__clone() 

Clone Not allowed

Throws

\MocaBonita\tools\MbException

__wakeup()

__wakeup() 

WakeUp Not allowed.

Throws

\MocaBonita\tools\MbException

version()

version() : string

Get current version of MocaBonita

Returns

getMbAssets()

getMbAssets(boolean  $wordpress = false) : \MocaBonita\tools\MbAsset

Get either MbAsset from the plugin or from Wordpress

Parameters

Returns

getAssetsPlugin()

getAssetsPlugin() : \MocaBonita\tools\MbAsset

Get the plugin's MbAsset

Returns

getAssetsWordpress()

getAssetsWordpress() : \MocaBonita\tools\MbAsset

Get the Wordpress' MbAsset

Returns

setMbAssets()

setMbAssets(\MocaBonita\tools\MbAsset  $mbAsset, boolean  $wordpress = false) : \MocaBonita\MocaBonita

Set either MbAsset to the plugin or to the Wordpress

Parameters

Returns

current instance of MocaBonita

setAssetsPlugin()

setAssetsPlugin(\MocaBonita\tools\MbAsset  $pluginMbAsset) : \MocaBonita\MocaBonita

Set the MbAsset to the plugin

Parameters

Returns

current instance of MocaBonita

setAssetsWordpress()

setAssetsWordpress(\MocaBonita\tools\MbAsset  $wordpressMbAsset) : \MocaBonita\MocaBonita

Set the MbAsset to the Wordpress

Parameters

Returns

current instance of MocaBonita

getMbEvents()

getMbEvents(string|null  $dispatch = null) : \Illuminate\Support\Collection

Get either a MbEvent from a dispatcher type or the MbEvent list

Parameters

Returns

setMbEvent()

setMbEvent(\MocaBonita\tools\MbEvent  $mbEvent, string|array  $dispatch) : \MocaBonita\MocaBonita

Set a MbEvent to a dispatcher type

Parameters

Returns

current instance of MocaBonita

getPage()

getPage() : string

Get the current name of the wordpress page

Returns

setPage()

setPage(string  $page) : \MocaBonita\MocaBonita

Set the current name of the wordpress page

Parameters

Returns

current instance of MocaBonita

getAction()

getAction() : string

Get the current name of the wordpress action

Returns

setAction()

setAction(string  $action) : \MocaBonita\MocaBonita

Set the current name of the wordpress action

Parameters

Returns

current instance of MocaBonita

getMbAudit()

getMbAudit() : \MocaBonita\audit\MbAudit

Returns

setMbAudit()

setMbAudit(\MocaBonita\audit\MbAudit  $mbAudit) : \MocaBonita\MocaBonita

Parameters

Returns

enableSession()

enableSession(\Symfony\Component\HttpFoundation\Session\Session  $session = null) : \MocaBonita\MocaBonita

Enable session

Parameters

Returns

enableFlash()

enableFlash(\Symfony\Component\HttpFoundation\Session\Session  $session = null) : \MocaBonita\MocaBonita

Enable flash session

Parameters

Returns

plugin()

plugin(  $pluginStructure, boolean  $audit = false, string  $tag = "plugins_loaded") : void

Set the callback that has the plugin's structure

Parameters

active()

active(  $active) : void

Set the callback that will be called when the plugin is activated

Parameters

deactive()

deactive(  $deactive) : void

Set the callback that will be called when the plugin is deactivated

Parameters

uninstall()

uninstall(  $unistall) : void

Set the callback that will be called when the plugin is uninstalling

Parameters

runAction()

runAction(\MocaBonita\tools\MbAction  $mbAction, \MocaBonita\view\MbView  $mbView, array  $callbackParameters = array()) : mixed

Parameters

Throws

\MocaBonita\tools\MbException

Returns

sendContent()

sendContent() : void

Send the content generated by the plugin

getMbPage()

getMbPage(string  $slugPage) : \MocaBonita\tools\MbPage

Get MbPage of slug

Parameters

Throws

\MocaBonita\tools\MbException

Returns

getMbShortcode()

getMbShortcode(string  $shortcodeName) : \MocaBonita\tools\MbShortCode

Get MbShortcode of name

Parameters

Throws

\MocaBonita\tools\MbException

Returns

addMbPageStructure()

addMbPageStructure(  $pageName, \MocaBonita\tools\MbPageStructure  $mbPageStructure) 

Add page structure

Parameters

addMbPage()

addMbPage(\MocaBonita\tools\MbPage  $mbPage) : \MocaBonita\MocaBonita

Add a MbPage to MocaBonita as main menu

Parameters

Returns

current instance of MocaBonita

addSubMbPage()

addSubMbPage(\MocaBonita\tools\MbPage  $mbPage) : \MocaBonita\MocaBonita

Add a MbPage to MocaBonita as submenu

Parameters

Returns

current instance of MocaBonita

addMbShortcode()

addMbShortcode(string  $name, \MocaBonita\tools\MbPage  $mbPage, string|callable|mixed  $method) : \MocaBonita\tools\MbShortCode

Add a MbShortCode to MocaBonita

Parameters

Returns

addAdminMenuToWordpress()

addAdminMenuToWordpress() : void

Add admin menu to Wordpress

getMbRequest()

getMbRequest() : \MocaBonita\tools\MbRequest

Get MbRequest

Returns

setMbRequest()

setMbRequest(\MocaBonita\tools\MbRequest  $mbRequest) : \MocaBonita\MocaBonita

Set MbRequest to MocaBonita

Parameters

Returns

current instance of MocaBonita

getMbResponse()

getMbResponse() : \MocaBonita\tools\MbResponse

Get MbResponse

Returns

setMbResponse()

setMbResponse(\MocaBonita\tools\MbResponse  $mbResponse) : \MocaBonita\MocaBonita

Set MbResponse to MocaBonita

Parameters

Returns

current instance of MocaBonita

__construct()

__construct() 

Singleton construct

init()

init() : void

Function that's called when MocaBonita is started.

isMocabonitaPage()

isMocabonitaPage() : boolean

Check if the current page is a Mocabonita page

Returns

runPlugin()

runPlugin() : void

Initialize the processing of the plugin and its resources.

Throws

\Exception

runCurrentPage()

runCurrentPage(\MocaBonita\tools\MbPage  $mbPage) 

Execute current page resources

Parameters

Throws

\MocaBonita\tools\MbException

runHookCurrentAction()

runHookCurrentAction() : boolean

Add Wordpress Hook for current action if needed

Returns