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