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