X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=api%2Fv3%2FReportTemplate.php;h=bf0cea90d712461df70137438d4f910999662a95;hb=44994b86e25125c315112fd6f6cef948fbb0b170;hp=13dd158bd38dc063a2733ac9fba59260e4710d72;hpb=6ce4af3b24412a26d866718fc4030ed74e66d1ac;p=civicrm-core.git

diff --git a/api/v3/ReportTemplate.php b/api/v3/ReportTemplate.php
index 13dd158bd3..bf0cea90d7 100644
--- a/api/v3/ReportTemplate.php
+++ b/api/v3/ReportTemplate.php
@@ -1,18 +1,45 @@
 <?php
+/*
+ +--------------------------------------------------------------------+
+ | CiviCRM version 4.6                                                |
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
+ +--------------------------------------------------------------------+
+ | This file is a part of CiviCRM.                                    |
+ |                                                                    |
+ | CiviCRM is free software; you can copy, modify, and distribute it  |
+ | under the terms of the GNU Affero General Public License           |
+ | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
+ |                                                                    |
+ | CiviCRM is distributed in the hope that it will be useful, but     |
+ | WITHOUT ANY WARRANTY; without even the implied warranty of         |
+ | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
+ | See the GNU Affero General Public License for more details.        |
+ |                                                                    |
+ | You should have received a copy of the GNU Affero General Public   |
+ | License and the CiviCRM Licensing Exception along                  |
+ | with this program; if not, contact CiviCRM LLC                     |
+ | at info[AT]civicrm[DOT]org. If you have questions about the        |
+ | GNU Affero General Public License or the licensing of CiviCRM,     |
+ | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
+ +--------------------------------------------------------------------+
+ */
+
+/**
+ * This api exposes CiviCRM report templates.
+ *
+ * @package CiviCRM_APIv3
+ */
 
 /**
- * Retrieve a report template
+ * Retrieve a report template.
  *
  * FIXME This is a bare-minimum placeholder
  *
  * @param array $params
  *
- * {@example OptionValueGet.php 0}
- * @example OptionValueGet.php
- *
  * @return array
  *   details of found Option Values
- *   {@getfields OptionValue_get}
  */
 function civicrm_api3_report_template_get($params) {
   require_once 'api/v3/OptionValue.php';
@@ -23,17 +50,13 @@ function civicrm_api3_report_template_get($params) {
 }
 
 /**
- *  Add a OptionValue. OptionValues are used to classify CRM entities (including Contacts, Groups and Actions).
+ * Add an OptionValue.
  *
- * Allowed @params array keys are:
- *
- * {@example OptionValueCreate.php}
+ * OptionValues are used to classify CRM entities (including Contacts, Groups and Actions).
  *
  * @param array $params
  *
  * @return array
- *   Array of newly created option_value property values.
- *   {@getfields OptionValue_create}
  */
 function civicrm_api3_report_template_create($params) {
   require_once 'api/v3/OptionValue.php';
@@ -53,7 +76,7 @@ function civicrm_api3_report_template_create($params) {
  * The metadata is used for setting defaults, documentation & validation.
  *
  * @param array $params
- *   Array or parameters determined by getfields.
+ *   Array of parameters determined by getfields.
  */
 function _civicrm_api3_report_template_create_spec(&$params) {
   require_once 'api/v3/OptionValue.php';
@@ -67,15 +90,12 @@ function _civicrm_api3_report_template_create_spec(&$params) {
 }
 
 /**
- * Deletes an existing ReportTemplate
+ * Deletes an existing ReportTemplate.
  *
  * @param array $params
  *
- * {@example ReportTemplateDelete.php 0}
- *
  * @return array
  *   Api result
- *   {@getfields ReportTemplate_create}
  */
 function civicrm_api3_report_template_delete($params) {
   require_once 'api/v3/OptionValue.php';
@@ -83,7 +103,7 @@ function civicrm_api3_report_template_delete($params) {
 }
 
 /**
- * Retrieve rows from a report template
+ * Retrieve rows from a report template.
  *
  * @param array $params
  *   Input parameters.
@@ -94,10 +114,12 @@ function civicrm_api3_report_template_delete($params) {
 function civicrm_api3_report_template_getrows($params) {
   civicrm_api3_verify_one_mandatory($params, NULL, array('report_id', 'instance_id'));
   list($rows, $instance, $metadata) = _civicrm_api3_report_template_getrows($params);
-  return civicrm_api3_create_success($rows, $params, 'report_template', 'getrows', CRM_Core_DAO::$_nullObject, $metadata);
+  return civicrm_api3_create_success($rows, $params, 'ReportTemplate', 'getrows', CRM_Core_DAO::$_nullObject, $metadata);
 }
 
 /**
+ * Get report template rows.
+ *
  * @param array $params
  *
  * @return array
@@ -125,7 +147,7 @@ function _civicrm_api3_report_template_getrows($params) {
   $reportInstance->preProcess();
   $reportInstance->setDefaultValues(FALSE);
   $reportInstance->setParams(array_merge($reportInstance->getDefaultValues(), $params));
-  $options = _civicrm_api3_get_options_from_params($params, TRUE, 'report_template', 'get');
+  $options = _civicrm_api3_get_options_from_params($params, TRUE, 'ReportTemplate', 'get');
   $reportInstance->setLimitValue($options['limit']);
   $reportInstance->setOffsetValue($options['offset']);
   $reportInstance->beginPostProcessCommon();
@@ -150,6 +172,8 @@ function _civicrm_api3_report_template_getrows($params) {
 }
 
 /**
+ * Get statistics from a given report.
+ *
  * @param array $params
  *
  * @return array
@@ -157,16 +181,13 @@ function _civicrm_api3_report_template_getrows($params) {
 function civicrm_api3_report_template_getstatistics($params) {
   list($rows, $reportInstance, $metadata) = _civicrm_api3_report_template_getrows($params);
   $stats = $reportInstance->statistics($rows);
-  return civicrm_api3_create_success($stats, $params, 'report_template', 'getstatistics', CRM_Core_DAO::$_nullObject, $metadata);
+  return civicrm_api3_create_success($stats, $params, 'ReportTemplate', 'getstatistics', CRM_Core_DAO::$_nullObject, $metadata);
 }
 /**
- * Retrieve rows from a report template
+ * Adjust metadata for template getrows action.
  *
  * @param array $params
  *   Input parameters.
- *
- * @return void
- *   details of found instances
  */
 function _civicrm_api3_report_template_getrows_spec(&$params) {
   $params['report_id'] = array(