api/v3/examples/Setting/Get.php

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