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