api/v3/examples/SettingGet.php

   1 <?php
   2 /**
   3  * Test Generated example of using setting get API
   4  * *
   5  */
   6 function setting_get_example(){
   7 $params = array(
   8   'domain_id' => 2,
   9   'return' => 'uniq_email_per_site',
  10 );
  11
  12 try{
  13   $result = civicrm_api3('setting', 'get', $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_get_expectedresult(){
  30
  31   $expectedResult = array(
  32   'is_error' => 0,
  33   'version' => 3,
  34   'count' => 1,
  35   'id' => 2,
  36   'values' => array(
  37       '2' => array(
  38           'uniq_email_per_site' => '1',
  39         ),
  40     ),
  41 );
  42
  43   return $expectedResult;
  44 }
  45
  46
  47 /*
  48 * This example has been generated from the API test suite. The test that created it is called
  49 *
  50 * testGetSetting and can be found in
  51 * http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/SettingTest.php
  52 *
  53 * You can see the outcome of the API tests at
  54 * http://tests.dev.civicrm.org/trunk/results-api_v3
  55 *
  56 * To Learn about the API read
  57 * http://book.civicrm.org/developer/current/techniques/api/
  58 *
  59 * and review the wiki at
  60 * http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs
  61 *
  62 * Read more about testing here
  63 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  64 *
  65 * API Standards documentation:
  66 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  67 */