Commit | Line | Data |
---|---|---|
fee15d2a | 1 | <?php |
50fb255d | 2 | /** |
a828d7b8 | 3 | * Test Generated example demonstrating the ReportTemplate.getstatistics API. |
50fb255d | 4 | * |
5c49fee0 | 5 | * Get Statistics from a report (note there isn't much data to get in the test DB). |
50fb255d | 6 | * |
7 | * @return array | |
8 | * API result array | |
9 | */ | |
10 | function report_template_getstatistics_example() { | |
11 | $params = array( | |
12 | 'report_id' => 'contribute/recur', | |
13 | ); | |
fee15d2a | 14 | |
50fb255d | 15 | try{ |
a828d7b8 | 16 | $result = civicrm_api3('ReportTemplate', 'getstatistics', $params); |
50fb255d | 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; | |
fee15d2a E |
31 | } |
32 | ||
33 | /** | |
50fb255d | 34 | * Function returns array of result expected from previous function. |
35 | * | |
36 | * @return array | |
37 | * API result array | |
fee15d2a | 38 | */ |
50fb255d | 39 | function report_template_getstatistics_expectedresult() { |
fee15d2a E |
40 | |
41 | $expectedResult = array( | |
50fb255d | 42 | 'is_error' => 0, |
43 | 'version' => 3, | |
44 | 'count' => 2, | |
45 | 'values' => array( | |
fee15d2a | 46 | 'counts' => array( |
50fb255d | 47 | 'rowCount' => array( |
48 | 'title' => 'Row(s) Listed', | |
49 | 'value' => 0, | |
fee15d2a | 50 | ), |
50fb255d | 51 | ), |
fee15d2a E |
52 | 'filters' => array(), |
53 | ), | |
50fb255d | 54 | ); |
fee15d2a E |
55 | |
56 | return $expectedResult; | |
57 | } | |
58 | ||
a828d7b8 | 59 | /* |
50fb255d | 60 | * This example has been generated from the API test suite. |
a828d7b8 CW |
61 | * The test that created it is called "testReportTemplateGetStatisticsAllReports" |
62 | * and can be found at: | |
69d79249 | 63 | * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ReportTemplateTest.php |
fee15d2a E |
64 | * |
65 | * You can see the outcome of the API tests at | |
69d79249 | 66 | * https://test.civicrm.org/job/CiviCRM-master-git/ |
fee15d2a E |
67 | * |
68 | * To Learn about the API read | |
69d79249 | 69 | * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API |
fee15d2a | 70 | * |
69d79249 | 71 | * Browse the api on your own site with the api explorer |
41d4d31f | 72 | * http://MYSITE.ORG/path/to/civicrm/api |
fee15d2a E |
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 | */ |