remove print icon
[civicrm-core.git] / api / v3 / examples / Pledge / Get.ex.php
1 <?php
2 /**
3 * Test Generated example demonstrating the Pledge.get API.
4 *
5 * @return array
6 * API result array
7 */
8 function pledge_get_example() {
9 $params = [
10 'pledge_id' => 1,
11 ];
12
13 try{
14 $result = civicrm_api3('Pledge', '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 [
22 'is_error' => 1,
23 'error_message' => $errorMessage,
24 'error_code' => $errorCode,
25 'error_data' => $errorData,
26 ];
27 }
28
29 return $result;
30 }
31
32 /**
33 * Function returns array of result expected from previous function.
34 *
35 * @return array
36 * API result array
37 */
38 function pledge_get_expectedresult() {
39
40 $expectedResult = [
41 'is_error' => 0,
42 'version' => 3,
43 'count' => 1,
44 'id' => 1,
45 'values' => [
46 '1' => [
47 'contact_id' => '5',
48 'contact_type' => 'Individual',
49 'contact_sub_type' => '',
50 'sort_name' => 'Anderson, Anthony',
51 'display_name' => 'Mr. Anthony Anderson II',
52 'pledge_id' => '1',
53 'pledge_amount' => '100.00',
54 'pledge_create_date' => '2019-08-20 00:00:00',
55 'pledge_start_date' => '2019-08-20 00:00:00',
56 'pledge_status' => 'Pending',
57 'pledge_total_paid' => '',
58 'pledge_next_pay_date' => '2019-08-22 00:00:00',
59 'pledge_next_pay_amount' => '20.00',
60 'pledge_outstanding_amount' => '',
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' => '1',
69 ],
70 ],
71 ];
72
73 return $expectedResult;
74 }
75
76 /*
77 * This example has been generated from the API test suite.
78 * The test that created it is called "testGetPledge"
79 * and can be found at:
80 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/PledgeTest.php
81 *
82 * You can see the outcome of the API tests at
83 * https://test.civicrm.org/job/CiviCRM-Core-Matrix/
84 *
85 * To Learn about the API read
86 * https://docs.civicrm.org/dev/en/latest/api/
87 *
88 * Browse the API on your own site with the API Explorer. It is in the main
89 * CiviCRM menu, under: Support > Development > API Explorer.
90 *
91 * Read more about testing here
92 * https://docs.civicrm.org/dev/en/latest/testing/
93 *
94 * API Standards documentation:
95 * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/
96 */