Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
50fb255d | 2 | /** |
a828d7b8 | 3 | * Test Generated example demonstrating the Contact.getvalue API. |
50fb255d | 4 | * |
fb32de45 | 5 | * This demonstrates use of the 'format.single_value' param. |
5c49fee0 CW |
6 | * This param causes only a single value of the only entity to be returned as an string. |
7 | * It will be ignored if there is not exactly 1 result | |
50fb255d | 8 | * |
9 | * @return array | |
10 | * API result array | |
6a488035 | 11 | */ |
50fb255d | 12 | function contact_getvalue_example() { |
cf8f0fff | 13 | $params = [ |
8390b11b | 14 | 'id' => 3, |
50fb255d | 15 | 'return' => 'display_name', |
cf8f0fff | 16 | ]; |
6a488035 | 17 | |
50fb255d | 18 | try{ |
a828d7b8 | 19 | $result = civicrm_api3('Contact', 'getvalue', $params); |
50fb255d | 20 | } |
21 | catch (CiviCRM_API3_Exception $e) { | |
22 | // Handle error here. | |
23 | $errorMessage = $e->getMessage(); | |
24 | $errorCode = $e->getErrorCode(); | |
25 | $errorData = $e->getExtraParams(); | |
cf8f0fff | 26 | return [ |
5be22f39 | 27 | 'is_error' => 1, |
28 | 'error_message' => $errorMessage, | |
50fb255d | 29 | 'error_code' => $errorCode, |
30 | 'error_data' => $errorData, | |
cf8f0fff | 31 | ]; |
50fb255d | 32 | } |
6a488035 | 33 | |
50fb255d | 34 | return $result; |
6a488035 TO |
35 | } |
36 | ||
fb32de45 | 37 | /** |
50fb255d | 38 | * Function returns array of result expected from previous function. |
39 | * | |
40 | * @return array | |
41 | * API result array | |
6a488035 | 42 | */ |
50fb255d | 43 | function contact_getvalue_expectedresult() { |
6a488035 | 44 | |
8390b11b | 45 | $expectedResult = 'Mr. Test Contact II'; |
6a488035 | 46 | |
fb32de45 | 47 | return $expectedResult; |
6a488035 TO |
48 | } |
49 | ||
a828d7b8 | 50 | /* |
50fb255d | 51 | * This example has been generated from the API test suite. |
a828d7b8 CW |
52 | * The test that created it is called "testContactGetFormatSingleValue" |
53 | * and can be found at: | |
69d79249 | 54 | * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContactTest.php |
6a488035 TO |
55 | * |
56 | * You can see the outcome of the API tests at | |
8390b11b | 57 | * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ |
6a488035 TO |
58 | * |
59 | * To Learn about the API read | |
8390b11b | 60 | * https://docs.civicrm.org/dev/en/latest/api/ |
6a488035 | 61 | * |
8390b11b SL |
62 | * Browse the API on your own site with the API Explorer. It is in the main |
63 | * CiviCRM menu, under: Support > Development > API Explorer. | |
6a488035 TO |
64 | * |
65 | * Read more about testing here | |
8390b11b | 66 | * https://docs.civicrm.org/dev/en/latest/testing/ |
6a488035 TO |
67 | * |
68 | * API Standards documentation: | |
8390b11b | 69 | * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ |
b259a4ab | 70 | */ |