Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
50fb255d | 2 | /** |
a828d7b8 | 3 | * Test Generated example demonstrating the Contact.getoptions API. |
50fb255d | 4 | * |
5c49fee0 | 5 | * Demonstrates retrieving options for a custom field. |
50fb255d | 6 | * |
7 | * @return array | |
8 | * API result array | |
9 | */ | |
10 | function contact_getoptions_example() { | |
cf8f0fff | 11 | $params = [ |
50fb255d | 12 | 'field' => 'custom_1', |
cf8f0fff | 13 | ]; |
6a488035 | 14 | |
50fb255d | 15 | try{ |
a828d7b8 | 16 | $result = civicrm_api3('Contact', 'getoptions', $params); |
50fb255d | 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, | |
50fb255d | 26 | 'error_code' => $errorCode, |
27 | 'error_data' => $errorData, | |
cf8f0fff | 28 | ]; |
50fb255d | 29 | } |
30 | ||
31 | return $result; | |
6a488035 TO |
32 | } |
33 | ||
fb32de45 | 34 | /** |
50fb255d | 35 | * Function returns array of result expected from previous function. |
36 | * | |
37 | * @return array | |
38 | * API result array | |
6a488035 | 39 | */ |
50fb255d | 40 | function contact_getoptions_expectedresult() { |
6a488035 | 41 | |
cf8f0fff | 42 | $expectedResult = [ |
50fb255d | 43 | 'is_error' => 0, |
44 | 'version' => 3, | |
45 | 'count' => 2, | |
cf8f0fff | 46 | 'values' => [ |
6a488035 TO |
47 | '1' => 'Label1', |
48 | '2' => 'Label2', | |
cf8f0fff CW |
49 | ], |
50 | ]; | |
6a488035 | 51 | |
fb32de45 | 52 | return $expectedResult; |
6a488035 TO |
53 | } |
54 | ||
a828d7b8 | 55 | /* |
50fb255d | 56 | * This example has been generated from the API test suite. |
a828d7b8 CW |
57 | * The test that created it is called "testCustomFieldCreateWithOptionValues" |
58 | * and can be found at: | |
69d79249 | 59 | * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContactTest.php |
6a488035 TO |
60 | * |
61 | * You can see the outcome of the API tests at | |
8390b11b | 62 | * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ |
6a488035 TO |
63 | * |
64 | * To Learn about the API read | |
8390b11b | 65 | * https://docs.civicrm.org/dev/en/latest/api/ |
6a488035 | 66 | * |
8390b11b SL |
67 | * Browse the API on your own site with the API Explorer. It is in the main |
68 | * CiviCRM menu, under: Support > Development > API Explorer. | |
6a488035 TO |
69 | * |
70 | * Read more about testing here | |
8390b11b | 71 | * https://docs.civicrm.org/dev/en/latest/testing/ |
6a488035 TO |
72 | * |
73 | * API Standards documentation: | |
8390b11b | 74 | * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ |
b259a4ab | 75 | */ |