Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
fb32de45 | 2 | /** |
3 | * Test Generated example of using contact getoptions API | |
4 | * Demonstrates retrieving options for a custom field * | |
6a488035 TO |
5 | */ |
6 | function contact_getoptions_example(){ | |
7a7cc10b | 7 | $params = array( |
6a488035 | 8 | 'field' => 'custom_1', |
6a488035 TO |
9 | ); |
10 | ||
fb32de45 | 11 | try{ |
12 | $result = civicrm_api3('contact', 'getoptions', $params); | |
13 | } | |
14 | catch (CiviCRM_API3_Exception $e) { | |
15 | // handle error here | |
16 | $errorMessage = $e->getMessage(); | |
17 | $errorCode = $e->getErrorCode(); | |
18 | $errorData = $e->getExtraParams(); | |
19 | return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData); | |
20 | } | |
6a488035 | 21 | |
fb32de45 | 22 | return $result; |
6a488035 TO |
23 | } |
24 | ||
fb32de45 | 25 | /** |
6a488035 TO |
26 | * Function returns array of result expected from previous function |
27 | */ | |
28 | function contact_getoptions_expectedresult(){ | |
29 | ||
7a7cc10b | 30 | $expectedResult = array( |
6a488035 TO |
31 | 'is_error' => 0, |
32 | 'version' => 3, | |
53ca8fd7 | 33 | 'count' => 2, |
7a7cc10b | 34 | 'values' => array( |
6a488035 TO |
35 | '1' => 'Label1', |
36 | '2' => 'Label2', | |
37 | ), | |
38 | ); | |
39 | ||
fb32de45 | 40 | return $expectedResult; |
6a488035 TO |
41 | } |
42 | ||
43 | ||
44 | /* | |
45 | * This example has been generated from the API test suite. The test that created it is called | |
46 | * | |
47 | * testCustomFieldCreateWithOptionValues and can be found in | |
69d79249 | 48 | * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContactTest.php |
6a488035 TO |
49 | * |
50 | * You can see the outcome of the API tests at | |
69d79249 | 51 | * https://test.civicrm.org/job/CiviCRM-master-git/ |
6a488035 TO |
52 | * |
53 | * To Learn about the API read | |
69d79249 | 54 | * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API |
6a488035 | 55 | * |
69d79249 E |
56 | * Browse the api on your own site with the api explorer |
57 | * http://MYSITE.ORG/path/to/civicrm/api/explorer | |
6a488035 TO |
58 | * |
59 | * Read more about testing here | |
60 | * http://wiki.civicrm.org/confluence/display/CRM/Testing | |
61 | * | |
62 | * API Standards documentation: | |
63 | * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards | |
b259a4ab | 64 | */ |