PriceBooks_RelationAjax_Action
extends Vtiger_RelationAjax_Action
in package
Uses
ExposeMethod
Abstract action controller class.
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
- Construct.
- addListPrice() : mixed
- Function adds PriceBooks-Products Relation.
- 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.
- 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.
- specifyMargin() : mixed
- Setting margins.
- updateFavoriteForRecord() : mixed
- updateRelation() : mixed
- Function to update the relation for specified source record id and related record id list.
- 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()
Construct.
public
__construct() : mixed
Return values
mixed —addListPrice()
Function adds PriceBooks-Products Relation.
public
addListPrice(Request $request) : mixed
Parameters
- $request : Request
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
Return values
mixed —calculate()
Function for calculating values for a list of related records.
public
calculate(Request $request) : mixed
Parameters
- $request : Request
Tags
Return values
mixed —checkFilesIntegrity()
Check many files integrity.
public
checkFilesIntegrity(Request $request) : mixed
Parameters
- $request : Request
Return values
mixed —checkPermission()
Function to check permission.
public
abstract checkPermission(Request $request) : mixed
Parameters
- $request : Request
Tags
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
Return values
mixed —exportToExcel()
Export relations to excel.
public
exportToExcel(Request $request) : mixed
Parameters
- $request : Request
Return values
mixed —getQuery()
Get query for records list from request.
public
static getQuery(Request $request) : QueryGenerator|bool
Parameters
- $request : Request
Return values
QueryGenerator|bool —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
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 —specifyMargin()
Setting margins.
public
specifyMargin(Request $request) : mixed
Parameters
- $request : Request
Return values
mixed —updateFavoriteForRecord()
public
updateFavoriteForRecord(Request $request) : mixed
Parameters
- $request : Request
Return values
mixed —updateRelation()
Function to update the relation for specified source record id and related record id list.
public
updateRelation(Request $request) : mixed
Parameters
- $request : Request
Tags
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