1. class
  2. WHMCS
  3. Module
  4. Server
  5. CustomAction

CustomAction

class CustomAction

Properties summary

Type Property Description
protected string $identifier
protected string $display
protected mixed $callable
protected array $params
protected array $permissions
protected bool $active
protected bool $allowSamePage

Methods summary

Return Type Method Name Description
static CustomAction factory(string $identifier, string $display, mixed $callable, array $params = [], array $permissions = [], bool $active = true, bool $allowSamePage = false) Initialise the CustomAction object providing the data that will be used on output.
string getIdentifier() Get the identifier for the CustomAction object.
CustomAction setIdentifier(string $identifier) Set the identifier for the CustomAction object.
string getDisplay() Get the display for the CustomAction object.
CustomAction setDisplay(string $display) Set the display for the CustomAction object.
array invokeCallable() Invoke the callable function for the CustomAction object.
CustomAction setCallable(string|callable $callable) Set the callable function for the CustomAction object.
CustomAction setParams(array $params) Set the params for the CustomAction object.
array getPermissions() Get the permissions for the CustomAction object.
CustomAction setPermissions(array $permissions) Set the permissions for the CustomAction object.
CustomAction setActive(bool $active) -
bool isActive() -
CustomAction setAllowSamePage(bool $allowSamePage) -
bool isAllowSamePage() -

Details

static CustomAction factory (string $identifier, string $display, mixed $callable, array $params = [], array $permissions = [], bool $active = true, bool $allowSamePage = false)

Initialise the CustomAction object providing the data that will be used on output.

Parameters

string $identifier The string used to identify the CustomAction object.
string $display The string displayed in the Client Area.
mixed $callable The invoked function when interacting with the CustomAction object.
array $params An array of parameters to be used when the provided function is called.
array $permissions An array of permissions required to see and click the CustomAction object.
bool $active A boolean representing whether the CustomAction should be disabled on render.
bool $allowSamePage Set to true if the result of custom action can be rendered on the same page

Return Value

CustomAction

string getIdentifier ()

Get the identifier for the CustomAction object.

Return Value

string

protected CustomAction setIdentifier (string $identifier)

Set the identifier for the CustomAction object.

Parameters

string $identifier

Return Value

CustomAction

string getDisplay ()

Get the display for the CustomAction object.

Return Value

string

protected CustomAction setDisplay (string $display)

Set the display for the CustomAction object.

Parameters

string $display

Return Value

CustomAction

array invokeCallable ()

Invoke the callable function for the CustomAction object.

Return Value

array

protected CustomAction setCallable (string|callable $callable)

Set the callable function for the CustomAction object.

Parameters

string|callable $callable

Return Value

CustomAction

protected CustomAction setParams (array $params)

Set the params for the CustomAction object.

Parameters

array $params

Return Value

CustomAction

array getPermissions ()

Get the permissions for the CustomAction object.

Return Value

array

protected CustomAction setPermissions (array $permissions)

Set the permissions for the CustomAction object.

Parameters

array $permissions

Return Value

CustomAction

protected CustomAction setActive (bool $active)

Parameters

bool $active

Return Value

CustomAction

bool isActive ()

Return Value

bool

protected CustomAction setAllowSamePage (bool $allowSamePage)

Parameters

bool $allowSamePage

Return Value

CustomAction

bool isAllowSamePage ()

Return Value

bool