Commit | Line | Data |
---|---|---|
a219d9b1 TM |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
fee14197 | 4 | | CiviCRM version 5 | |
a219d9b1 | 5 | +--------------------------------------------------------------------+ |
6b83d5bd | 6 | | Copyright CiviCRM LLC (c) 2004-2019 | |
a219d9b1 TM |
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 | /** | |
29 | * This api exposes CiviCRM OpenID records. | |
30 | * | |
31 | * @package CiviCRM_APIv3 | |
32 | */ | |
33 | ||
34 | /** | |
35 | * Add an OpenID for a contact. | |
36 | * | |
37 | * @param array $params | |
38 | * | |
39 | * @return array | |
00f8641b | 40 | * API result array |
a219d9b1 | 41 | */ |
533c7496 | 42 | function civicrm_api3_open_i_d_create($params) { |
a25b46e9 | 43 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'OpenID'); |
a219d9b1 TM |
44 | } |
45 | ||
46 | /** | |
47 | * Adjust Metadata for Create action. | |
48 | * | |
49 | * The metadata is used for setting defaults, documentation & validation. | |
50 | * | |
51 | * @param array $params | |
52 | * Array of parameters determined by getfields. | |
53 | */ | |
533c7496 | 54 | function _civicrm_api3_open_i_d_create_spec(&$params) { |
a219d9b1 | 55 | $params['contact_id']['api.required'] = 1; |
0e70279a AS |
56 | $defaultLocation = CRM_Core_BAO_LocationType::getDefault(); |
57 | if ($defaultLocation) { | |
58 | $params['location_type_id']['api.default'] = $defaultLocation->id; | |
59 | } | |
a219d9b1 TM |
60 | } |
61 | ||
62 | /** | |
63 | * Deletes an existing OpenID. | |
64 | * | |
65 | * @param array $params | |
66 | * | |
67 | * @return array | |
00f8641b | 68 | * API result array |
a219d9b1 | 69 | */ |
533c7496 | 70 | function civicrm_api3_open_i_d_delete($params) { |
a219d9b1 TM |
71 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
72 | } | |
73 | ||
74 | /** | |
75 | * Retrieve one or more OpenID. | |
76 | * | |
77 | * @param array $params | |
78 | * An associative array of name/value pairs. | |
79 | * | |
80 | * @return array | |
00f8641b | 81 | * API result array |
a219d9b1 | 82 | */ |
533c7496 | 83 | function civicrm_api3_open_i_d_get($params) { |
a219d9b1 TM |
84 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
85 | } |