Commit | Line | Data |
---|---|---|
5be22f39 | 1 | <?php |
2 | /** | |
3 | * Test Generated example demonstrating the Mapping.delete API. | |
4 | * | |
5 | * @return array | |
6 | * API result array | |
7 | */ | |
8 | function mapping_delete_example() { | |
cf8f0fff | 9 | $params = [ |
5be22f39 | 10 | 'id' => 3, |
cf8f0fff | 11 | ]; |
5be22f39 | 12 | |
13 | try{ | |
14 | $result = civicrm_api3('Mapping', 'delete', $params); | |
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, | |
24 | 'error_code' => $errorCode, | |
25 | 'error_data' => $errorData, | |
cf8f0fff | 26 | ]; |
5be22f39 | 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 mapping_delete_expectedresult() { | |
39 | ||
cf8f0fff | 40 | $expectedResult = [ |
5be22f39 | 41 | 'is_error' => 0, |
42 | 'version' => 3, | |
43 | 'count' => 1, | |
44 | 'values' => 1, | |
cf8f0fff | 45 | ]; |
5be22f39 | 46 | |
47 | return $expectedResult; | |
48 | } | |
49 | ||
50 | /* | |
51 | * This example has been generated from the API test suite. | |
52 | * The test that created it is called "testDeleteMapping" | |
53 | * and can be found at: | |
54 | * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MappingTest.php | |
55 | * | |
56 | * You can see the outcome of the API tests at | |
8390b11b | 57 | * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ |
5be22f39 | 58 | * |
59 | * To Learn about the API read | |
8390b11b | 60 | * https://docs.civicrm.org/dev/en/latest/api/ |
5be22f39 | 61 | * |
8390b11b SL |
62 | * Browse the API on your own site with the API Explorer. It is in the main |
63 | * CiviCRM menu, under: Support > Development > API Explorer. | |
5be22f39 | 64 | * |
65 | * Read more about testing here | |
8390b11b | 66 | * https://docs.civicrm.org/dev/en/latest/testing/ |
5be22f39 | 67 | * |
68 | * API Standards documentation: | |
8390b11b | 69 | * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ |
5be22f39 | 70 | */ |