UFJoin.php
This api exposes CiviCRM user framework join.
Table of Contents
Functions
- civicrm_api3_uf_join_create() : array<string|int, mixed>
- Takes an associative array and creates a uf join in the database.
- _civicrm_api3_uf_join_create_spec() : mixed
- Adjust Metadata for Create action.
- civicrm_api3_uf_join_get() : array<string|int, mixed>
- Get CiviCRM UF_Joins (ie joins between CMS user records & CiviCRM user record.
- civicrm_api3_uf_join_delete() : array<string|int, mixed>
- Delete a CiviCRM UF_Join.
Functions
civicrm_api3_uf_join_create()
Takes an associative array and creates a uf join in the database.
civicrm_api3_uf_join_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> —CRM_Core_DAO_UFJoin Array
_civicrm_api3_uf_join_create_spec()
Adjust Metadata for Create action.
_civicrm_api3_uf_join_create_spec(array<string|int, mixed> &$params) : mixed
Parameters
- $params : array<string|int, mixed>
-
Array of parameters determined by getfields.
Tags
civicrm_api3_uf_join_get()
Get CiviCRM UF_Joins (ie joins between CMS user records & CiviCRM user record.
civicrm_api3_uf_join_get(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Array of name/value pairs.
Return values
array<string|int, mixed> —API result array.
civicrm_api3_uf_join_delete()
Delete a CiviCRM UF_Join.
civicrm_api3_uf_join_delete(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Array of name/value pairs.
Return values
array<string|int, mixed> —API result array.