Commit | Line | Data |
---|---|---|
8390b11b SL |
1 | <?php |
2 | /** | |
3 | * Test Generated example demonstrating the Contact.getmergedfrom API. | |
4 | * | |
5 | * @return array | |
6 | * API result array | |
7 | */ | |
8 | function contact_getmergedfrom_example() { | |
9 | $params = [ | |
10 | 'contact_id' => 4, | |
11 | ]; | |
12 | ||
13 | try{ | |
14 | $result = civicrm_api3('Contact', 'getmergedfrom', $params); | |
15 | } | |
16 | catch (CiviCRM_API3_Exception $e) { | |
17 | // Handle error here. | |
18 | $errorMessage = $e->getMessage(); | |
19 | $errorCode = $e->getErrorCode(); | |
20 | $errorData = $e->getExtraParams(); | |
21 | return [ | |
22 | 'is_error' => 1, | |
23 | 'error_message' => $errorMessage, | |
24 | 'error_code' => $errorCode, | |
25 | 'error_data' => $errorData, | |
26 | ]; | |
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 contact_getmergedfrom_expectedresult() { | |
39 | ||
40 | $expectedResult = [ | |
41 | 'is_error' => 0, | |
42 | 'version' => 3, | |
43 | 'count' => 3, | |
44 | 'values' => [ | |
45 | '3' => [ | |
46 | 'id' => '3', | |
47 | ], | |
48 | '5' => [ | |
49 | 'id' => '5', | |
50 | ], | |
51 | '6' => [ | |
52 | 'id' => '6', | |
53 | ], | |
54 | ], | |
55 | ]; | |
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 "testMergedGet" | |
63 | * and can be found at: | |
64 | * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContactTest.php | |
65 | * | |
66 | * You can see the outcome of the API tests at | |
67 | * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ | |
68 | * | |
69 | * To Learn about the API read | |
70 | * https://docs.civicrm.org/dev/en/latest/api/ | |
71 | * | |
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. | |
74 | * | |
75 | * Read more about testing here | |
76 | * https://docs.civicrm.org/dev/en/latest/testing/ | |
77 | * | |
78 | * API Standards documentation: | |
79 | * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ | |
80 | */ |