Getlist.php
Table of Contents
Functions
- civicrm_api3_generic_getList() : mixed
- Generic api wrapper used for quicksearch and autocomplete.
- _civicrm_api3_generic_getlist_get_result() : array<string|int, mixed>
- _civicrm_api3_generic_getList_defaults() : void
- Set defaults for api.getlist.
- _civicrm_api3_generic_getlist_params() : mixed
- Fallback implementation of getlist_params. May be overridden by individual apis.
- _civicrm_api3_generic_getlist_output() : array<string|int, mixed>
- Fallback implementation of getlist_output. May be overridden by individual api functions.
- _civicrm_api3_generic_getlist_postprocess() : mixed
- Common postprocess for getlist output
- _civicrm_api3_generic_getlist_spec() : mixed
- Provide metadata for this api
Functions
civicrm_api3_generic_getList()
Generic api wrapper used for quicksearch and autocomplete.
civicrm_api3_generic_getList(array<string|int, mixed> $apiRequest) : mixed
Parameters
- $apiRequest : array<string|int, mixed>
Tags
_civicrm_api3_generic_getlist_get_result()
_civicrm_api3_generic_getlist_get_result(mixed &$request, string $entity, mixed $meta, array<string|int, mixed> $apiRequest) : array<string|int, mixed>
Parameters
- $request : mixed
- $entity : string
- $meta : mixed
- $apiRequest : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>_civicrm_api3_generic_getList_defaults()
Set defaults for api.getlist.
_civicrm_api3_generic_getList_defaults(string $entity, array<string|int, mixed> &$request, array<string|int, mixed> $apiDefaults, array<string|int, mixed> $fields) : void
Parameters
- $entity : string
- $request : array<string|int, mixed>
- $apiDefaults : array<string|int, mixed>
- $fields : array<string|int, mixed>
_civicrm_api3_generic_getlist_params()
Fallback implementation of getlist_params. May be overridden by individual apis.
_civicrm_api3_generic_getlist_params(array<string|int, mixed> &$request) : mixed
Parameters
- $request : array<string|int, mixed>
_civicrm_api3_generic_getlist_output()
Fallback implementation of getlist_output. May be overridden by individual api functions.
_civicrm_api3_generic_getlist_output(array<string|int, mixed> $result, array<string|int, mixed> $request, string $entity, array<string|int, mixed> $fields) : array<string|int, mixed>
Parameters
- $result : array<string|int, mixed>
- $request : array<string|int, mixed>
- $entity : string
- $fields : array<string|int, mixed>
Return values
array<string|int, mixed>_civicrm_api3_generic_getlist_postprocess()
Common postprocess for getlist output
_civicrm_api3_generic_getlist_postprocess(array<string|int, mixed> $result, array<string|int, mixed> $request, array<string|int, mixed> &$values) : mixed
Parameters
- $result : array<string|int, mixed>
- $request : array<string|int, mixed>
- $values : array<string|int, mixed>
_civicrm_api3_generic_getlist_spec()
Provide metadata for this api
_civicrm_api3_generic_getlist_spec(array<string|int, mixed> &$params, array<string|int, mixed> $apiRequest) : mixed
Parameters
- $params : array<string|int, mixed>
- $apiRequest : array<string|int, mixed>