Api docblock cleanup.
[civicrm-core.git] / api / v3 / DashboardContact.php
1 <?php
2 /*
3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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 dashboard contacts.
30 *
31 * @package CiviCRM_APIv3
32 */
33
34 /**
35 * Creates/Updates a new Dashboard Contact Entry.
36 *
37 * @param array $params
38 *
39 * @return array
40 */
41 function civicrm_api3_dashboard_contact_create($params) {
42 if (empty($params['id'])) {
43 civicrm_api3_verify_one_mandatory($params,
44 NULL,
45 array(
46 'dashboard_id',
47 )
48 );
49 }
50 $errors = _civicrm_api3_dashboard_contact_check_params($params);
51 if ($errors !== NULL) {
52 return $errors;
53 }
54 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
55 }
56
57 /**
58 * Gets a CiviCRM Dashlets of Contacts according to parameters.
59 *
60 * @param array $params
61 * Array per getfields metadata.
62 *
63 * @return array
64 */
65 function civicrm_api3_dashboard_contact_get($params) {
66 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
67 }
68
69 /**
70 * Adjust Metadata for Create action.
71 *
72 * The metadata is used for setting defaults, documentation & validation.
73 *
74 * @param array $params
75 * Array of parameters determined by getfields.
76 */
77 function _civicrm_api3_dashboard_contact_create_spec(&$params) {
78 unset($params['version']);
79 }
80
81 /**
82 * Check permissions on contact dashboard retrieval.
83 *
84 * @param array $params
85 * Array per getfields metadata.
86 *
87 * @return array|null
88 */
89 function _civicrm_api3_dashboard_contact_check_params(&$params) {
90 $dashboard_id = CRM_Utils_Array::value('dashboard_id', $params);
91 if ($dashboard_id) {
92 $allDashlets = CRM_Core_BAO_Dashboard::getDashlets(TRUE, CRM_Utils_Array::value('check_permissions', $params, 0));
93 if (!isset($allDashlets[$dashboard_id])) {
94 return civicrm_api3_create_error('Invalid or inaccessible dashboard ID');
95 }
96 }
97 return NULL;
98 }
99
100 /**
101 * Delete an existing dashboard-contact.
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 *
106 * @param array $params
107 *
108 * @return array
109 * @throws \API_Exception
110 */
111 function civicrm_api3_dashboard_contact_delete($params) {
112 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
113 }