3 * Test Generated example of using setting getdefaults API
4 * gets defaults setting a variable for a given domain - if no domain is set current is assumed *
6 function setting_getdefaults_example(){
8 'name' => 'address_format',
12 $result = civicrm_api3('setting', 'getdefaults', $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_getdefaults_expectedresult(){
30 $expectedResult = array(
37 'address_format' => '{contact.address_name}
38 {contact.street_address}
39 {contact.supplemental_address_1}
40 {contact.supplemental_address_2}
41 {contact.city}{, }{contact.state_province}{ }{contact.postal_code}
47 return $expectedResult;
52 * This example has been generated from the API test suite. The test that created it is called
54 * testGetDefaults and can be found in
55 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/SettingTest.php
57 * You can see the outcome of the API tests at
58 * https://test.civicrm.org/job/CiviCRM-master-git/
60 * To Learn about the API read
61 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
63 * Browse the api on your own site with the api explorer
64 * http://MYSITE.ORG/path/to/civicrm/api/explorer
66 * Read more about testing here
67 * http://wiki.civicrm.org/confluence/display/CRM/Testing
69 * API Standards documentation:
70 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards