Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
a30c801b | 4 | | Copyright CiviCRM LLC. All rights reserved. | |
6a488035 | 5 | | | |
a30c801b TO |
6 | | This work is published under the GNU AGPLv3 license with some | |
7 | | permitted exceptions and without any warranty. For full license | | |
8 | | and copyright information, see https://civicrm.org/licensing | | |
6a488035 TO |
9 | +--------------------------------------------------------------------+ |
10 | */ | |
11 | ||
12 | /** | |
c28e1768 | 13 | * This api exposes CiviCRM user framework join. |
6a488035 TO |
14 | * |
15 | * @package CiviCRM_APIv3 | |
6a488035 TO |
16 | */ |
17 | ||
6a488035 | 18 | /** |
9d32e6f7 | 19 | * Takes an associative array and creates a uf join in the database. |
6a488035 | 20 | * |
cf470720 | 21 | * @param array $params |
2e66abf8 | 22 | * Array per getfields metadata. |
6a488035 | 23 | * |
a6c01b45 | 24 | * @return array |
72b3a70c | 25 | * CRM_Core_DAO_UFJoin Array |
6a488035 TO |
26 | */ |
27 | function civicrm_api3_uf_join_create($params) { | |
28 | ||
29 | $ufJoin = CRM_Core_BAO_UFJoin::create($params); | |
30 | _civicrm_api3_object_to_array($ufJoin, $ufJoinArray[]); | |
244bbdd8 | 31 | return civicrm_api3_create_success($ufJoinArray, $params, 'UFJoin', 'create'); |
6a488035 | 32 | } |
11e09c59 TO |
33 | |
34 | /** | |
0aa0303c | 35 | * Adjust Metadata for Create action. |
1c88e578 | 36 | * |
cf470720 | 37 | * @param array $params |
b081365f | 38 | * Array of parameters determined by getfields. |
1747ab99 | 39 | * |
1c88e578 | 40 | * @todo - suspect module, weight don't need to be required - need to test |
6a488035 TO |
41 | */ |
42 | function _civicrm_api3_uf_join_create_spec(&$params) { | |
43 | $params['module']['api.required'] = 1; | |
44 | $params['weight']['api.required'] = 1; | |
45 | $params['uf_group_id']['api.required'] = 1; | |
46 | } | |
47 | ||
48 | /** | |
1747ab99 | 49 | * Get CiviCRM UF_Joins (ie joins between CMS user records & CiviCRM user record. |
6a488035 | 50 | * |
cf470720 | 51 | * @param array $params |
1747ab99 | 52 | * Array of name/value pairs. |
6a488035 | 53 | * |
a6c01b45 | 54 | * @return array |
1747ab99 | 55 | * API result array. |
6a488035 TO |
56 | */ |
57 | function civicrm_api3_uf_join_get($params) { | |
58 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
59 | } | |
91b24cbc TL |
60 | |
61 | /** | |
ea3ddccf | 62 | * Delete a CiviCRM UF_Join. |
91b24cbc TL |
63 | * |
64 | * @param array $params | |
65 | * Array of name/value pairs. | |
ea3ddccf | 66 | * |
67 | * @return array | |
68 | * API result array. | |
91b24cbc TL |
69 | */ |
70 | function civicrm_api3_uf_join_delete($params) { | |
71 | return _civicrm_api3_basic_delete('CRM_Core_BAO_UFJoin', $params); | |
72 | } |