Documentation

Settings_ApiAddress_SaveConfig_Action extends Settings_Vtiger_Basic_Action
in package

Settings ApiAddress SaveConfig action class.

Tags
copyright

YetiForce S.A.

license

YetiForce Public License 6.5 (licenses/LicenseEN.txt or yetiforce.com)

Table of Contents

$headers  : Headers
$activatedLocale  : bool
$exposedMethods  : array<string|int, string>
Control the exposure of methods to be invoked from client (kind-of RPC).
$csrfInitiated  : bool
__construct()  : mixed
{@inheritdoc}
checkPermission()  : mixed
Function to check permission.
global()  : void
Save global configuration.
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.
provider()  : void
Save provider configuration.
sendHeaders()  : mixed
Send headers.
updateFieldPinnedStatus()  : mixed
validateRequest()  : void
Function to validate request method.
exposeMethod()  : mixed
Function that will expose methods for external access.

Properties

$headers

public Headers $headers

Headers instance.

$activatedLocale

protected static bool $activatedLocale = false

Activated language locale.

$exposedMethods

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

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

$csrfInitiated

private static bool $csrfInitiated = false

CSRF already initiated.

Methods

__construct()

{@inheritdoc}

public __construct() : mixed
Return values
mixed

checkPermission()

Function to check permission.

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

global()

Save global configuration.

public global(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

provider()

Save provider configuration.

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

sendHeaders()

Send headers.

public sendHeaders() : mixed
Return values
mixed

updateFieldPinnedStatus()

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

validateRequest()

Function to validate request method.

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

exposeMethod()

Function that will expose methods for external access.

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

        

Search results