Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
fb32de45 | 2 | /** |
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 * | |
6a488035 TO |
5 | */ |
6 | function setting_getdefaults_example(){ | |
53ca8fd7 | 7 | $params = array( |
6a488035 TO |
8 | 'name' => 'address_format', |
9 | ); | |
10 | ||
fb32de45 | 11 | try{ |
12 | $result = civicrm_api3('setting', 'getdefaults', $params); | |
13 | } | |
14 | catch (CiviCRM_API3_Exception $e) { | |
15 | // handle error here | |
16 | $errorMessage = $e->getMessage(); | |
17 | $errorCode = $e->getErrorCode(); | |
18 | $errorData = $e->getExtraParams(); | |
19 | return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData); | |
20 | } | |
6a488035 | 21 | |
fb32de45 | 22 | return $result; |
6a488035 TO |
23 | } |
24 | ||
fb32de45 | 25 | /** |
6a488035 TO |
26 | * Function returns array of result expected from previous function |
27 | */ | |
28 | function setting_getdefaults_expectedresult(){ | |
29 | ||
53ca8fd7 | 30 | $expectedResult = array( |
6a488035 TO |
31 | 'is_error' => 0, |
32 | 'version' => 3, | |
33 | 'count' => 1, | |
34 | 'id' => 1, | |
53ca8fd7 | 35 | 'values' => array( |
36 | '1' => array( | |
6a488035 TO |
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} | |
42 | {contact.country}', | |
43 | ), | |
44 | ), | |
45 | ); | |
46 | ||
fb32de45 | 47 | return $expectedResult; |
6a488035 TO |
48 | } |
49 | ||
50 | ||
51 | /* | |
52 | * This example has been generated from the API test suite. The test that created it is called | |
53 | * | |
54 | * testGetDefaults and can be found in | |
69d79249 | 55 | * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/SettingTest.php |
6a488035 TO |
56 | * |
57 | * You can see the outcome of the API tests at | |
69d79249 | 58 | * https://test.civicrm.org/job/CiviCRM-master-git/ |
6a488035 TO |
59 | * |
60 | * To Learn about the API read | |
69d79249 | 61 | * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API |
6a488035 | 62 | * |
69d79249 E |
63 | * Browse the api on your own site with the api explorer |
64 | * http://MYSITE.ORG/path/to/civicrm/api/explorer | |
6a488035 TO |
65 | * |
66 | * Read more about testing here | |
67 | * http://wiki.civicrm.org/confluence/display/CRM/Testing | |
68 | * | |
69 | * API Standards documentation: | |
70 | * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards | |
4ed37178 | 71 | */ |