Commit | Line | Data |
---|---|---|
15d9b3ae | 1 | <?php |
15d9b3ae N |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
81621fee | 4 | | CiviCRM version 4.7 | |
15d9b3ae | 5 | +--------------------------------------------------------------------+ |
e7112fa7 | 6 | | Copyright CiviCRM LLC (c) 2004-2015 | |
15d9b3ae N |
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 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
15d9b3ae N |
27 | |
28 | /** | |
c28e1768 | 29 | * This api exposes CiviCRM dashboard contacts. |
15d9b3ae N |
30 | * |
31 | * @package CiviCRM_APIv3 | |
15d9b3ae N |
32 | */ |
33 | ||
34 | /** | |
61fe4988 | 35 | * Creates/Updates a new Dashboard Contact Entry. |
15d9b3ae N |
36 | * |
37 | * @param array $params | |
38 | * | |
39 | * @return array | |
15d9b3ae N |
40 | */ |
41 | function civicrm_api3_dashboard_contact_create($params) { | |
dcf56200 TO |
42 | if (empty($params['id'])) { |
43 | civicrm_api3_verify_one_mandatory($params, | |
44 | NULL, | |
45 | array( | |
46 | 'dashboard_id', | |
47 | ) | |
48 | ); | |
49 | } | |
15d9b3ae | 50 | $errors = _civicrm_api3_dashboard_contact_check_params($params); |
dcf56200 TO |
51 | if ($errors !== NULL) { |
52 | return $errors; | |
53 | } | |
54 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
15d9b3ae N |
55 | } |
56 | ||
57 | /** | |
2e66abf8 | 58 | * Gets a CiviCRM Dashlets of Contacts according to parameters. |
15d9b3ae | 59 | * |
cf470720 | 60 | * @param array $params |
2e66abf8 | 61 | * Array per getfields metadata. |
15d9b3ae N |
62 | * |
63 | * @return array | |
15d9b3ae N |
64 | */ |
65 | function civicrm_api3_dashboard_contact_get($params) { | |
dcf56200 | 66 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
15d9b3ae N |
67 | } |
68 | ||
69 | /** | |
0aa0303c EM |
70 | * Adjust Metadata for Create action. |
71 | * | |
72 | * The metadata is used for setting defaults, documentation & validation. | |
15d9b3ae | 73 | * |
cf470720 | 74 | * @param array $params |
b081365f | 75 | * Array of parameters determined by getfields. |
15d9b3ae N |
76 | */ |
77 | function _civicrm_api3_dashboard_contact_create_spec(&$params) { | |
78 | unset($params['version']); | |
79 | } | |
80 | ||
aa1b1481 | 81 | /** |
2e66abf8 EM |
82 | * Check permissions on contact dashboard retrieval. |
83 | * | |
c490a46a | 84 | * @param array $params |
2e66abf8 | 85 | * Array per getfields metadata. |
aa1b1481 EM |
86 | * |
87 | * @return array|null | |
88 | */ | |
15d9b3ae N |
89 | function _civicrm_api3_dashboard_contact_check_params(&$params) { |
90 | $dashboard_id = CRM_Utils_Array::value('dashboard_id', $params); | |
dcf56200 | 91 | if ($dashboard_id) { |
ee117e9c | 92 | $allDashlets = CRM_Core_BAO_Dashboard::getDashlets(TRUE, CRM_Utils_Array::value('check_permissions', $params, 0)); |
dcf56200 | 93 | if (!isset($allDashlets[$dashboard_id])) { |
ee117e9c | 94 | return civicrm_api3_create_error('Invalid or inaccessible dashboard ID'); |
dcf56200 | 95 | } |
15d9b3ae | 96 | } |
151da6c3 | 97 | return NULL; |
510513d8 TO |
98 | } |
99 | ||
100 | /** | |
dc64d047 | 101 | * Delete an existing dashboard-contact. |
510513d8 TO |
102 | * |
103 | * This method is used to delete any existing dashboard-board. the id of the dashboard-contact | |
104 | * is required field in $params array | |
105 | * | |
d0997921 | 106 | * @param array $params |
dc64d047 | 107 | * |
645ee340 EM |
108 | * @return array |
109 | * @throws \API_Exception | |
510513d8 TO |
110 | */ |
111 | function civicrm_api3_dashboard_contact_delete($params) { | |
112 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
113 | } |