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