Commit | Line | Data |
---|---|---|
5be22f39 | 1 | <?php |
2 | /** | |
3 | * Test Generated example demonstrating the Mapping.get API. | |
4 | * | |
5 | * @return array | |
6 | * API result array | |
7 | */ | |
8 | function mapping_get_example() { | |
cf8f0fff | 9 | $params = [ |
5be22f39 | 10 | 'name' => 'Mapping name', |
11 | 'description' => 'Mapping description', | |
12 | 'mapping_type_id' => 7, | |
cf8f0fff | 13 | ]; |
5be22f39 | 14 | |
15 | try{ | |
16 | $result = civicrm_api3('Mapping', 'get', $params); | |
17 | } | |
18 | catch (CiviCRM_API3_Exception $e) { | |
19 | // Handle error here. | |
20 | $errorMessage = $e->getMessage(); | |
21 | $errorCode = $e->getErrorCode(); | |
22 | $errorData = $e->getExtraParams(); | |
cf8f0fff | 23 | return [ |
5be22f39 | 24 | 'is_error' => 1, |
25 | 'error_message' => $errorMessage, | |
26 | 'error_code' => $errorCode, | |
27 | 'error_data' => $errorData, | |
cf8f0fff | 28 | ]; |
5be22f39 | 29 | } |
30 | ||
31 | return $result; | |
32 | } | |
33 | ||
34 | /** | |
35 | * Function returns array of result expected from previous function. | |
36 | * | |
37 | * @return array | |
38 | * API result array | |
39 | */ | |
40 | function mapping_get_expectedresult() { | |
41 | ||
cf8f0fff | 42 | $expectedResult = [ |
5be22f39 | 43 | 'is_error' => 0, |
44 | 'version' => 3, | |
45 | 'count' => 1, | |
46 | 'id' => 2, | |
cf8f0fff CW |
47 | 'values' => [ |
48 | '2' => [ | |
5be22f39 | 49 | 'id' => '2', |
50 | 'name' => 'Mapping name', | |
51 | 'description' => 'Mapping description', | |
52 | 'mapping_type_id' => '7', | |
cf8f0fff CW |
53 | ], |
54 | ], | |
55 | ]; | |
5be22f39 | 56 | |
57 | return $expectedResult; | |
58 | } | |
59 | ||
60 | /* | |
61 | * This example has been generated from the API test suite. | |
62 | * The test that created it is called "testGetMapping" | |
63 | * and can be found at: | |
64 | * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MappingTest.php | |
65 | * | |
66 | * You can see the outcome of the API tests at | |
8390b11b | 67 | * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ |
5be22f39 | 68 | * |
69 | * To Learn about the API read | |
8390b11b | 70 | * https://docs.civicrm.org/dev/en/latest/api/ |
5be22f39 | 71 | * |
8390b11b SL |
72 | * Browse the API on your own site with the API Explorer. It is in the main |
73 | * CiviCRM menu, under: Support > Development > API Explorer. | |
5be22f39 | 74 | * |
75 | * Read more about testing here | |
8390b11b | 76 | * https://docs.civicrm.org/dev/en/latest/testing/ |
5be22f39 | 77 | * |
78 | * API Standards documentation: | |
8390b11b | 79 | * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ |
5be22f39 | 80 | */ |