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