Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
39de6fd5 | 4 | | CiviCRM version 4.6 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
731a0992 | 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
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 | |
32 | * @subpackage API_UF | |
33 | * | |
6a488035 TO |
34 | */ |
35 | ||
36 | /** | |
9d32e6f7 | 37 | * Get the contact_id given a uf_id or vice versa. |
6a488035 TO |
38 | * |
39 | * @param array $params | |
40 | * | |
a6c01b45 | 41 | * @return array |
6a488035 TO |
42 | */ |
43 | function civicrm_api3_uf_match_get($params) { | |
44 | return _civicrm_api3_basic_get('CRM_Core_BAO_UFMatch', $params); | |
45 | } | |
46 | ||
47 | /** | |
9d32e6f7 | 48 | * Create or update a UF Match record. |
6a488035 | 49 | * |
cf470720 | 50 | * @param array $params |
9d32e6f7 | 51 | * Array per getfields metadata. |
6a488035 | 52 | * |
a6c01b45 | 53 | * @return array |
9d32e6f7 | 54 | * Api result array |
6a488035 TO |
55 | */ |
56 | function civicrm_api3_uf_match_create($params) { | |
57 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
58 | } | |
11e09c59 TO |
59 | |
60 | /** | |
0aa0303c EM |
61 | * Adjust Metadata for Create action. |
62 | * | |
63 | * The metadata is used for setting defaults, documentation & validation. | |
11e09c59 | 64 | * |
cf470720 TO |
65 | * @param array $params |
66 | * Array or parameters determined by getfields. | |
11e09c59 | 67 | */ |
6a488035 TO |
68 | function _civicrm_api3_uf_match_create_spec(&$params) { |
69 | $params['contact_id']['api.required'] = 1; | |
70 | $params['uf_id']['api.required'] = 1; | |
71 | $params['uf_name']['api.required'] = 1; | |
6a488035 TO |
72 | } |
73 | ||
74 | /** | |
9d32e6f7 | 75 | * Delete a UF Match record. |
6a488035 | 76 | * |
cf470720 | 77 | * @param array $params |
6a488035 | 78 | * |
a6c01b45 | 79 | * @return array |
9d32e6f7 | 80 | * Api result array. |
6a488035 TO |
81 | */ |
82 | function civicrm_api3_uf_match_delete($params) { | |
83 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
84 | } |