<?php
-
/*
+--------------------------------------------------------------------+
- | CiviCRM version 4.5 |
+ | CiviCRM version 4.6 |
+--------------------------------------------------------------------+
| Copyright CiviCRM LLC (c) 2004-2014 |
+--------------------------------------------------------------------+
| GNU Affero General Public License or the licensing of CiviCRM, |
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
+--------------------------------------------------------------------+
-*/
+ */
/**
* File for the CiviCRM APIv3 for Dashboard Contact
/**
* Gets a CiviCRM Dashlets of Contacts according to parameters
*
- * @param array $params Associative array of property name/value
+ * @param array $params
+ * Associative array of property name/value.
* pairs for the activity.
*
* @return array
}
/**
- * Adjust Metadata for Create action
+ * Adjust Metadata for Create action.
+ *
+ * The metadata is used for setting defaults, documentation & validation.
*
- * The metadata is used for setting defaults, documentation & validation
- * @param array $params array or parameters determined by getfields
+ * @param array $params
+ * Array or parameters determined by getfields.
*/
function _civicrm_api3_dashboard_contact_create_spec(&$params) {
unset($params['version']);
* This method is used to delete any existing dashboard-board. the id of the dashboard-contact
* is required field in $params array
*
- * {@getfields dashboard_contact_delete}
- * @access public
+ * @param array $params
+ * @return array
+ * @throws \API_Exception
*/
function civicrm_api3_dashboard_contact_delete($params) {
return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);