3 * Test Generated example of using setting get API
4 * shows getting a variable for a current domain *
6 function setting_get_example(){
8 'return' => 'uniq_email_per_site',
12 $result = civicrm_api3('setting', 'get', $params);
14 catch (CiviCRM_API3_Exception
$e) {
16 $errorMessage = $e->getMessage();
17 $errorCode = $e->getErrorCode();
18 $errorData = $e->getExtraParams();
19 return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
26 * Function returns array of result expected from previous function
28 function setting_get_expectedresult(){
30 $expectedResult = array(
37 'uniq_email_per_site' => 0,
42 return $expectedResult;
47 * This example has been generated from the API test suite. The test that created it is called
49 * testGetSetting and can be found in
50 * http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/SettingTest.php
52 * You can see the outcome of the API tests at
53 * http://tests.dev.civicrm.org/trunk/results-api_v3
55 * To Learn about the API read
56 * http://book.civicrm.org/developer/current/techniques/api/
58 * and review the wiki at
59 * http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs
61 * Read more about testing here
62 * http://wiki.civicrm.org/confluence/display/CRM/Testing
64 * API Standards documentation:
65 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards