Documentation

Settings_ModuleManager_Basic_Action extends Settings_Vtiger_Basic_Action
in package
Uses ExposeMethod

Abstract action controller class.

Table of Contents

$csrfActive  : bool
CSRF is active?.
$headers  : Headers
Headers instance.
$activatedCsrf  : bool
Activated csrf.
$activatedLocale  : bool
Activated language locale.
$exposedMethods  : array<string|int, string>
Control the exposure of methods to be invoked from client (kind-of RPC).
__construct()  : mixed
Construct.
checkModuleName()  : mixed
Action to check module name.
checkPermission()  : mixed
Function to check permission.
createModule()  : mixed
Action to create module.
deleteModule()  : void
Action delete module.
invokeExposedMethod()  : type
Function invokes exposed methods for this class.
isMethodExposed()  : bool
Function checks if the method is exposed for client usage.
isSessionExtend()  : bool
Function to check if session is extended.
loginRequired()  : bool
Function to check login required permission.
postProcess()  : mixed
Post process function.
postProcessAjax()  : mixed
Post process ajax function.
preProcess()  : mixed
Pre process function.
preProcessAjax()  : mixed
Pre process ajax function.
process()  : mixed
Process function.
sendHeaders()  : mixed
Send headers.
updateFieldPinnedStatus()  : mixed
updateModuleStatus()  : void
The action enable / disable the module.
validateRequest()  : bool
Function to validate request method.
exposeMethod()  : mixed
Function that will expose methods for external access.

Properties

$csrfActive

CSRF is active?.

public bool $csrfActive = true

$activatedCsrf

Activated csrf.

protected static bool $activatedCsrf = false

$activatedLocale

Activated language locale.

protected static bool $activatedLocale = false

$exposedMethods

Control the exposure of methods to be invoked from client (kind-of RPC).

protected array<string|int, string> $exposedMethods = []

Methods

__construct()

Construct.

public __construct() : mixed
Return values
mixed

checkModuleName()

Action to check module name.

public checkModuleName(Request $request) : mixed
Parameters
$request : Request
Return values
mixed

checkPermission()

Function to check permission.

public abstract checkPermission(Request $request) : mixed
Parameters
$request : Request
Tags
throws
NoPermitted
Return values
mixed

createModule()

Action to create module.

public createModule(Request $request) : mixed
Parameters
$request : Request
Return values
mixed

deleteModule()

Action delete module.

public deleteModule(Request $request) : void
Parameters
$request : Request
Return values
void

invokeExposedMethod()

Function invokes exposed methods for this class.

public invokeExposedMethod() : type
Tags
throws
AppException
Return values
type

isMethodExposed()

Function checks if the method is exposed for client usage.

public isMethodExposed(string $name) : bool
Parameters
$name : string
  • method name
Return values
bool

isSessionExtend()

Function to check if session is extended.

public isSessionExtend(Request $request) : bool
Parameters
$request : Request
Return values
bool

loginRequired()

Function to check login required permission.

public loginRequired() : bool
Return values
bool

postProcess()

Post process function.

public postProcess(Request $request[, bool $display = true ]) : mixed
Parameters
$request : Request
$display : bool = true
Return values
mixed

postProcessAjax()

Post process ajax function.

public postProcessAjax(Request $request) : mixed
Parameters
$request : Request
Return values
mixed

preProcess()

Pre process function.

public preProcess(Request $request[, bool $display = true ]) : mixed
Parameters
$request : Request
$display : bool = true
Return values
mixed

preProcessAjax()

Pre process ajax function.

public preProcessAjax(Request $request) : mixed
Parameters
$request : Request
Return values
mixed

process()

Process function.

public abstract process(Request $request) : mixed
Parameters
$request : Request
Return values
mixed

sendHeaders()

Send headers.

public sendHeaders() : mixed
Return values
mixed

updateFieldPinnedStatus()

public updateFieldPinnedStatus(Request $request) : mixed
Parameters
$request : Request
Return values
mixed

updateModuleStatus()

The action enable / disable the module.

public updateModuleStatus(Request $request) : void
Parameters
$request : Request
Return values
void

validateRequest()

Function to validate request method.

public validateRequest(Request $request) : bool
Parameters
$request : Request
Return values
bool

exposeMethod()

Function that will expose methods for external access.

protected exposeMethod(string $name) : mixed
Parameters
$name : string
  • method name
Return values
mixed

Search results