3cb02ca81398b28ecf634bf5fbcb28b80989145f
3 * Test Generated example demonstrating the Setting.getdefaults API.
5 * Gets defaults setting a variable for a given domain - if no domain is set current is assumed.
10 function setting_getdefaults_example() {
12 'name' => 'address_format',
16 $result = civicrm_api3('Setting', 'getdefaults', $params);
18 catch (CiviCRM_API3_Exception
$e) {
20 $errorMessage = $e->getMessage();
21 $errorCode = $e->getErrorCode();
22 $errorData = $e->getExtraParams();
24 'error' => $errorMessage,
25 'error_code' => $errorCode,
26 'error_data' => $errorData,
34 * Function returns array of result expected from previous function.
39 function setting_getdefaults_expectedresult() {
41 $expectedResult = array(
48 'address_format' => '{contact.address_name}
49 {contact.street_address}
50 {contact.supplemental_address_1}
51 {contact.supplemental_address_2}
52 {contact.city}{, }{contact.state_province}{ }{contact.postal_code}
58 return $expectedResult;
62 * This example has been generated from the API test suite.
63 * The test that created it is called "testGetDefaults"
64 * and can be found at:
65 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/SettingTest.php
67 * You can see the outcome of the API tests at
68 * https://test.civicrm.org/job/CiviCRM-master-git/
70 * To Learn about the API read
71 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
73 * Browse the api on your own site with the api explorer
74 * http://MYSITE.ORG/path/to/civicrm/api
76 * Read more about testing here
77 * http://wiki.civicrm.org/confluence/display/CRM/Testing
79 * API Standards documentation:
80 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards