api/v3/examples/ReportTemplate/Getstatistics.php

   1 <?php
   2 /**
   3  * Test Generated example of using report_template getstatistics API
   4  * Get Statistics from a report (note there isn't much data to get in the test DB :-( *
   5  */
   6 function report_template_getstatistics_example(){
   7 $params = array(
   8   'report_id' => 'member/contributionDetail',
   9 );
  10
  11 try{
  12   $result = civicrm_api3('report_template', 'getstatistics', $params);
  13 }
  14 catch (CiviCRM_API3_Exception $e) {
  15   // handle error here
  16   $errorMessage = $e->getMessage();
  17   $errorCode = $e->getErrorCode();
  18   $errorData = $e->getExtraParams();
  19   return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
  20 }
  21
  22 return $result;
  23 }
  24
  25 /**
  26  * Function returns array of result expected from previous function
  27  */
  28 function report_template_getstatistics_expectedresult(){
  29
  30   $expectedResult = array(
  31   'is_error' => 0,
  32   'version' => 3,
  33   'count' => 2,
  34   'values' => array(
  35       'counts' => array(
  36           'rowCount' => array(
  37               'title' => 'Row(s) Listed',
  38               'value' => 0,
  39             ),
  40           'amount' => array(
  41               'title' => 'Total Amount',
  42               'value' => '',
  43               'type' => 2,
  44             ),
  45           'avg' => array(
  46               'title' => 'Average',
  47               'value' => '',
  48               'type' => 2,
  49             ),
  50         ),
  51       'filters' => array(),
  52     ),
  53 );
  54
  55   return $expectedResult;
  56 }
  57
  58
  59 /*
  60 * This example has been generated from the API test suite. The test that created it is called
  61 *
  62 * testReportTemplateGetStatisticsAllReports and can be found in
  63 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ReportTemplateTest.php
  64 *
  65 * You can see the outcome of the API tests at
  66 * https://test.civicrm.org/job/CiviCRM-master-git/
  67 *
  68 * To Learn about the API read
  69 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
  70 *
  71 * Browse the api on your own site with the api explorer
  72 * http://MYSITE.ORG/path/to/civicrm/api/explorer
  73 *
  74 * Read more about testing here
  75 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  76 *
  77 * API Standards documentation:
  78 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  79 */