Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
50fb255d | 2 | /** |
3 | * Test Generated example of using setting create API. | |
4 | * | |
5 | * shows setting a variable for specified domains | |
6 | * | |
7 | * @return array | |
8 | * API result array | |
9 | */ | |
10 | function setting_create_example() { | |
11 | $params = array( | |
12 | 'domain_id' => array( | |
6a488035 TO |
13 | '0' => 1, |
14 | '1' => 3, | |
15 | ), | |
50fb255d | 16 | 'uniq_email_per_site' => 0, |
17 | ); | |
6a488035 | 18 | |
50fb255d | 19 | try{ |
20 | $result = civicrm_api3('setting', 'create', $params); | |
21 | } | |
22 | catch (CiviCRM_API3_Exception $e) { | |
23 | // Handle error here. | |
24 | $errorMessage = $e->getMessage(); | |
25 | $errorCode = $e->getErrorCode(); | |
26 | $errorData = $e->getExtraParams(); | |
27 | return array( | |
28 | 'error' => $errorMessage, | |
29 | 'error_code' => $errorCode, | |
30 | 'error_data' => $errorData, | |
31 | ); | |
32 | } | |
6a488035 | 33 | |
50fb255d | 34 | return $result; |
6a488035 TO |
35 | } |
36 | ||
fb32de45 | 37 | /** |
50fb255d | 38 | * Function returns array of result expected from previous function. |
39 | * | |
40 | * @return array | |
41 | * API result array | |
6a488035 | 42 | */ |
50fb255d | 43 | function setting_create_expectedresult() { |
6a488035 | 44 | |
53ca8fd7 | 45 | $expectedResult = array( |
50fb255d | 46 | 'is_error' => 0, |
47 | 'version' => 3, | |
48 | 'count' => 2, | |
49 | 'values' => array( | |
53ca8fd7 | 50 | '1' => array( |
50fb255d | 51 | 'uniq_email_per_site' => 0, |
52 | ), | |
53ca8fd7 | 53 | '3' => array( |
50fb255d | 54 | 'uniq_email_per_site' => 0, |
55 | ), | |
6a488035 | 56 | ), |
50fb255d | 57 | ); |
6a488035 | 58 | |
fb32de45 | 59 | return $expectedResult; |
6a488035 TO |
60 | } |
61 | ||
50fb255d | 62 | /** |
63 | * This example has been generated from the API test suite. | |
64 | * The test that created it is called | |
65 | * testCreateSettingMultipleDomains | |
66 | * and can be found in | |
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 | */ |