Commit | Line | Data |
---|---|---|
15d9b3ae N |
1 | <?php |
2 | // $Id$ | |
3 | ||
4 | /* | |
5 | +--------------------------------------------------------------------+ | |
6 | | CiviCRM version 4.4 | | |
7 | +--------------------------------------------------------------------+ | |
8 | | Copyright CiviCRM LLC (c) 2004-2013 | | |
9 | +--------------------------------------------------------------------+ | |
10 | | This file is a part of CiviCRM. | | |
11 | | | | |
12 | | CiviCRM is free software; you can copy, modify, and distribute it | | |
13 | | under the terms of the GNU Affero General Public License | | |
14 | | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. | | |
15 | | | | |
16 | | CiviCRM is distributed in the hope that it will be useful, but | | |
17 | | WITHOUT ANY WARRANTY; without even the implied warranty of | | |
18 | | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | | |
19 | | See the GNU Affero General Public License for more details. | | |
20 | | | | |
21 | | You should have received a copy of the GNU Affero General Public | | |
22 | | License and the CiviCRM Licensing Exception along | | |
23 | | with this program; if not, contact CiviCRM LLC | | |
24 | | at info[AT]civicrm[DOT]org. If you have questions about the | | |
25 | | GNU Affero General Public License or the licensing of CiviCRM, | | |
26 | | see the CiviCRM license FAQ at http://civicrm.org/licensing | | |
27 | +--------------------------------------------------------------------+ | |
28 | */ | |
29 | ||
30 | /** | |
31 | * File for the CiviCRM APIv3 Dashboard functions | |
32 | * | |
33 | * @package CiviCRM_APIv3 | |
34 | * @subpackage API_Activity | |
35 | * @copyright CiviCRM LLC (c) 2004-2013 | |
36 | * @version $Id: Activity.php 30486 2010-11-02 16:12:09Z shot $ | |
37 | * | |
38 | */ | |
39 | ||
40 | ||
41 | /** | |
42 | * Creates or updates an Dashlet. | |
43 | * | |
44 | * @param array $params Associative array of property name/value | |
45 | * pairs for the Dashlet. | |
46 | * | |
47 | * @return array Array containing 'is_error' to denote success or failure and details of the created activity | |
48 | * | |
49 | */ | |
50 | function civicrm_api3_dashboard_create($params) { | |
51 | if (!CRM_Utils_Array::value('id', $params)) { | |
52 | civicrm_api3_verify_one_mandatory($params, | |
53 | NULL, | |
54 | array( | |
55 | 'name', 'label', 'url', 'fullscreen_url', | |
56 | ) | |
57 | ); | |
58 | } | |
59 | // create dashboard element | |
60 | $dashboardBAO = CRM_Core_BAO_Dashboard::addDashlet($params); | |
61 | if (isset($dashboardBAO->id)) { | |
62 | _civicrm_api3_object_to_array($dashboardBAO, $dashboardArray[$dashboardBAO->id]); | |
63 | return civicrm_api3_create_success($dashboardArray, $params, 'dashboard', 'create', $dashboardBAO); | |
64 | } | |
65 | } | |
66 | ||
67 | /** | |
68 | * Specify Meta data for create. Note that this data is retrievable via the getfields function | |
69 | * and is used for pre-filling defaults and ensuring mandatory requirements are met. | |
70 | * @param array $params (reference) array of parameters determined by getfields | |
71 | */ | |
72 | function _civicrm_api3_dashboard_create_spec(&$params) { | |
73 | unset($params['version']); | |
74 | } | |
75 | ||
76 | /** | |
77 | * Gets a CiviCRM Dashlets according to parameters | |
78 | * | |
79 | * @param array $params Associative array of property name/value | |
80 | * pairs for the activity. | |
81 | * | |
82 | * @return array | |
83 | * | |
84 | */ | |
85 | function civicrm_api3_dashboard_get($params) { | |
86 | $bao = new CRM_Core_BAO_Dashboard(); | |
87 | _civicrm_api3_dao_set_filter($bao, $params, true, 'Dashboard'); | |
88 | $dashlets = _civicrm_api3_dao_to_array($bao, $params, true,'Dashboard'); | |
89 | return civicrm_api3_create_success($dashlets, $params, 'dashboard', 'get', $bao); | |
90 | } | |
91 | ||
92 | /** | |
93 | * Delete a specified Dashlet. | |
94 | * | |
95 | * @param array $params array holding 'id' OR 'name' of dashlet to be deleted | |
96 | * | |
97 | * @return void|CRM_Core_Error An error if 'name or ID' is invalid, | |
98 | * | |
99 | */ | |
100 | function civicrm_api3_dashboard_delete($params) { | |
101 | if (CRM_Core_BAO_Dashboard::deleteDashlet($params['id'])) { | |
102 | return civicrm_api3_create_success(1, $params, 'dashboard', 'delete'); | |
103 | } | |
104 | else { | |
105 | return civicrm_api3_create_error('Could not delete dashlet'); | |
106 | } | |
107 | } |