Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
fb32de45 | 2 | /** |
3 | * Test Generated example of using setting create API | |
4 | * shows setting a variable for a current domain * | |
6a488035 TO |
5 | */ |
6 | function setting_create_example(){ | |
53ca8fd7 | 7 | $params = array( |
6a488035 TO |
8 | 'uniq_email_per_site' => 1, |
9 | ); | |
10 | ||
fb32de45 | 11 | try{ |
12 | $result = civicrm_api3('setting', 'create', $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_create_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 | 'uniq_email_per_site' => '1', |
38 | ), | |
39 | ), | |
40 | ); | |
41 | ||
fb32de45 | 42 | return $expectedResult; |
6a488035 TO |
43 | } |
44 | ||
45 | ||
46 | /* | |
47 | * This example has been generated from the API test suite. The test that created it is called | |
48 | * | |
49 | * testCreateSetting and can be found in | |
69d79249 | 50 | * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/SettingTest.php |
6a488035 TO |
51 | * |
52 | * You can see the outcome of the API tests at | |
69d79249 | 53 | * https://test.civicrm.org/job/CiviCRM-master-git/ |
6a488035 TO |
54 | * |
55 | * To Learn about the API read | |
69d79249 | 56 | * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API |
6a488035 | 57 | * |
69d79249 E |
58 | * Browse the api on your own site with the api explorer |
59 | * http://MYSITE.ORG/path/to/civicrm/api/explorer | |
6a488035 TO |
60 | * |
61 | * Read more about testing here | |
62 | * http://wiki.civicrm.org/confluence/display/CRM/Testing | |
63 | * | |
64 | * API Standards documentation: | |
65 | * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards | |
4ed37178 | 66 | */ |