api/v3/examples/ReportTemplate/Getstatistics.php

   1 <?php
   2 /**
   3  * Test Generated example demonstrating the ReportTemplate.getstatistics API.
   4  *
   5  * Get Statistics from a report (note there isn't much data to get in the test DB).
   6  *
   7  * @return array
   8  *   API result array
   9  */
  10 function report_template_getstatistics_example() {
  11   $params = array(
  12     'report_id' => 'contribute/recur',
  13   );
  14
  15   try{
  16     $result = civicrm_api3('ReportTemplate', 'getstatistics', $params);
  17   }
  18   catch (CiviCRM_API3_Exception $e) {
  19     // Handle error here.
  20     $errorMessage = $e->getMessage();
  21     $errorCode = $e->getErrorCode();
  22     $errorData = $e->getExtraParams();
  23     return array(
  24       'error' => $errorMessage,
  25       'error_code' => $errorCode,
  26       'error_data' => $errorData,
  27     );
  28   }
  29
  30   return $result;
  31 }
  32
  33 /**
  34  * Function returns array of result expected from previous function.
  35  *
  36  * @return array
  37  *   API result array
  38  */
  39 function report_template_getstatistics_expectedresult() {
  40
  41   $expectedResult = array(
  42     'is_error' => 0,
  43     'version' => 3,
  44     'count' => 2,
  45     'values' => array(
  46       'counts' => array(
  47         'rowCount' => array(
  48           'title' => 'Row(s) Listed',
  49           'value' => 0,
  50         ),
  51       ),
  52       'filters' => array(),
  53     ),
  54   );
  55
  56   return $expectedResult;
  57 }
  58
  59 /*
  60 * This example has been generated from the API test suite.
  61 * The test that created it is called "testReportTemplateGetStatisticsAllReports"
  62 * and can be found at:
  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
  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 */