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