Commit | Line | Data |
---|---|---|
4f53d6f2 | 1 | <?php |
50fb255d | 2 | /** |
a828d7b8 | 3 | * Test Generated example demonstrating the ContributionSoft.get API. |
50fb255d | 4 | * |
50fb255d | 5 | * @return array |
6 | * API result array | |
7 | */ | |
8 | function contribution_soft_get_example() { | |
cf8f0fff | 9 | $params = [ |
50fb255d | 10 | 'id' => 1, |
cf8f0fff | 11 | ]; |
4f53d6f2 | 12 | |
50fb255d | 13 | try{ |
a828d7b8 | 14 | $result = civicrm_api3('ContributionSoft', 'get', $params); |
50fb255d | 15 | } |
16 | catch (CiviCRM_API3_Exception $e) { | |
17 | // Handle error here. | |
18 | $errorMessage = $e->getMessage(); | |
19 | $errorCode = $e->getErrorCode(); | |
20 | $errorData = $e->getExtraParams(); | |
cf8f0fff | 21 | return [ |
5be22f39 | 22 | 'is_error' => 1, |
23 | 'error_message' => $errorMessage, | |
50fb255d | 24 | 'error_code' => $errorCode, |
25 | 'error_data' => $errorData, | |
cf8f0fff | 26 | ]; |
50fb255d | 27 | } |
28 | ||
29 | return $result; | |
4f53d6f2 | 30 | } |
31 | ||
fb32de45 | 32 | /** |
50fb255d | 33 | * Function returns array of result expected from previous function. |
34 | * | |
35 | * @return array | |
36 | * API result array | |
4f53d6f2 | 37 | */ |
50fb255d | 38 | function contribution_soft_get_expectedresult() { |
4f53d6f2 | 39 | |
cf8f0fff | 40 | $expectedResult = [ |
50fb255d | 41 | 'is_error' => 0, |
42 | 'version' => 3, | |
43 | 'count' => 1, | |
44 | 'id' => 1, | |
cf8f0fff CW |
45 | 'values' => [ |
46 | '1' => [ | |
50fb255d | 47 | 'id' => '1', |
48 | 'contribution_id' => '1', | |
49 | 'contact_id' => '4', | |
50 | 'amount' => '10.00', | |
51 | 'currency' => 'USD', | |
52 | 'pcp_display_in_roll' => 0, | |
53 | 'soft_credit_type_id' => '4', | |
cf8f0fff CW |
54 | ], |
55 | ], | |
56 | ]; | |
4f53d6f2 | 57 | |
fb32de45 | 58 | return $expectedResult; |
4f53d6f2 | 59 | } |
60 | ||
a828d7b8 | 61 | /* |
50fb255d | 62 | * This example has been generated from the API test suite. |
a828d7b8 CW |
63 | * The test that created it is called "testGetContributionSoft" |
64 | * and can be found at: | |
69d79249 | 65 | * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContributionSoftTest.php |
4f53d6f2 | 66 | * |
67 | * You can see the outcome of the API tests at | |
69d79249 | 68 | * https://test.civicrm.org/job/CiviCRM-master-git/ |
4f53d6f2 | 69 | * |
70 | * To Learn about the API read | |
69d79249 | 71 | * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API |
4f53d6f2 | 72 | * |
69d79249 | 73 | * Browse the api on your own site with the api explorer |
41d4d31f | 74 | * http://MYSITE.ORG/path/to/civicrm/api |
4f53d6f2 | 75 | * |
76 | * Read more about testing here | |
77 | * http://wiki.civicrm.org/confluence/display/CRM/Testing | |
78 | * | |
79 | * API Standards documentation: | |
80 | * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards | |
b259a4ab | 81 | */ |