Documentation

Accounts_RelationAjax_Action extends Vtiger_RelationAjax_Action
in package

RelationAjax Class for Accounts.

Tags
copyright

YetiForce Sp. z o.o

license

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

author

Radosław Skrzypczak r.skrzypczak@yetiforce.com

author

Mariusz Krzaczkowski m.krzaczkowski@yetiforce.com

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
{@inheritdoc}
addRelation()  : mixed
Function to add relation for specified source record id and related record id list.
calculate()  : mixed
Function for calculating values for a list of related records.
checkFilesIntegrity()  : mixed
Check many files integrity.
checkPermission()  : mixed
Function to check permission.
deleteRelation()  : mixed
Function to delete the relation for specified source record id and related record id list.
exportToExcel()  : mixed
Export relations to excel.
getHierarchyCount()  : mixed
Number of hierarchy entries for a given record.
getQuery()  : QueryGenerator|bool
Get query for records list from request.
getRecordsListFromRequest()  : array<string|int, int>
Get records list from request.
getRelatedListPageCount()  : mixed
Function to get the page count for related list.
getRelationListModel()  : mixed
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.
massDeleteRelation()  : mixed
This function removes the relationship associated with the module.
massDownload()  : mixed
Mass download.
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.
updateFavoriteForRecord()  : mixed
updateRelation()  : mixed
Function to update the relation for specified source record id and related record id list.
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()

{@inheritdoc}

public __construct() : mixed
Return values
mixed

addRelation()

Function to add relation for specified source record id and related record id list.

public addRelation(Request $request) : mixed
Parameters
$request : Request
Tags
throws
NoPermittedToRecord
Return values
mixed

checkFilesIntegrity()

Check many files integrity.

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

deleteRelation()

Function to delete the relation for specified source record id and related record id list.

public deleteRelation(Request $request) : mixed
Parameters
$request : Request
Tags
throws
NoPermittedToRecord
Return values
mixed

exportToExcel()

Export relations to excel.

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

getHierarchyCount()

Number of hierarchy entries for a given record.

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

getRecordsListFromRequest()

Get records list from request.

public static getRecordsListFromRequest(Request $request) : array<string|int, int>
Parameters
$request : Request
Return values
array<string|int, int>

getRelatedListPageCount()

Function to get the page count for related list.

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

getRelationListModel()

public static getRelationListModel(Request $request) : mixed
Parameters
$request : Request
Return values
mixed

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

massDeleteRelation()

This function removes the relationship associated with the module.

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

massDownload()

Mass download.

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

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

updateFavoriteForRecord()

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

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