api/v3/examples/Setting/CreateSpecifiedDomains.php

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