Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
50fb255d | 2 | /** |
a828d7b8 | 3 | * Test Generated example demonstrating the Tag.get API. |
50fb255d | 4 | * |
5c49fee0 | 5 | * Demonstrates use of Return as an array. |
50fb255d | 6 | * |
7 | * @return array | |
8 | * API result array | |
9 | */ | |
10 | function tag_get_example() { | |
cf8f0fff | 11 | $params = [ |
8390b11b | 12 | 'id' => '10', |
50fb255d | 13 | 'name' => 'New Tag3', |
cf8f0fff | 14 | 'return' => [ |
6a488035 | 15 | '0' => 'name', |
cf8f0fff CW |
16 | ], |
17 | ]; | |
6a488035 | 18 | |
50fb255d | 19 | try{ |
a828d7b8 | 20 | $result = civicrm_api3('Tag', 'get', $params); |
50fb255d | 21 | } |
22 | catch (CiviCRM_API3_Exception $e) { | |
23 | // Handle error here. | |
24 | $errorMessage = $e->getMessage(); | |
25 | $errorCode = $e->getErrorCode(); | |
26 | $errorData = $e->getExtraParams(); | |
cf8f0fff | 27 | return [ |
1d8ee3d6 | 28 | 'is_error' => 1, |
29 | 'error_message' => $errorMessage, | |
50fb255d | 30 | 'error_code' => $errorCode, |
31 | 'error_data' => $errorData, | |
cf8f0fff | 32 | ]; |
50fb255d | 33 | } |
6a488035 | 34 | |
50fb255d | 35 | return $result; |
6a488035 TO |
36 | } |
37 | ||
fb32de45 | 38 | /** |
50fb255d | 39 | * Function returns array of result expected from previous function. |
40 | * | |
41 | * @return array | |
42 | * API result array | |
6a488035 | 43 | */ |
50fb255d | 44 | function tag_get_expectedresult() { |
6a488035 | 45 | |
cf8f0fff | 46 | $expectedResult = [ |
50fb255d | 47 | 'is_error' => 0, |
48 | 'version' => 3, | |
49 | 'count' => 1, | |
8390b11b | 50 | 'id' => 10, |
cf8f0fff | 51 | 'values' => [ |
8390b11b SL |
52 | '10' => [ |
53 | 'id' => '10', | |
50fb255d | 54 | 'name' => 'New Tag3', |
cf8f0fff CW |
55 | ], |
56 | ], | |
57 | ]; | |
6a488035 | 58 | |
fb32de45 | 59 | return $expectedResult; |
6a488035 TO |
60 | } |
61 | ||
a828d7b8 | 62 | /* |
50fb255d | 63 | * This example has been generated from the API test suite. |
a828d7b8 CW |
64 | * The test that created it is called "testGetReturnArray" |
65 | * and can be found at: | |
69d79249 | 66 | * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/TagTest.php |
6a488035 TO |
67 | * |
68 | * You can see the outcome of the API tests at | |
8390b11b | 69 | * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ |
6a488035 TO |
70 | * |
71 | * To Learn about the API read | |
8390b11b | 72 | * https://docs.civicrm.org/dev/en/latest/api/ |
6a488035 | 73 | * |
8390b11b SL |
74 | * Browse the API on your own site with the API Explorer. It is in the main |
75 | * CiviCRM menu, under: Support > Development > API Explorer. | |
6a488035 TO |
76 | * |
77 | * Read more about testing here | |
8390b11b | 78 | * https://docs.civicrm.org/dev/en/latest/testing/ |
6a488035 TO |
79 | * |
80 | * API Standards documentation: | |
8390b11b | 81 | * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ |
b259a4ab | 82 | */ |