Commit | Line | Data |
---|---|---|
2b0e7d03 EM |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
fee14197 | 4 | | CiviCRM version 5 | |
2b0e7d03 | 5 | +--------------------------------------------------------------------+ |
6b83d5bd | 6 | | Copyright CiviCRM LLC (c) 2004-2019 | |
2b0e7d03 EM |
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 the user framework user account. | |
30 | * | |
31 | * @package CiviCRM_APIv3 | |
32 | */ | |
33 | ||
34 | /** | |
35 | * Get details about the CMS User entity. | |
36 | * | |
37 | * @param array $params | |
38 | * | |
39 | * @return array | |
40 | */ | |
41 | function civicrm_api3_user_get($params) { | |
42 | if (empty($params['contact_id'])) { | |
cf8f0fff | 43 | $params['contact_id'] = civicrm_api3('UFMatch', 'getvalue', [ |
2b0e7d03 EM |
44 | 'uf_id' => $params['id'], |
45 | 'domain_id' => CRM_Core_Config::domainID(), | |
46 | 'return' => 'contact_id', | |
cf8f0fff | 47 | ]); |
2b0e7d03 EM |
48 | } |
49 | $result = CRM_Core_Config::singleton()->userSystem->getUser($params['contact_id']); | |
50 | $result['contact_id'] = $params['contact_id']; | |
51 | return civicrm_api3_create_success( | |
cf8f0fff | 52 | [$result['id'] => $result], |
2b0e7d03 EM |
53 | $params, |
54 | 'user', | |
55 | 'get' | |
56 | ); | |
57 | ||
58 | } | |
59 | ||
60 | /** | |
61 | * Adjust Metadata for Get action. | |
62 | * | |
63 | * The metadata is used for setting defaults, documentation & validation. | |
64 | * | |
65 | * @param array $params | |
66 | * Array of parameters determined by getfields. | |
67 | */ | |
68 | function _civicrm_api3_user_get_spec(&$params) { | |
69 | // At this stage contact-id is required - we may be able to loosen this. | |
cf8f0fff | 70 | $params['contact_id'] = [ |
2b0e7d03 EM |
71 | 'title' => 'Contact ID', |
72 | 'type' => CRM_Utils_Type::T_INT, | |
73 | 'api.required' => 1, | |
cf8f0fff CW |
74 | ]; |
75 | $params['id'] = [ | |
2b0e7d03 EM |
76 | 'title' => 'CMS User ID', |
77 | 'type' => CRM_Utils_Type::T_INT, | |
cf8f0fff CW |
78 | ]; |
79 | $params['name'] = [ | |
2b0e7d03 EM |
80 | 'title' => 'Username', |
81 | 'type' => CRM_Utils_Type::T_STRING, | |
cf8f0fff | 82 | ]; |
2b0e7d03 | 83 | } |