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