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