api/v3/examples/Setting/GetAllDomains.php

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