api/v3/examples/Setting/GetValue.php

   1 <?php
   2 /**
   3  * Test Generated example of using setting getvalue API.
   4  *
   5  * Demonstrates getvalue action - intended for runtime use as better caching than get.
   6  *
   7  * @return array
   8  *   API result array
   9  */
  10 function setting_getvalue_example() {
  11   $params = array(
  12     'name' => 'petition_contacts',
  13     'group' => 'Campaign Preferences',
  14   );
  15
  16   try{
  17     $result = civicrm_api3('setting', 'getvalue', $params);
  18   }
  19   catch (CiviCRM_API3_Exception $e) {
  20     // Handle error here.
  21     $errorMessage = $e->getMessage();
  22     $errorCode = $e->getErrorCode();
  23     $errorData = $e->getExtraParams();
  24     return array(
  25       'error' => $errorMessage,
  26       'error_code' => $errorCode,
  27       'error_data' => $errorData,
  28     );
  29   }
  30
  31   return $result;
  32 }
  33
  34 /**
  35  * Function returns array of result expected from previous function.
  36  *
  37  * @return array
  38  *   API result array
  39  */
  40 function setting_getvalue_expectedresult() {
  41
  42   $expectedResult = 'Petition Contacts';
  43
  44   return $expectedResult;
  45 }
  46
  47 /**
  48 * This example has been generated from the API test suite.
  49 * The test that created it is called
  50 * testGetValue
  51 * and can be found in
  52 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/SettingTest.php
  53 *
  54 * You can see the outcome of the API tests at
  55 * https://test.civicrm.org/job/CiviCRM-master-git/
  56 *
  57 * To Learn about the API read
  58 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
  59 *
  60 * Browse the api on your own site with the api explorer
  61 * http://MYSITE.ORG/path/to/civicrm/api
  62 *
  63 * Read more about testing here
  64 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  65 *
  66 * API Standards documentation:
  67 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  68 */