Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
50fb255d | 2 | /** |
a828d7b8 | 3 | * Test Generated example demonstrating the Pledge.delete API. |
50fb255d | 4 | * |
50fb255d | 5 | * @return array |
6 | * API result array | |
7 | */ | |
8 | function pledge_delete_example() { | |
cf8f0fff | 9 | $params = [ |
50fb255d | 10 | 'id' => 1, |
cf8f0fff | 11 | ]; |
6a488035 | 12 | |
50fb255d | 13 | try{ |
a828d7b8 | 14 | $result = civicrm_api3('Pledge', 'delete', $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 [ |
1d8ee3d6 | 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; | |
6a488035 TO |
30 | } |
31 | ||
fb32de45 | 32 | /** |
50fb255d | 33 | * Function returns array of result expected from previous function. |
34 | * | |
35 | * @return array | |
36 | * API result array | |
6a488035 | 37 | */ |
50fb255d | 38 | function pledge_delete_expectedresult() { |
6a488035 | 39 | |
cf8f0fff | 40 | $expectedResult = [ |
50fb255d | 41 | 'is_error' => 0, |
42 | 'version' => 3, | |
43 | 'count' => 1, | |
44 | 'id' => 'id', | |
cf8f0fff | 45 | 'values' => [ |
6a488035 | 46 | 'id' => 1, |
cf8f0fff CW |
47 | ], |
48 | ]; | |
6a488035 | 49 | |
fb32de45 | 50 | return $expectedResult; |
6a488035 TO |
51 | } |
52 | ||
a828d7b8 | 53 | /* |
50fb255d | 54 | * This example has been generated from the API test suite. |
a828d7b8 CW |
55 | * The test that created it is called "testDeletePledgeUseID" |
56 | * and can be found at: | |
69d79249 | 57 | * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/PledgeTest.php |
6a488035 TO |
58 | * |
59 | * You can see the outcome of the API tests at | |
8390b11b | 60 | * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ |
6a488035 TO |
61 | * |
62 | * To Learn about the API read | |
8390b11b | 63 | * https://docs.civicrm.org/dev/en/latest/api/ |
6a488035 | 64 | * |
8390b11b SL |
65 | * Browse the API on your own site with the API Explorer. It is in the main |
66 | * CiviCRM menu, under: Support > Development > API Explorer. | |
6a488035 TO |
67 | * |
68 | * Read more about testing here | |
8390b11b | 69 | * https://docs.civicrm.org/dev/en/latest/testing/ |
6a488035 TO |
70 | * |
71 | * API Standards documentation: | |
8390b11b | 72 | * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ |
b259a4ab | 73 | */ |