Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
50fb255d | 2 | /** |
a828d7b8 | 3 | * Test Generated example demonstrating the Membership.delete API. |
50fb255d | 4 | * |
50fb255d | 5 | * @return array |
6 | * API result array | |
7 | */ | |
8 | function membership_delete_example() { | |
cf8f0fff | 9 | $params = [ |
50fb255d | 10 | 'id' => 1, |
5be22f39 | 11 | 'preserve_contribution' => 1, |
cf8f0fff | 12 | ]; |
6a488035 | 13 | |
50fb255d | 14 | try{ |
a828d7b8 | 15 | $result = civicrm_api3('Membership', 'delete', $params); |
50fb255d | 16 | } |
17 | catch (CiviCRM_API3_Exception $e) { | |
18 | // Handle error here. | |
19 | $errorMessage = $e->getMessage(); | |
20 | $errorCode = $e->getErrorCode(); | |
21 | $errorData = $e->getExtraParams(); | |
cf8f0fff | 22 | return [ |
5be22f39 | 23 | 'is_error' => 1, |
24 | 'error_message' => $errorMessage, | |
50fb255d | 25 | 'error_code' => $errorCode, |
26 | 'error_data' => $errorData, | |
cf8f0fff | 27 | ]; |
50fb255d | 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 membership_delete_expectedresult() { |
6a488035 | 40 | |
cf8f0fff | 41 | $expectedResult = [ |
50fb255d | 42 | 'is_error' => 0, |
43 | 'version' => 3, | |
44 | 'count' => 1, | |
45 | 'values' => TRUE, | |
cf8f0fff | 46 | ]; |
6a488035 | 47 | |
fb32de45 | 48 | return $expectedResult; |
6a488035 TO |
49 | } |
50 | ||
a828d7b8 | 51 | /* |
50fb255d | 52 | * This example has been generated from the API test suite. |
5be22f39 | 53 | * The test that created it is called "testMembershipDeletePreserveContribution" |
a828d7b8 | 54 | * and can be found at: |
69d79249 | 55 | * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MembershipTest.php |
6a488035 TO |
56 | * |
57 | * You can see the outcome of the API tests at | |
69d79249 | 58 | * https://test.civicrm.org/job/CiviCRM-master-git/ |
6a488035 TO |
59 | * |
60 | * To Learn about the API read | |
69d79249 | 61 | * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API |
6a488035 | 62 | * |
69d79249 | 63 | * Browse the api on your own site with the api explorer |
41d4d31f | 64 | * http://MYSITE.ORG/path/to/civicrm/api |
6a488035 TO |
65 | * |
66 | * Read more about testing here | |
67 | * http://wiki.civicrm.org/confluence/display/CRM/Testing | |
68 | * | |
69 | * API Standards documentation: | |
70 | * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards | |
b259a4ab | 71 | */ |