3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
13 * This api exposes CiviCRM dashboard contacts.
15 * @package CiviCRM_APIv3
19 * Creates/Updates a new Dashboard Contact Entry.
21 * @param array $params
25 function civicrm_api3_dashboard_contact_create($params) {
26 if (empty($params['id'])) {
27 civicrm_api3_verify_one_mandatory($params,
34 $errors = _civicrm_api3_dashboard_contact_check_params($params);
35 if ($errors !== NULL) {
38 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params, 'DashboardContact');
42 * Gets a CiviCRM Dashlets of Contacts according to parameters.
44 * @param array $params
45 * Array per getfields metadata.
49 function civicrm_api3_dashboard_contact_get($params) {
50 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
54 * Adjust Metadata for Create action.
56 * The metadata is used for setting defaults, documentation & validation.
58 * @param array $params
59 * Array of parameters determined by getfields.
61 function _civicrm_api3_dashboard_contact_create_spec(&$params) {
62 unset($params['version']);
66 * Check permissions on contact dashboard retrieval.
68 * @param array $params
69 * Array per getfields metadata.
73 function _civicrm_api3_dashboard_contact_check_params(&$params) {
74 $dashboard_id = CRM_Utils_Array
::value('dashboard_id', $params);
76 $allDashlets = CRM_Core_BAO_Dashboard
::getDashlets(TRUE, CRM_Utils_Array
::value('check_permissions', $params, 0));
77 if (!isset($allDashlets[$dashboard_id])) {
78 return civicrm_api3_create_error('Invalid or inaccessible dashboard ID');
85 * Delete an existing dashboard-contact.
87 * This method is used to delete any existing dashboard-board. the id of the dashboard-contact
88 * is required field in $params array
90 * @param array $params
93 * @throws \API_Exception
95 function civicrm_api3_dashboard_contact_delete($params) {
96 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);