Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
81621fee | 4 | | CiviCRM version 4.7 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
fa938177 | 6 | | Copyright CiviCRM LLC (c) 2004-2016 | |
6a488035 TO |
7 | +--------------------------------------------------------------------+ |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
10 | | CiviCRM is free software; you can copy, modify, and distribute it | | |
11 | | under the terms of the GNU Affero General Public License | | |
12 | | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. | | |
13 | | | | |
14 | | CiviCRM is distributed in the hope that it will be useful, but | | |
15 | | WITHOUT ANY WARRANTY; without even the implied warranty of | | |
16 | | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | | |
17 | | See the GNU Affero General Public License for more details. | | |
18 | | | | |
19 | | You should have received a copy of the GNU Affero General Public | | |
20 | | License and the CiviCRM Licensing Exception along | | |
21 | | with this program; if not, contact CiviCRM LLC | | |
22 | | at info[AT]civicrm[DOT]org. If you have questions about the | | |
23 | | GNU Affero General Public License or the licensing of CiviCRM, | | |
24 | | see the CiviCRM license FAQ at http://civicrm.org/licensing | | |
25 | +--------------------------------------------------------------------+ | |
26 | */ | |
27 | ||
28 | /** | |
c28e1768 | 29 | * This api exposes CiviCRM user framework match. |
6a488035 TO |
30 | * |
31 | * @package CiviCRM_APIv3 | |
6a488035 TO |
32 | */ |
33 | ||
34 | /** | |
9d32e6f7 | 35 | * Get the contact_id given a uf_id or vice versa. |
6a488035 TO |
36 | * |
37 | * @param array $params | |
38 | * | |
a6c01b45 | 39 | * @return array |
6a488035 TO |
40 | */ |
41 | function civicrm_api3_uf_match_get($params) { | |
42 | return _civicrm_api3_basic_get('CRM_Core_BAO_UFMatch', $params); | |
43 | } | |
44 | ||
45 | /** | |
9d32e6f7 | 46 | * Create or update a UF Match record. |
6a488035 | 47 | * |
cf470720 | 48 | * @param array $params |
9d32e6f7 | 49 | * Array per getfields metadata. |
6a488035 | 50 | * |
a6c01b45 | 51 | * @return array |
9d32e6f7 | 52 | * Api result array |
6a488035 TO |
53 | */ |
54 | function civicrm_api3_uf_match_create($params) { | |
55 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
56 | } | |
11e09c59 TO |
57 | |
58 | /** | |
0aa0303c EM |
59 | * Adjust Metadata for Create action. |
60 | * | |
61 | * The metadata is used for setting defaults, documentation & validation. | |
11e09c59 | 62 | * |
cf470720 | 63 | * @param array $params |
b081365f | 64 | * Array of parameters determined by getfields. |
11e09c59 | 65 | */ |
6a488035 TO |
66 | function _civicrm_api3_uf_match_create_spec(&$params) { |
67 | $params['contact_id']['api.required'] = 1; | |
68 | $params['uf_id']['api.required'] = 1; | |
69 | $params['uf_name']['api.required'] = 1; | |
6a488035 TO |
70 | } |
71 | ||
72 | /** | |
9d32e6f7 | 73 | * Delete a UF Match record. |
6a488035 | 74 | * |
cf470720 | 75 | * @param array $params |
6a488035 | 76 | * |
a6c01b45 | 77 | * @return array |
9d32e6f7 | 78 | * Api result array. |
6a488035 TO |
79 | */ |
80 | function civicrm_api3_uf_match_delete($params) { | |
81 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
82 | } |