UFMatch.php
This api exposes CiviCRM user framework match.
Table of Contents
Functions
- civicrm_api3_uf_match_get() : array<string|int, mixed>
- Get the contact_id given a uf_id or vice versa.
- civicrm_api3_uf_match_create() : array<string|int, mixed>
- Create or update a UF Match record.
- _civicrm_api3_uf_match_create_spec() : mixed
- Adjust Metadata for Create action.
- civicrm_api3_uf_match_delete() : array<string|int, mixed>
- Delete a UF Match record.
Functions
civicrm_api3_uf_match_get()
Get the contact_id given a uf_id or vice versa.
civicrm_api3_uf_match_get(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Return values
array<string|int, mixed>civicrm_api3_uf_match_create()
Create or update a UF Match record.
civicrm_api3_uf_match_create(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> —Api result array
_civicrm_api3_uf_match_create_spec()
Adjust Metadata for Create action.
_civicrm_api3_uf_match_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_uf_match_delete()
Delete a UF Match record.
civicrm_api3_uf_match_delete(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Return values
array<string|int, mixed> —Api result array.