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