Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
50fb255d | 2 | /** |
3 | * Test Generated example of using contribution_recur get API. | |
4 | * | |
50fb255d | 5 | * @return array |
6 | * API result array | |
7 | */ | |
8 | function contribution_recur_get_example() { | |
9 | $params = array( | |
10 | 'amount' => '500', | |
11 | ); | |
6a488035 | 12 | |
50fb255d | 13 | try{ |
14 | $result = civicrm_api3('contribution_recur', 'get', $params); | |
15 | } | |
16 | catch (CiviCRM_API3_Exception $e) { | |
17 | // Handle error here. | |
18 | $errorMessage = $e->getMessage(); | |
19 | $errorCode = $e->getErrorCode(); | |
20 | $errorData = $e->getExtraParams(); | |
21 | return array( | |
22 | 'error' => $errorMessage, | |
23 | 'error_code' => $errorCode, | |
24 | 'error_data' => $errorData, | |
25 | ); | |
26 | } | |
27 | ||
28 | return $result; | |
6a488035 TO |
29 | } |
30 | ||
fb32de45 | 31 | /** |
50fb255d | 32 | * Function returns array of result expected from previous function. |
33 | * | |
34 | * @return array | |
35 | * API result array | |
6a488035 | 36 | */ |
50fb255d | 37 | function contribution_recur_get_expectedresult() { |
6a488035 | 38 | |
edb0d67a | 39 | $expectedResult = array( |
50fb255d | 40 | 'is_error' => 0, |
41 | 'version' => 3, | |
42 | 'count' => 1, | |
43 | 'id' => 2, | |
44 | 'values' => array( | |
45 | '2' => array( | |
46 | 'id' => '2', | |
47 | 'contact_id' => '4', | |
48 | 'amount' => '500.00', | |
49 | 'currency' => 'USD', | |
50 | 'frequency_unit' => 'day', | |
51 | 'frequency_interval' => '1', | |
52 | 'installments' => '12', | |
53 | 'start_date' => '2013-07-29 00:00:00', | |
54 | 'create_date' => '20120130621222105', | |
55 | 'contribution_status_id' => '1', | |
56 | 'is_test' => 0, | |
57 | 'cycle_day' => '1', | |
58 | 'failure_count' => 0, | |
59 | 'auto_renew' => 0, | |
60 | 'is_email_receipt' => '1', | |
61 | ), | |
6a488035 | 62 | ), |
50fb255d | 63 | ); |
6a488035 | 64 | |
fb32de45 | 65 | return $expectedResult; |
6a488035 TO |
66 | } |
67 | ||
50fb255d | 68 | /** |
69 | * This example has been generated from the API test suite. | |
70 | * The test that created it is called | |
71 | * testGetContributionRecur | |
72 | * and can be found in | |
69d79249 | 73 | * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContributionRecurTest.php |
6a488035 TO |
74 | * |
75 | * You can see the outcome of the API tests at | |
69d79249 | 76 | * https://test.civicrm.org/job/CiviCRM-master-git/ |
6a488035 TO |
77 | * |
78 | * To Learn about the API read | |
69d79249 | 79 | * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API |
6a488035 | 80 | * |
69d79249 | 81 | * Browse the api on your own site with the api explorer |
41d4d31f | 82 | * http://MYSITE.ORG/path/to/civicrm/api |
6a488035 TO |
83 | * |
84 | * Read more about testing here | |
85 | * http://wiki.civicrm.org/confluence/display/CRM/Testing | |
86 | * | |
87 | * API Standards documentation: | |
88 | * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards | |
b259a4ab | 89 | */ |