X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=api%2Fv3%2FReportTemplate.php;h=ad618ac654d699c7b80b58a5d3d9ab6ef35acf11;hb=85bb0909cffd925f4cd5c0022a68a1ff74d3ad8e;hp=f83a8f4e4cfc0daf372eaad0ee8c183983681829;hpb=781d91c8878db0c136a5d99f80a9656fe6d1faab;p=civicrm-core.git diff --git a/api/v3/ReportTemplate.php b/api/v3/ReportTemplate.php index f83a8f4e4c..ad618ac654 100644 --- a/api/v3/ReportTemplate.php +++ b/api/v3/ReportTemplate.php @@ -5,7 +5,9 @@ * * FIXME This is a bare-minimum placeholder * - * @param array $ params input parameters + * @param $params + * + * @internal param $array $ params input parameters * * {@example OptionValueGet.php 0} * @example OptionValueGet.php @@ -29,6 +31,8 @@ function civicrm_api3_report_template_get($params) { * * {@example OptionValueCreate.php} * + * @param $params + * * @return array of newly created option_value property values. * {@getfields OptionValue_create} * @access public @@ -92,6 +96,13 @@ function civicrm_api3_report_template_getrows($params) { return civicrm_api3_create_success($rows, $params, 'report_template', 'getrows', CRM_Core_DAO::$_nullObject, $metadata); } +/** + * @param $params + * + * @return array + * @throws API_Exception + * @throws CiviCRM_API3_Exception + */ function _civicrm_api3_report_template_getrows($params) { if(empty($params['report_id'])) { $params['report_id'] = civicrm_api3('report_instance', 'getvalue', array('id' => $params['instance_id'], 'return' => 'report_id')); @@ -137,6 +148,11 @@ function _civicrm_api3_report_template_getrows($params) { return array($rows, $reportInstance, $metadata); } +/** + * @param $params + * + * @return array + */ function civicrm_api3_report_template_getstatistics($params) { list($rows, $reportInstance, $metadata) = _civicrm_api3_report_template_getrows($params); $stats = $reportInstance->statistics($rows);