Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
50fb255d | 2 | /** |
3 | * Test Generated example of using setting get API. | |
4 | * | |
5 | * | |
6 | * @return array | |
7 | * API result array | |
8 | */ | |
9 | function setting_get_example() { | |
10 | $params = array( | |
11 | 'domain_id' => 2, | |
12 | 'return' => 'uniq_email_per_site', | |
13 | ); | |
6a488035 | 14 | |
50fb255d | 15 | try{ |
16 | $result = civicrm_api3('setting', 'get', $params); | |
17 | } | |
18 | catch (CiviCRM_API3_Exception $e) { | |
19 | // Handle error here. | |
20 | $errorMessage = $e->getMessage(); | |
21 | $errorCode = $e->getErrorCode(); | |
22 | $errorData = $e->getExtraParams(); | |
23 | return array( | |
24 | 'error' => $errorMessage, | |
25 | 'error_code' => $errorCode, | |
26 | 'error_data' => $errorData, | |
27 | ); | |
28 | } | |
29 | ||
30 | return $result; | |
6a488035 TO |
31 | } |
32 | ||
fb32de45 | 33 | /** |
50fb255d | 34 | * Function returns array of result expected from previous function. |
35 | * | |
36 | * @return array | |
37 | * API result array | |
6a488035 | 38 | */ |
50fb255d | 39 | function setting_get_expectedresult() { |
6a488035 | 40 | |
53ca8fd7 | 41 | $expectedResult = array( |
50fb255d | 42 | 'is_error' => 0, |
43 | 'version' => 3, | |
44 | 'count' => 1, | |
45 | 'id' => 2, | |
46 | 'values' => array( | |
53ca8fd7 | 47 | '2' => array( |
50fb255d | 48 | 'uniq_email_per_site' => '1', |
49 | ), | |
6a488035 | 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 | * testGetSetting | |
60 | * and can be found in | |
69d79249 | 61 | * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/SettingTest.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 | |
4ed37178 | 77 | */ |