CRM_Core_Page_AJAX

class CRM_Core_Page_AJAX

This is base class for all ajax calls

Methods

static 
run()

Call generic ajax forms.

static 
setIsQuickConfig()

Change is_quick_config priceSet to complex.

static bool
checkAuthz(string $type, string $className, string $fnName = NULL)

Determine whether the request is for a valid class/method name.

static 
returnJsonResponse(array|string $response)

Outputs the CiviCRM standard json-formatted page/form response

static 
setJsHeaders(int|NULL $ttl = NULL)

Set headers appropriate for a js file.

static array
defaultSortAndPagerParams(int $defaultOffset, int $defaultRowCount = 25, string $defaultSort = NULL, string $defaultsortOrder = 'asc')

Set defaults for sort and pager.

static array
validateParams(array $requiredParams = array(), array $optionalParams = array())

Validate ajax input parameters.

Details

at line 45
static run()

Call generic ajax forms.

at line 95
static setIsQuickConfig()

Change is_quick_config priceSet to complex.

at line 141
static bool checkAuthz(string $type, string $className, string $fnName = NULL)

Determine whether the request is for a valid class/method name.

Parameters

string $type 'method'|'class'|''.
string $className 'Class_Name'.
string $fnName Method name.

Return Value

bool

at line 171
static returnJsonResponse(array|string $response)

Outputs the CiviCRM standard json-formatted page/form response

Parameters

array|string $response

at line 207
static setJsHeaders(int|NULL $ttl = NULL)

Set headers appropriate for a js file.

Parameters

int|NULL $ttl Time-to-live (seconds).

at line 227
static array defaultSortAndPagerParams(int $defaultOffset, int $defaultRowCount = 25, string $defaultSort = NULL, string $defaultsortOrder = 'asc')

Set defaults for sort and pager.

Parameters

int $defaultOffset
int $defaultRowCount
string $defaultSort
string $defaultsortOrder

Return Value

array

at line 267
static array validateParams(array $requiredParams = array(), array $optionalParams = array())

Validate ajax input parameters.

Parameters

array $requiredParams
array $optionalParams

Return Value

array