Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
50fb255d | 2 | /** |
a828d7b8 | 3 | * Test Generated example demonstrating the Pledge.get API. |
50fb255d | 4 | * |
5 | * demonstrates high date filter | |
6 | * | |
7 | * @return array | |
8 | * API result array | |
9 | */ | |
10 | function pledge_get_example() { | |
11 | $params = array( | |
a828d7b8 | 12 | 'pledge_start_date_high' => '20150220231942', |
50fb255d | 13 | ); |
6a488035 | 14 | |
50fb255d | 15 | try{ |
a828d7b8 | 16 | $result = civicrm_api3('Pledge', 'get', $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; | |
6a488035 TO |
31 | } |
32 | ||
fb32de45 | 33 | /** |
50fb255d | 34 | * Function returns array of result expected from previous function. |
35 | * | |
36 | * @return array | |
37 | * API result array | |
6a488035 | 38 | */ |
50fb255d | 39 | function pledge_get_expectedresult() { |
6a488035 | 40 | |
53ca8fd7 | 41 | $expectedResult = array( |
50fb255d | 42 | 'is_error' => 0, |
43 | 'version' => 3, | |
44 | 'count' => 1, | |
45 | 'id' => 2, | |
46 | 'values' => array( | |
53ca8fd7 | 47 | '2' => array( |
50fb255d | 48 | 'contact_id' => '8', |
49 | 'contact_type' => 'Individual', | |
50 | 'contact_sub_type' => '', | |
51 | 'sort_name' => 'Anderson, Anthony', | |
52 | 'display_name' => 'Mr. Anthony Anderson II', | |
53 | 'pledge_id' => '2', | |
54 | 'pledge_amount' => '100.00', | |
a828d7b8 | 55 | 'pledge_create_date' => '2015-02-22 00:00:00', |
50fb255d | 56 | 'pledge_status' => 'Overdue', |
57 | 'pledge_total_paid' => '', | |
58 | 'pledge_next_pay_date' => '2014-03-07 00:00:00', | |
59 | 'pledge_next_pay_amount' => '20.00', | |
60 | 'pledge_outstanding_amount' => '20.00', | |
61 | 'pledge_financial_type' => 'Donation', | |
62 | 'pledge_contribution_page_id' => '', | |
63 | 'pledge_frequency_interval' => '5', | |
64 | 'pledge_frequency_unit' => 'year', | |
65 | 'pledge_is_test' => 0, | |
66 | 'pledge_campaign_id' => '', | |
67 | 'pledge_currency' => 'USD', | |
68 | 'id' => '2', | |
69 | ), | |
6a488035 | 70 | ), |
50fb255d | 71 | ); |
6a488035 | 72 | |
fb32de45 | 73 | return $expectedResult; |
6a488035 TO |
74 | } |
75 | ||
a828d7b8 | 76 | /* |
50fb255d | 77 | * This example has been generated from the API test suite. |
a828d7b8 CW |
78 | * The test that created it is called "testPledgeGetReturnFilters" |
79 | * and can be found at: | |
69d79249 | 80 | * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/PledgeTest.php |
6a488035 TO |
81 | * |
82 | * You can see the outcome of the API tests at | |
69d79249 | 83 | * https://test.civicrm.org/job/CiviCRM-master-git/ |
6a488035 TO |
84 | * |
85 | * To Learn about the API read | |
69d79249 | 86 | * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API |
6a488035 | 87 | * |
69d79249 | 88 | * Browse the api on your own site with the api explorer |
41d4d31f | 89 | * http://MYSITE.ORG/path/to/civicrm/api |
6a488035 TO |
90 | * |
91 | * Read more about testing here | |
92 | * http://wiki.civicrm.org/confluence/display/CRM/Testing | |
93 | * | |
94 | * API Standards documentation: | |
95 | * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards | |
b259a4ab | 96 | */ |