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