3 * Test Generated example demonstrating the Setting.revert API.
5 * Demonstrates reverting a parameter to default value.
10 function setting_revert_example() {
12 'name' => 'address_format',
16 $result = civicrm_api3('Setting', 'revert', $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_revert_expectedresult() {
41 $expectedResult = array(
53 'address_format' => '{contact.address_name}
54 {contact.street_address}
55 {contact.supplemental_address_1}
56 {contact.supplemental_address_2}
57 {contact.city}{, }{contact.state_province}{ }{contact.postal_code}
64 return $expectedResult;
68 * This example has been generated from the API test suite.
69 * The test that created it is called "testRevert"
70 * and can be found at:
71 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/SettingTest.php
73 * You can see the outcome of the API tests at
74 * https://test.civicrm.org/job/CiviCRM-master-git/
76 * To Learn about the API read
77 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
79 * Browse the api on your own site with the api explorer
80 * http://MYSITE.ORG/path/to/civicrm/api
82 * Read more about testing here
83 * http://wiki.civicrm.org/confluence/display/CRM/Testing
85 * API Standards documentation:
86 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards