api/v3/examples/Setting/CreateSpecifiedDomains.php

   1 <?php
   2 /**
   3  * Test Generated example demonstrating the 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(
  13       '0' => 1,
  14       '1' => 3,
  15     ),
  16     'uniq_email_per_site' => 0,
  17   );
  18
  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       'is_error' => 1,
  29       'error_message' => $errorMessage,
  30       'error_code' => $errorCode,
  31       'error_data' => $errorData,
  32     );
  33   }
  34
  35   return $result;
  36 }
  37
  38 /**
  39  * Function returns array of result expected from previous function.
  40  *
  41  * @return array
  42  *   API result array
  43  */
  44 function setting_create_expectedresult() {
  45
  46   $expectedResult = array(
  47     'is_error' => 0,
  48     'version' => 3,
  49     'count' => 2,
  50     'values' => array(
  51       '1' => array(
  52         'uniq_email_per_site' => 0,
  53       ),
  54       '3' => array(
  55         'uniq_email_per_site' => 0,
  56       ),
  57     ),
  58   );
  59
  60   return $expectedResult;
  61 }
  62
  63 /*
  64 * This example has been generated from the API test suite.
  65 * The test that created it is called "testCreateSettingMultipleDomains"
  66 * and can be found at:
  67 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/SettingTest.php
  68 *
  69 * You can see the outcome of the API tests at
  70 * https://test.civicrm.org/job/CiviCRM-master-git/
  71 *
  72 * To Learn about the API read
  73 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
  74 *
  75 * Browse the api on your own site with the api explorer
  76 * http://MYSITE.ORG/path/to/civicrm/api
  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
  83 */