api/v3/examples/Setting/CreateSettingCurrentDomain.php

   1 <?php
   2 /**
   3  * Test Generated example of using setting create API
   4  * shows setting a variable for a current domain *
   5  */
   6 function setting_create_example(){
   7 $params = array(
   8   'uniq_email_per_site' => 1,
   9 );
  10
  11 try{
  12   $result = civicrm_api3('setting', 'create', $params);
  13 }
  14 catch (CiviCRM_API3_Exception $e) {
  15   // handle error here
  16   $errorMessage = $e->getMessage();
  17   $errorCode = $e->getErrorCode();
  18   $errorData = $e->getExtraParams();
  19   return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
  20 }
  21
  22 return $result;
  23 }
  24
  25 /**
  26  * Function returns array of result expected from previous function
  27  */
  28 function setting_create_expectedresult(){
  29
  30   $expectedResult = array(
  31   'is_error' => 0,
  32   'version' => 3,
  33   'count' => 1,
  34   'id' => 1,
  35   'values' => array(
  36       '1' => array(
  37           'uniq_email_per_site' => '1',
  38         ),
  39     ),
  40 );
  41
  42   return $expectedResult;
  43 }
  44
  45
  46 /*
  47 * This example has been generated from the API test suite. The test that created it is called
  48 *
  49 * testCreateSetting and can be found in
  50 * http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/SettingTest.php
  51 *
  52 * You can see the outcome of the API tests at
  53 * http://tests.dev.civicrm.org/trunk/results-api_v3
  54 *
  55 * To Learn about the API read
  56 * http://book.civicrm.org/developer/current/techniques/api/
  57 *
  58 * and review the wiki at
  59 * http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs
  60 *
  61 * Read more about testing here
  62 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  63 *
  64 * API Standards documentation:
  65 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  66 */