CRM-13918 report_template api - add test generated examples

----------------------------------------
* CRM-13918: Add Report.getrows api
  http://issues.civicrm.org/jira/browse/CRM-13918

diff --git a/api/v3/examples/ReportTemplate/Getrows.php b/api/v3/examples/ReportTemplate/Getrows.php
new file mode 100644 (file)
index 0000000..6b29966
--- /dev/null
+++ b/api/v3/examples/ReportTemplate/Getrows.php
@@ -0,0 +1,76 @@
+<?php
+/**
+ * Test Generated example of using report_template getrows API
+ * Retrieve rows from a report template (optionally providing the instance_id) *
+ */
+function report_template_getrows_example(){
+$params = array(
+  'report_id' => 'contact/summary',
+);
+
+try{
+  $result = civicrm_api3('report_template', 'getrows', $params);
+}
+catch (CiviCRM_API3_Exception $e) {
+  // handle error here
+  $errorMessage = $e->getMessage();
+  $errorCode = $e->getErrorCode();
+  $errorData = $e->getExtraParams();
+  return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
+}
+
+return $result;
+}
+
+/**
+ * Function returns array of result expected from previous function
+ */
+function report_template_getrows_expectedresult(){
+
+  $expectedResult = array(
+  'is_error' => 0,
+  'version' => 3,
+  'count' => 2,
+  'values' => array(
+      '0' => array(
+          'civicrm_contact_sort_name' => 'Default Organization',
+          'civicrm_contact_id' => '1',
+          'civicrm_address_street_address' => '',
+          'civicrm_address_city' => '',
+          'civicrm_country_name' => '',
+        ),
+      '1' => array(
+          'civicrm_contact_sort_name' => 'Second Domain',
+          'civicrm_contact_id' => '2',
+          'civicrm_address_street_address' => '15 Main St',
+          'civicrm_address_city' => 'Collinsville',
+          'civicrm_country_name' => 'United States',
+        ),
+    ),
+);
+
+  return $expectedResult;
+}
+
+
+/*
+* This example has been generated from the API test suite. The test that created it is called
+*
+* testReportTemplateGetRowsContactSummary and can be found in
+* http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/ReportTemplateTest.php
+*
+* You can see the outcome of the API tests at
+* http://tests.dev.civicrm.org/trunk/results-api_v3
+*
+* To Learn about the API read
+* http://book.civicrm.org/developer/current/techniques/api/
+*
+* and review the wiki at
+* http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs
+*
+* Read more about testing here
+* http://wiki.civicrm.org/confluence/display/CRM/Testing
+*
+* API Standards documentation:
+* http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
+*/

diff --git a/api/v3/examples/ReportTemplate/Getstatistics.php b/api/v3/examples/ReportTemplate/Getstatistics.php
new file mode 100644 (file)
index 0000000..701779e
--- /dev/null
+++ b/api/v3/examples/ReportTemplate/Getstatistics.php
@@ -0,0 +1,79 @@
+<?php
+/**
+ * Test Generated example of using report_template getstatistics API
+ * Get Statistics from a report (note there isn't much data to get in the test DB :-( *
+ */
+function report_template_getstatistics_example(){
+$params = array(
+  'report_id' => 'member/contributionDetail',
+);
+
+try{
+  $result = civicrm_api3('report_template', 'getstatistics', $params);
+}
+catch (CiviCRM_API3_Exception $e) {
+  // handle error here
+  $errorMessage = $e->getMessage();
+  $errorCode = $e->getErrorCode();
+  $errorData = $e->getExtraParams();
+  return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
+}
+
+return $result;
+}
+
+/**
+ * Function returns array of result expected from previous function
+ */
+function report_template_getstatistics_expectedresult(){
+
+  $expectedResult = array(
+  'is_error' => 0,
+  'version' => 3,
+  'count' => 2,
+  'values' => array(
+      'counts' => array(
+          'rowCount' => array(
+              'title' => 'Row(s) Listed',
+              'value' => 0,
+            ),
+          'amount' => array(
+              'title' => 'Total Amount',
+              'value' => '',
+              'type' => 2,
+            ),
+          'avg' => array(
+              'title' => 'Average',
+              'value' => '',
+              'type' => 2,
+            ),
+        ),
+      'filters' => array(),
+    ),
+);
+
+  return $expectedResult;
+}
+
+
+/*
+* This example has been generated from the API test suite. The test that created it is called
+*
+* testReportTemplateGetStatisticsAllReports and can be found in
+* http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/ReportTemplateTest.php
+*
+* You can see the outcome of the API tests at
+* http://tests.dev.civicrm.org/trunk/results-api_v3
+*
+* To Learn about the API read
+* http://book.civicrm.org/developer/current/techniques/api/
+*
+* and review the wiki at
+* http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs
+*
+* Read more about testing here
+* http://wiki.civicrm.org/confluence/display/CRM/Testing
+*
+* API Standards documentation:
+* http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
+*/

diff --git a/tests/phpunit/api/v3/ReportTemplateTest.php b/tests/phpunit/api/v3/ReportTemplateTest.php
index 0674387cfff860c9648b1bfc84c1dc39743f4284..cc25e90dce8e5e2266a5d49b130431ff32751656 100644 (file)
--- a/tests/phpunit/api/v3/ReportTemplateTest.php
+++ b/tests/phpunit/api/v3/ReportTemplateTest.php
@@ -114,9 +114,10 @@ class api_v3_ReportTemplateTest extends CiviUnitTestCase {
    *
    */
   function testReportTemplateGetRowsContactSummary() {
-    $result = $this->callAPISuccess('report_template', 'getrows', array(
+    $description = "Retrieve rows from a report template (optionally providing the instance_id)";
+    $result = $this->callAPIAndDocument('report_template', 'getrows', array(
       'report_id' => 'contact/summary',
-    ));
+    ), __FUNCTION__, __FILE__, $description, 'Getrows', 'getrows');
 
     //the second part of this test has been commented out because it relied on the db being reset to
     // it's base state
@@ -153,9 +154,10 @@ class api_v3_ReportTemplateTest extends CiviUnitTestCase {
     if(in_array($reportID , array('contribute/softcredit', 'contribute/bookkeeping'))) {
       $this->markTestIncomplete($reportID . " has non enotices when calling statistics fn");
     }
-    $result = $this->callAPISuccess('report_template', 'getstatistics', array(
+    $description = "Get Statistics from a report (note there isn't much data to get in the test DB :-(";
+    $result = $this->callAPIAndDocument('report_template', 'getstatistics', array(
       'report_id' => $reportID,
-    ));
+    ), __FUNCTION__, __FILE__, $description, 'Getstatistics', 'getstatistics');
   }
 
   /**