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