3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
29 * File for the CiviCRM APIv3 for Dashboard Contact
31 * @package CiviCRM_APIv3
32 * @subpackage API_ActionSchedule
34 * @copyright CiviCRM LLC (c) 2004-2014
39 * Creates/Updates a new Dashboard Contact Entry
41 * @param array $params
46 function civicrm_api3_dashboard_contact_create($params) {
47 if (empty($params['id'])) {
48 civicrm_api3_verify_one_mandatory($params,
55 $errors = _civicrm_api3_dashboard_contact_check_params($params);
56 if ($errors !== NULL) {
59 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
63 * Gets a CiviCRM Dashlets of Contacts according to parameters
65 * @param array $params
66 * Associative array of property name/value.
67 * pairs for the activity.
72 function civicrm_api3_dashboard_contact_get($params) {
73 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
77 * Adjust Metadata for Create action
79 * The metadata is used for setting defaults, documentation & validation
80 * @param array $params
81 * Array or parameters determined by getfields.
83 function _civicrm_api3_dashboard_contact_create_spec(&$params) {
84 unset($params['version']);
88 * @param array $params
92 function _civicrm_api3_dashboard_contact_check_params(&$params) {
93 $dashboard_id = CRM_Utils_Array
::value('dashboard_id', $params);
95 $allDashlets = CRM_Core_BAO_Dashboard
::getDashlets(TRUE, CRM_Utils_Array
::value('check_permissions', $params, 0));
96 if (!isset($allDashlets[$dashboard_id])) {
97 return civicrm_api3_create_error('Invalid or inaccessible dashboard ID');
104 * Delete an existing dashboard-contact
106 * This method is used to delete any existing dashboard-board. the id of the dashboard-contact
107 * is required field in $params array
109 * {@getfields dashboard_contact_delete}
113 * @throws \API_Exception
115 function civicrm_api3_dashboard_contact_delete($params) {
116 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);