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