CustomGroup.php
This api exposes CiviCRM custom group.
Table of Contents
Functions
- civicrm_api3_custom_group_create() : array<string|int, mixed>
- This entire function consists of legacy handling, probably for a form that no longer exists.
- _civicrm_api3_custom_group_create_spec() : mixed
- Adjust Metadata for Create action.
- civicrm_api3_custom_group_delete() : array<string|int, mixed>
- Use this API to delete an existing group.
- civicrm_api3_custom_group_get() : array<string|int, mixed>
- API to get existing custom fields.
- civicrm_api3_custom_group_setvalue() : array<string|int, mixed>
- CRM-15191 - Hack to ensure the cache gets cleared after updating a custom group.
- civicrm_api3_custom_group_getoptions() : mixed
Functions
civicrm_api3_custom_group_create()
This entire function consists of legacy handling, probably for a form that no longer exists.
civicrm_api3_custom_group_create(array<string|int, mixed> $params) : array<string|int, mixed>
APIv3 is where code like this goes to die...
Parameters
- $params : array<string|int, mixed>
-
For legacy reasons, 'extends' can be passed as an array (for setting Participant column_value)
Return values
array<string|int, mixed>_civicrm_api3_custom_group_create_spec()
Adjust Metadata for Create action.
_civicrm_api3_custom_group_create_spec(array<string|int, mixed> &$params) : mixed
Parameters
- $params : array<string|int, mixed>
-
Array of parameters determined by getfields.
civicrm_api3_custom_group_delete()
Use this API to delete an existing group.
civicrm_api3_custom_group_delete(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Return values
array<string|int, mixed>civicrm_api3_custom_group_get()
API to get existing custom fields.
civicrm_api3_custom_group_get(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Array per getfields metadata.
Return values
array<string|int, mixed>civicrm_api3_custom_group_setvalue()
CRM-15191 - Hack to ensure the cache gets cleared after updating a custom group.
civicrm_api3_custom_group_setvalue(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Array per getfields metadata.
Return values
array<string|int, mixed>civicrm_api3_custom_group_getoptions()
civicrm_api3_custom_group_getoptions(mixed $params) : mixed
Parameters
- $params : mixed