CRM-15905 fix - API: problem sorting contacts on ID
[civicrm-core.git] / api / v3 / ReportInstance.php
index ace2fef3a89e030f7557fa95e114e2a3d0e11102..ebf7a44c9681a585ae7ac0c24d4da67e986e84a7 100644 (file)
@@ -1,34 +1,37 @@
 <?php
 
 /**
- * Retrieve a report instance
+ * Retrieve a report instance.
  *
- * @param  array  $params input parameters
+ * @param array $params
+ *   Input parameters.
  *
- * @return  array details of found instances
- * @access public
+ * @return array
+ *   Details of found instances
  */
 function civicrm_api3_report_instance_get($params) {
   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
 
 /**
- *  Add or update a report instance.
+ * Add or update a report instance.
  *
- * @param $params
+ * @param array $params
  *
- * @return array of newly created report instance property values.
- * @access public
+ * @return array
+ *   Array of newly created report instance property values.
  */
 function civicrm_api3_report_instance_create($params) {
   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
 
 /**
- * Adjust Metadata for Create action
+ * Adjust Metadata for Create action.
  *
- * The metadata is used for setting defaults, documentation & validation
- * @param array $params array or parameters determined by getfields
+ * The metadata is used for setting defaults, documentation & validation.
+ *
+ * @param array $params
+ *   Array or parameters determined by getfields.
  */
 function _civicrm_api3_report_instance_create_spec(&$params) {
   $params['report_id']['api.required'] = 1;
@@ -36,12 +39,12 @@ function _civicrm_api3_report_instance_create_spec(&$params) {
 }
 
 /**
- * Deletes an existing ReportInstance
+ * Deletes an existing ReportInstance.
  *
- * @param  array  $params
+ * @param array $params
  *
- * @return array Api result
- * @access public
+ * @return array
+ *   Api result
  */
 function civicrm_api3_report_instance_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);