API Documentation
\
MocaBonita
audit
controller
model
tools
eloquent
validation
view

\MocaBonita\toolsMbAction

Main class of the MocaBonita ActionPage

Summary

Methods
Properties
Constants
getMbPage()
setMbPage()
getName()
setName()
isRequiresLogin()
setRequiresLogin()
isRequiresAjax()
setRequiresAjax()
getRequiresMethod()
setRequiresMethod()
getFunctionName()
setFunctionName()
getFunctionComplement()
setFunctionComplement()
getFunction()
isShortcode()
setShortcode()
getCapability()
setCapability()
getData()
setData()
getCallback()
setCallback()
getRequiredParams()
setRequiredParams()
setRequiredParam()
__construct()
actionResolver()
functionExist()
No public properties found
No constants found
No protected methods found
$mbPage
$name
$requiresLogin
$requiresAjax
$requiresMethod
$functionName
$functionComplement
$shortcode
$capability
$data
$callback
$requiredParams
N/A
No private methods found
No private properties found
N/A

Properties

$name

$name : string

Action name

Type

string

$requiresLogin

$requiresLogin : boolean

Check if action needs login

Type

boolean

$requiresAjax

$requiresAjax : boolean

Check if action needs ajax

Type

boolean

$requiresMethod

$requiresMethod : string

Requisition method required

Type

string

$functionName

$functionName : string

Controller function name

Type

string

$functionComplement

$functionComplement : string

Function complement name

Type

string

$shortcode

$shortcode : boolean

Check if action is a shortcode

Type

boolean

$capability

$capability : string

Stores the capability of the action

Type

string

$data

$data : mixed

Stores data to return

Type

mixed

$callback

$callback : \Closure

Stores the callback to return

Type

\Closure

$requiredParams

$requiredParams : array<mixed,string>

Required parameters

Type

array<mixed,string>

Methods

getMbPage()

getMbPage() : \MocaBonita\tools\MbPage

Get MbPage

Throws

\MocaBonita\tools\MBException

Returns

\MocaBonita\tools\MbPage

getName()

getName() : string

Get action name

Returns

string

setName()

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

Set action name

Parameters

string $name

Returns

\MocaBonita\tools\MbAction

isRequiresLogin()

isRequiresLogin() : boolean

Is requires login

Returns

boolean

setRequiresLogin()

setRequiresLogin(boolean  $requiresLogin = true) : \MocaBonita\tools\MbAction

Set requires login

Parameters

boolean $requiresLogin

Returns

\MocaBonita\tools\MbAction

isRequiresAjax()

isRequiresAjax() : boolean

Is requires ajax

Returns

boolean

setRequiresAjax()

setRequiresAjax(boolean  $requiresAjax = true) : \MocaBonita\tools\MbAction

Set requires ajax

Parameters

boolean $requiresAjax

Returns

\MocaBonita\tools\MbAction

getRequiresMethod()

getRequiresMethod() : string

Get requires method

Returns

string

setRequiresMethod()

setRequiresMethod(string|null  $requiresMethod = "GET") : \MocaBonita\tools\MbAction

Set requires method, if it's null, then will be agreed all method

Parameters

string|null $requiresMethod

Returns

\MocaBonita\tools\MbAction

getFunctionName()

getFunctionName() : string

Get function name

Returns

string

setFunctionName()

setFunctionName(string  $functionName) : \MocaBonita\tools\MbAction

Set function name

Parameters

string $functionName

Returns

\MocaBonita\tools\MbAction

getFunctionComplement()

getFunctionComplement() : string

Get function complement

Returns

string

setFunctionComplement()

setFunctionComplement(string|null  $functionComplement = null) : \MocaBonita\tools\MbAction

Set function complement, if it's null, then will be removed the complement of the function

Parameters

string|null $functionComplement

Returns

\MocaBonita\tools\MbAction

getFunction()

getFunction() : string

Get function name with complement

Returns

string

isShortcode()

isShortcode() : boolean

Is shortcode

Returns

boolean

setShortcode()

setShortcode(boolean  $shortcode = true) : \MocaBonita\tools\MbAction

Set shortcode

Parameters

boolean $shortcode

Returns

\MocaBonita\tools\MbAction

getCapability()

getCapability() : string

Get capability

Returns

string

setCapability()

setCapability(string  $capability = "read") : \MocaBonita\tools\MbAction

Set capability

Parameters

string $capability

Returns

\MocaBonita\tools\MbAction

getData()

getData() : mixed

Returns

mixed

getCallback()

getCallback() : \Closure

Returns

\Closure

setCallback()

setCallback(\Closure  $callback) : \MocaBonita\tools\MbAction

Parameters

\Closure $callback

Returns

\MocaBonita\tools\MbAction

getRequiredParams()

getRequiredParams() : array<mixed,string>

Returns

array<mixed,string>

setRequiredParams()

setRequiredParams(array<mixed,string>  $requiredParams) : \MocaBonita\tools\MbAction

Parameters

array<mixed,string> $requiredParams

Returns

\MocaBonita\tools\MbAction

setRequiredParam()

setRequiredParam(string  $require) : \MocaBonita\tools\MbAction

Parameters

string $require

Returns

\MocaBonita\tools\MbAction

__construct()

__construct(\MocaBonita\tools\MbPage  $mbPage, string  $actionName)

Action construct.

Parameters

\MocaBonita\tools\MbPage $mbPage
string $actionName

actionResolver()

actionResolver(string|callable|mixed  $action) : \MocaBonita\tools\MbAction

Action resolver

Parameters

string|callable|mixed $action

Returns

\MocaBonita\tools\MbAction

functionExist()

functionExist() : boolean

Check if the function exist

Throws

\MocaBonita\tools\MbException

Returns

boolean