api/v3/examples/Setting/GetSpecifiedDomains.php

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