Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
50fb255d | 2 | /** |
a828d7b8 | 3 | * Test Generated example demonstrating the Setting.create API. |
50fb255d | 4 | * |
50fb255d | 5 | * @return array |
6 | * API result array | |
7 | */ | |
8 | function setting_create_example() { | |
cf8f0fff | 9 | $params = [ |
50fb255d | 10 | 'domain_id' => 2, |
11 | 'uniq_email_per_site' => 1, | |
cf8f0fff | 12 | ]; |
6a488035 | 13 | |
50fb255d | 14 | try{ |
a828d7b8 | 15 | $result = civicrm_api3('Setting', 'create', $params); |
50fb255d | 16 | } |
17 | catch (CiviCRM_API3_Exception $e) { | |
18 | // Handle error here. | |
19 | $errorMessage = $e->getMessage(); | |
20 | $errorCode = $e->getErrorCode(); | |
21 | $errorData = $e->getExtraParams(); | |
cf8f0fff | 22 | return [ |
1d8ee3d6 | 23 | 'is_error' => 1, |
24 | 'error_message' => $errorMessage, | |
50fb255d | 25 | 'error_code' => $errorCode, |
26 | 'error_data' => $errorData, | |
cf8f0fff | 27 | ]; |
50fb255d | 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_create_expectedresult() { |
6a488035 | 40 | |
cf8f0fff | 41 | $expectedResult = [ |
50fb255d | 42 | 'is_error' => 0, |
43 | 'version' => 3, | |
44 | 'count' => 1, | |
45 | 'id' => 2, | |
cf8f0fff CW |
46 | 'values' => [ |
47 | '2' => [ | |
50fb255d | 48 | 'uniq_email_per_site' => '1', |
cf8f0fff CW |
49 | ], |
50 | ], | |
51 | ]; | |
6a488035 | 52 | |
fb32de45 | 53 | return $expectedResult; |
6a488035 TO |
54 | } |
55 | ||
a828d7b8 | 56 | /* |
50fb255d | 57 | * This example has been generated from the API test suite. |
a828d7b8 CW |
58 | * The test that created it is called "testCreateSetting" |
59 | * and can be found at: | |
69d79249 | 60 | * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/SettingTest.php |
6a488035 TO |
61 | * |
62 | * You can see the outcome of the API tests at | |
8390b11b | 63 | * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ |
6a488035 TO |
64 | * |
65 | * To Learn about the API read | |
8390b11b | 66 | * https://docs.civicrm.org/dev/en/latest/api/ |
6a488035 | 67 | * |
8390b11b SL |
68 | * Browse the API on your own site with the API Explorer. It is in the main |
69 | * CiviCRM menu, under: Support > Development > API Explorer. | |
6a488035 TO |
70 | * |
71 | * Read more about testing here | |
8390b11b | 72 | * https://docs.civicrm.org/dev/en/latest/testing/ |
6a488035 TO |
73 | * |
74 | * API Standards documentation: | |
8390b11b | 75 | * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ |
4ed37178 | 76 | */ |