api/v3/examples/Setting/GetSpecifiedDomains.php

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