GroupNesting.php
This api exposes CiviCRM GroupNesting.
This defines parent/child relationships between nested groups.
Table of Contents
Functions
- civicrm_api3_group_nesting_get() : array<string|int, mixed>
- Provides group nesting record(s) given parent and/or child id.
- civicrm_api3_group_nesting_create() : array<string|int, mixed>
- Creates group nesting record for given parent and child id.
- _civicrm_api3_group_nesting_create_spec() : mixed
- Adjust Metadata for Create action.
- civicrm_api3_group_nesting_delete() : array<string|int, mixed>
- Removes specific nesting records.
Functions
civicrm_api3_group_nesting_get()
Provides group nesting record(s) given parent and/or child id.
civicrm_api3_group_nesting_get(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
An array containing at least child_group_id or parent_group_id.
Return values
array<string|int, mixed> —list of group nesting records
civicrm_api3_group_nesting_create()
Creates group nesting record for given parent and child id.
civicrm_api3_group_nesting_create(array<string|int, mixed> $params) : array<string|int, mixed>
Parent and child groups need to exist.
Parameters
- $params : array<string|int, mixed>
-
Parameters array - allowed array keys include:.
Return values
array<string|int, mixed> —API success array
_civicrm_api3_group_nesting_create_spec()
Adjust Metadata for Create action.
_civicrm_api3_group_nesting_create_spec(array<string|int, mixed> &$params) : mixed
The metadata is used for setting defaults, documentation & validation.
Parameters
- $params : array<string|int, mixed>
-
Array of parameters determined by getfields.
civicrm_api3_group_nesting_delete()
Removes specific nesting records.
civicrm_api3_group_nesting_delete(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —API Success or fail array