UFGroup.php
This api exposes CiviCRM profile group.
Table of Contents
Functions
- _civicrm_api3_uf_group_create_spec() : mixed
- Adjust metadata for create action.
- civicrm_api3_uf_group_create() : array<string|int, mixed>
- Use this API to create a new group.
- civicrm_api3_uf_group_get() : array<string|int, mixed>
- Returns array of uf groups (profiles) matching a set of one or more group properties.
- civicrm_api3_uf_group_delete() : array<string|int, mixed>
- Delete uf group.
- _civicrm_api3_uf_group_getlist_defaults() : array<string|int, mixed>
- Set default getlist parameters.
- _civicrm_api3_uf_group_getlist_output() : array<string|int, mixed>
- Format getlist output
Functions
_civicrm_api3_uf_group_create_spec()
Adjust metadata for create action.
_civicrm_api3_uf_group_create_spec(array<string|int, mixed> &$params) : mixed
Parameters
- $params : array<string|int, mixed>
civicrm_api3_uf_group_create()
Use this API to create a new group.
civicrm_api3_uf_group_create(array<string|int, mixed> $params) : array<string|int, mixed>
See the CRM Data Model for uf_group property definitions
Parameters
- $params : array<string|int, mixed>
-
Array per getfields metadata.
Return values
array<string|int, mixed> —API result array
civicrm_api3_uf_group_get()
Returns array of uf groups (profiles) matching a set of one or more group properties.
civicrm_api3_uf_group_get(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Array of properties. If empty, all records will be returned.
Return values
array<string|int, mixed> —Array of matching profiles
civicrm_api3_uf_group_delete()
Delete uf group.
civicrm_api3_uf_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_uf_group_getlist_defaults()
Set default getlist parameters.
_civicrm_api3_uf_group_getlist_defaults(array<string|int, mixed> &$request) : array<string|int, mixed>
Parameters
- $request : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>_civicrm_api3_uf_group_getlist_output()
Format getlist output
_civicrm_api3_uf_group_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>