<?php
-// $Id$
-
/*
+--------------------------------------------------------------------+
| CiviCRM version 4.6 |
+--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014 |
+ | Copyright CiviCRM LLC (c) 2004-2015 |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
*/
/**
- * File for the CiviCRM APIv3 Dashboard functions
+ * This api exposes CiviCRM Dashboard.
*
* @package CiviCRM_APIv3
- * @subpackage API_Activity
- * @copyright CiviCRM LLC (c) 2004-2014
- * @version $Id: Activity.php 30486 2010-11-02 16:12:09Z shot $
- *
*/
}
/**
- * Specify Meta data for create. Note that this data is retrievable via the getfields function
+ * Specify Meta data for create.
+ *
+ * Note that this data is retrievable via the getfields function
* and is used for pre-filling defaults and ensuring mandatory requirements are met.
+ *
* @param array $params
- * (reference) array of parameters determined by getfields.
+ * array of parameters determined by getfields.
*/
function _civicrm_api3_dashboard_create_spec(&$params) {
unset($params['version']);
}
/**
- * Gets a CiviCRM Dashlets according to parameters
+ * Gets a CiviCRM Dashlets according to parameters.
*
* @param array $params
*
*/
function civicrm_api3_dashboard_get($params) {
$bao = new CRM_Core_BAO_Dashboard();
- _civicrm_api3_dao_set_filter($bao, $params, TRUE, 'Dashboard');
+ _civicrm_api3_dao_set_filter($bao, $params, TRUE);
$dashlets = _civicrm_api3_dao_to_array($bao, $params, TRUE, 'Dashboard');
- return civicrm_api3_create_success($dashlets, $params, 'dashboard', 'get', $bao);
+ return civicrm_api3_create_success($dashlets, $params, 'Dashboard', 'get', $bao);
}
/**
*/
function civicrm_api3_dashboard_delete($params) {
if (CRM_Core_BAO_Dashboard::deleteDashlet($params['id'])) {
- return civicrm_api3_create_success(1, $params, 'dashboard', 'delete');
+ return civicrm_api3_create_success(1, $params, 'Dashboard', 'delete');
}
else {
return civicrm_api3_create_error('Could not delete dashlet');