fd8337a652fcc479962db7307dc44d75dd860912
4 +--------------------------------------------------------------------+
5 | CiviCRM version 4.4 |
6 +--------------------------------------------------------------------+
7 | Copyright CiviCRM LLC (c) 2004-2013 |
8 +--------------------------------------------------------------------+
9 | This file is a part of CiviCRM. |
11 | CiviCRM is free software; you can copy, modify, and distribute it |
12 | under the terms of the GNU Affero General Public License |
13 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
15 | CiviCRM is distributed in the hope that it will be useful, but |
16 | WITHOUT ANY WARRANTY; without even the implied warranty of |
17 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
18 | See the GNU Affero General Public License for more details. |
20 | You should have received a copy of the GNU Affero General Public |
21 | License and the CiviCRM Licensing Exception along |
22 | with this program; if not, contact CiviCRM LLC |
23 | at info[AT]civicrm[DOT]org. If you have questions about the |
24 | GNU Affero General Public License or the licensing of CiviCRM, |
25 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
26 +--------------------------------------------------------------------+
30 * File for the CiviCRM APIv3 for Dashboard Contact
32 * @package CiviCRM_APIv3
33 * @subpackage API_ActionSchedule
35 * @copyright CiviCRM LLC (c) 2004-2013
40 * Creates/Updates a new Dashboard Contact Entry
42 * @param array $params
47 function civicrm_api3_dashboard_contact_create($params) {
48 civicrm_api3_verify_one_mandatory($params,
54 $errors = _civicrm_api3_dashboard_contact_check_params($params);
55 $dashboard[] = $params;
56 $dashbordContact = CRM_Core_BAO_Dashboard
::addContactDashletToDashboard($dashboard);
57 return civicrm_api3_create_success(TRUE);
61 * Gets a CiviCRM Dashlets of Contacts according to parameters
63 * @param array $params Associative array of property name/value
64 * pairs for the activity.
69 function civicrm_api3_dashboard_contact_get($params) {
70 civicrm_api3_verify_one_mandatory($params,
76 $bao = new CRM_Core_BAO_Dashboard();
77 $dashboardContact = CRM_Core_BAO_Dashboard
::getContactDashlets(TRUE, CRM_Utils_Array
::value('contact_id', $params));
78 return civicrm_api3_create_success($dashboardContact, $params, 'dashboard_contact', 'get');
82 * Adjust Metadata for Create action
84 * The metadata is used for setting defaults, documentation & validation
85 * @param array $params array or parameters determined by getfields
87 function _civicrm_api3_dashboard_contact_create_spec(&$params) {
88 unset($params['version']);
91 function _civicrm_api3_dashboard_contact_check_params(&$params) {
92 $dashboard_id = CRM_Utils_Array
::value('dashboard_id', $params);
93 $allDashlets = CRM_Core_BAO_Dashboard
::getDashlets();
94 if (!in_array($dashboard_id, $allDashlets)) {
95 return civicrm_api3_create_error('Invalid Dashboard ID');