Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
fb32de45 | 2 | /** |
50fb255d | 3 | * @file |
4 | * Test Generated API Example. | |
5 | * See bottom of this file for more detail. | |
6a488035 | 6 | */ |
6a488035 | 7 | |
50fb255d | 8 | /** |
9 | * Test Generated example of using contact get API. | |
10 | * | |
11 | * /*this demonstrates setting a custom field through the API | |
12 | * | |
13 | * @return array | |
14 | * API result array | |
15 | */ | |
16 | function contact_get_example() { | |
17 | $params = array( | |
18 | 'return.custom_1' => 1, | |
19 | 'id' => 1, | |
20 | ); | |
6a488035 | 21 | |
50fb255d | 22 | try{ |
23 | $result = civicrm_api3('contact', 'get', $params); | |
24 | } | |
25 | catch (CiviCRM_API3_Exception $e) { | |
26 | // Handle error here. | |
27 | $errorMessage = $e->getMessage(); | |
28 | $errorCode = $e->getErrorCode(); | |
29 | $errorData = $e->getExtraParams(); | |
30 | return array( | |
31 | 'error' => $errorMessage, | |
32 | 'error_code' => $errorCode, | |
33 | 'error_data' => $errorData, | |
34 | ); | |
35 | } | |
36 | ||
37 | return $result; | |
6a488035 TO |
38 | } |
39 | ||
fb32de45 | 40 | /** |
50fb255d | 41 | * Function returns array of result expected from previous function. |
42 | * | |
43 | * @return array | |
44 | * API result array | |
6a488035 | 45 | */ |
50fb255d | 46 | function contact_get_expectedresult() { |
6a488035 | 47 | |
edb0d67a | 48 | $expectedResult = array( |
50fb255d | 49 | 'is_error' => 0, |
50 | 'version' => 3, | |
51 | 'count' => 1, | |
52 | 'id' => 1, | |
53 | 'values' => array( | |
edb0d67a | 54 | '1' => array( |
50fb255d | 55 | 'contact_id' => '1', |
56 | 'civicrm_value_testgetwithcu_1_id' => '1', | |
57 | 'custom_1' => 'custom string', | |
58 | 'id' => '1', | |
59 | ), | |
6a488035 | 60 | ), |
50fb255d | 61 | ); |
6a488035 | 62 | |
fb32de45 | 63 | return $expectedResult; |
6a488035 TO |
64 | } |
65 | ||
50fb255d | 66 | /** |
67 | * This example has been generated from the API test suite. | |
68 | * The test that created it is called | |
69 | * testGetWithCustom | |
70 | * and can be found in | |
69d79249 | 71 | * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContactTest.php |
6a488035 TO |
72 | * |
73 | * You can see the outcome of the API tests at | |
69d79249 | 74 | * https://test.civicrm.org/job/CiviCRM-master-git/ |
6a488035 TO |
75 | * |
76 | * To Learn about the API read | |
69d79249 | 77 | * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API |
6a488035 | 78 | * |
69d79249 E |
79 | * Browse the api on your own site with the api explorer |
80 | * http://MYSITE.ORG/path/to/civicrm/api/explorer | |
6a488035 TO |
81 | * |
82 | * Read more about testing here | |
83 | * http://wiki.civicrm.org/confluence/display/CRM/Testing | |
84 | * | |
85 | * API Standards documentation: | |
86 | * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards | |
b259a4ab | 87 | */ |