api/v3/Dashboard.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  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.   |
  13  |                                                                    |
  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.        |
  18  |                                                                    |
  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  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  * This api exposes CiviCRM Dashboard.
  30  *
  31  * @package CiviCRM_APIv3
  32  */
  33
  34
  35 /**
  36  * Creates or updates an Dashlet.
  37  *
  38  * @param array $params
  39  *
  40  * @return array
  41  *   Array containing 'is_error' to denote success or failure and details of the created activity
  42  */
  43 function civicrm_api3_dashboard_create($params) {
  44   civicrm_api3_verify_one_mandatory($params, NULL, [
  45       'name',
  46       'label',
  47       'url',
  48       'fullscreen_url',
  49     ]
  50   );
  51   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Dashboard');
  52 }
  53
  54 /**
  55  * Specify Meta data for create.
  56  *
  57  * Note that this data is retrievable via the getfields function
  58  * and is used for pre-filling defaults and ensuring mandatory requirements are met.
  59  *
  60  * @param array $params
  61  *   array of parameters determined by getfields.
  62  */
  63 function _civicrm_api3_dashboard_create_spec(&$params) {
  64   $params['is_active']['api.default'] = 1;
  65   unset($params['version']);
  66 }
  67
  68 /**
  69  * Gets a CiviCRM Dashlets according to parameters.
  70  *
  71  * @param array $params
  72  *
  73  * @return array
  74  */
  75 function civicrm_api3_dashboard_get($params) {
  76   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  77 }
  78
  79 /**
  80  * Delete a specified Dashlet.
  81  *
  82  * @param array $params
  83  *   Array holding 'id' of dashlet to be deleted.
  84  * @return array
  85  * @throws API_Exception
  86  */
  87 function civicrm_api3_dashboard_delete($params) {
  88   if (CRM_Core_BAO_Dashboard::deleteDashlet($params['id'])) {
  89     return civicrm_api3_create_success(1, $params, 'Dashboard', 'delete');
  90   }
  91   else {
  92     throw new API_Exception('Could not delete dashlet');
  93   }
  94 }