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