api/v3/examples/Setting/CreateAllDomains.php

   1 <?php
   2 /**
   3  * Test Generated example of using setting create API
   4  * shows setting a variable for all domains *
   5  */
   6 function setting_create_example(){
   7 $params = array(
   8   'domain_id' => 'all',
   9   'uniq_email_per_site' => 1,
  10 );
  11
  12 try{
  13   $result = civicrm_api3('setting', 'create', $params);
  14 }
  15 catch (CiviCRM_API3_Exception $e) {
  16   // handle error here
  17   $errorMessage = $e->getMessage();
  18   $errorCode = $e->getErrorCode();
  19   $errorData = $e->getExtraParams();
  20   return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
  21 }
  22
  23 return $result;
  24 }
  25
  26 /**
  27  * Function returns array of result expected from previous function
  28  */
  29 function setting_create_expectedresult(){
  30
  31   $expectedResult = array(
  32   'is_error' => 0,
  33   'version' => 3,
  34   'count' => 3,
  35   'values' => array(
  36       '1' => array(
  37           'uniq_email_per_site' => '1',
  38         ),
  39       '2' => array(
  40           'uniq_email_per_site' => '1',
  41         ),
  42       '3' => array(
  43           'uniq_email_per_site' => '1',
  44         ),
  45     ),
  46 );
  47
  48   return $expectedResult;
  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
  56 * http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/SettingTest.php
  57 *
  58 * You can see the outcome of the API tests at
  59 * http://tests.dev.civicrm.org/trunk/results-api_v3
  60 *
  61 * To Learn about the API read
  62 * http://book.civicrm.org/developer/current/techniques/api/
  63 *
  64 * and review the wiki at
  65 * http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs
  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
  72 */