1. class
  2. Civi
  3. API
  4. Request

Request

class Request

Class Request

Methods

static array
create(string $entity, string $action, array $params, mixed $extra = NULL)

Create a formatted/normalized request object.

static string
normalizeEntityName(string $entity, int $version)

Normalize entity to be CamelCase.

static string
normalizeActionName($action, $version)

Normalize api action name to be lowercase.

Details

at line 61
static array create(string $entity, string $action, array $params, mixed $extra = NULL)

Create a formatted/normalized request object.

Parameters

string $entity API entity name.
string $action API action name.
array $params API parameters.
mixed $extra Who knows? ...

Return Value

array the request descriptor; keys: - version: int - entity: string - action: string - params: array (string $key => mixed $value) [deprecated in v4] - extra: unspecified - fields: NULL|array (string $key => array $fieldSpec) - options: \CRM_Utils_OptionBag derived from params [v4-only] - data: \CRM_Utils_OptionBag derived from params [v4-only] - chains: unspecified derived from params [v4-only]

Exceptions

API_Exception

at line 101
static string normalizeEntityName(string $entity, int $version)

Normalize entity to be CamelCase.

APIv1-v3 munges entity/action names, and accepts any mixture of case and underscores.

Parameters

string $entity
int $version

Return Value

string

at line 114
static string normalizeActionName($action, $version)

Normalize api action name to be lowercase.

APIv1-v3 munges entity/action names, and accepts any mixture of case and underscores.

Parameters

$action
$version

Return Value

string