api/v3/examples/Setting/CreateAllDomains.php

   1 <?php
   2 /**
   3  * Test Generated example demonstrating the Setting.create API.
   4  *
   5  * Shows setting a variable for all domains.
   6  *
   7  * @return array
   8  *   API result array
   9  */
  10 function setting_create_example() {
  11   $params = [
  12     'domain_id' => 'all',
  13     'uniq_email_per_site' => 1,
  14   ];
  15
  16   try{
  17     $result = civicrm_api3('Setting', 'create', $params);
  18   }
  19   catch (CiviCRM_API3_Exception $e) {
  20     // Handle error here.
  21     $errorMessage = $e->getMessage();
  22     $errorCode = $e->getErrorCode();
  23     $errorData = $e->getExtraParams();
  24     return [
  25       'is_error' => 1,
  26       'error_message' => $errorMessage,
  27       'error_code' => $errorCode,
  28       'error_data' => $errorData,
  29     ];
  30   }
  31
  32   return $result;
  33 }
  34
  35 /**
  36  * Function returns array of result expected from previous function.
  37  *
  38  * @return array
  39  *   API result array
  40  */
  41 function setting_create_expectedresult() {
  42
  43   $expectedResult = [
  44     'is_error' => 0,
  45     'version' => 3,
  46     'count' => 3,
  47     'values' => [
  48       '1' => [
  49         'uniq_email_per_site' => '1',
  50       ],
  51       '2' => [
  52         'uniq_email_per_site' => '1',
  53       ],
  54       '3' => [
  55         'uniq_email_per_site' => '1',
  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 */