api/v3/Dashboard.php

   1 <?php
   2 // $Id$
   3
   4 /*
   5  +--------------------------------------------------------------------+
   6  | CiviCRM version 4.6                                                |
   7  +--------------------------------------------------------------------+
   8  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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-2014
  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
  45  *
  46  * @return array
  47  *   Array containing 'is_error' to denote success or failure and details of the created activity
  48  */
  49 function civicrm_api3_dashboard_create($params) {
  50   civicrm_api3_verify_one_mandatory($params, NULL, array(
  51       'name',
  52       'label',
  53       'url',
  54       'fullscreen_url',
  55     )
  56   );
  57   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Dashboard');
  58 }
  59
  60 /**
  61  * Specify Meta data for create. Note that this data is retrievable via the getfields function
  62  * and is used for pre-filling defaults and ensuring mandatory requirements are met.
  63  * @param array $params
  64  *   (reference) array of parameters determined by getfields.
  65  */
  66 function _civicrm_api3_dashboard_create_spec(&$params) {
  67   unset($params['version']);
  68 }
  69
  70 /**
  71  * Gets a CiviCRM Dashlets according to parameters
  72  *
  73  * @param array $params
  74  *
  75  * @return array
  76  */
  77 function civicrm_api3_dashboard_get($params) {
  78   $bao = new CRM_Core_BAO_Dashboard();
  79   _civicrm_api3_dao_set_filter($bao, $params, TRUE, 'Dashboard');
  80   $dashlets = _civicrm_api3_dao_to_array($bao, $params, TRUE, 'Dashboard');
  81   return civicrm_api3_create_success($dashlets, $params, 'dashboard', 'get', $bao);
  82 }
  83
  84 /**
  85  * Delete a specified Dashlet.
  86  *
  87  * @param array $params
  88  *   Array holding 'id' of dashlet to be deleted.
  89  *
  90  * @return array
  91  */
  92 function civicrm_api3_dashboard_delete($params) {
  93   if (CRM_Core_BAO_Dashboard::deleteDashlet($params['id'])) {
  94     return civicrm_api3_create_success(1, $params, 'dashboard', 'delete');
  95   }
  96   else {
  97     return civicrm_api3_create_error('Could not delete dashlet');
  98   }
  99 }