3 * Test Generated example demonstrating the Pledge.get API.
5 * demonstrates high date filter
10 function pledge_get_example() {
12 'pledge_start_date_high' => '20150220231942',
16 $result = civicrm_api3('Pledge', 'get', $params);
18 catch (CiviCRM_API3_Exception
$e) {
20 $errorMessage = $e->getMessage();
21 $errorCode = $e->getErrorCode();
22 $errorData = $e->getExtraParams();
24 'error' => $errorMessage,
25 'error_code' => $errorCode,
26 'error_data' => $errorData,
34 * Function returns array of result expected from previous function.
39 function pledge_get_expectedresult() {
41 $expectedResult = array(
49 'contact_type' => 'Individual',
50 'contact_sub_type' => '',
51 'sort_name' => 'Anderson, Anthony',
52 'display_name' => 'Mr. Anthony Anderson II',
54 'pledge_amount' => '100.00',
55 'pledge_create_date' => '2015-02-22 00:00:00',
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',
73 return $expectedResult;
77 * This example has been generated from the API test suite.
78 * The test that created it is called "testPledgeGetReturnFilters"
79 * and can be found at:
80 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/PledgeTest.php
82 * You can see the outcome of the API tests at
83 * https://test.civicrm.org/job/CiviCRM-master-git/
85 * To Learn about the API read
86 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
88 * Browse the api on your own site with the api explorer
89 * http://MYSITE.ORG/path/to/civicrm/api
91 * Read more about testing here
92 * http://wiki.civicrm.org/confluence/display/CRM/Testing
94 * API Standards documentation:
95 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards