Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | ||
3 | /* | |
4 | Demonstrates reverting a parameter to default value | |
5 | */ | |
6 | function setting_revert_example(){ | |
7 | $params = array( | |
8 | 'version' => 3, | |
9 | 'name' => 'address_format', | |
10 | ); | |
11 | ||
12 | $result = civicrm_api( 'setting','revert',$params ); | |
13 | ||
14 | return $result; | |
15 | } | |
16 | ||
17 | /* | |
18 | * Function returns array of result expected from previous function | |
19 | */ | |
20 | function setting_revert_expectedresult(){ | |
21 | ||
22 | $expectedResult = array( | |
23 | 'is_error' => 0, | |
24 | 'version' => 3, | |
25 | 'count' => 5, | |
26 | 'id' => 1, | |
27 | 'values' => array( | |
28 | 'is_error' => 0, | |
29 | 'version' => 3, | |
30 | 'count' => 1, | |
31 | 'id' => 1, | |
32 | 'values' => array( | |
33 | '1' => array( | |
34 | 'address_format' => '{contact.address_name} | |
35 | {contact.street_address} | |
36 | {contact.supplemental_address_1} | |
37 | {contact.supplemental_address_2} | |
38 | {contact.city}{, }{contact.state_province}{ }{contact.postal_code} | |
39 | {contact.country}', | |
40 | ), | |
41 | ), | |
42 | ), | |
43 | ); | |
44 | ||
45 | return $expectedResult ; | |
46 | } | |
47 | ||
48 | ||
49 | /* | |
50 | * This example has been generated from the API test suite. The test that created it is called | |
51 | * | |
52 | * testRevert and can be found in | |
53 | * http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/SettingTest.php | |
54 | * | |
55 | * You can see the outcome of the API tests at | |
56 | * http://tests.dev.civicrm.org/trunk/results-api_v3 | |
57 | * | |
58 | * To Learn about the API read | |
59 | * http://book.civicrm.org/developer/current/techniques/api/ | |
60 | * | |
61 | * and review the wiki at | |
62 | * http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs | |
63 | * | |
64 | * Read more about testing here | |
65 | * http://wiki.civicrm.org/confluence/display/CRM/Testing | |
66 | * | |
67 | * API Standards documentation: | |
68 | * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards | |
69 | */ |