api/v3/examples/SettingGetValue.php

   1 <?php
   2 /**
   3  * Test Generated example of using setting getvalue API
   4  * Demonstrates getvalue action - intended for runtime use as better caching than get *
   5  */
   6 function setting_getvalue_example(){
   7 $params = array(
   8   'name' => 'petition_contacts',
   9   'group' => 'Campaign Preferences',
  10 );
  11
  12 try{
  13   $result = civicrm_api3('setting', 'getvalue', $params);
  14 }
  15 catch (CiviCRM_API3_Exception $e) {
  16   // handle error here
  17   $errorMessage = $e->getMessage();
  18   $errorCode = $e->getErrorCode();
  19   $errorData = $e->getExtraParams();
  20   return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
  21 }
  22
  23 return $result;
  24 }
  25
  26 /**
  27  * Function returns array of result expected from previous function
  28  */
  29 function setting_getvalue_expectedresult(){
  30
  31   $expectedResult = 'Petition Contacts';
  32
  33   return $expectedResult;
  34 }
  35
  36
  37 /*
  38 * This example has been generated from the API test suite. The test that created it is called
  39 *
  40 * testGetValue and can be found in
  41 * http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/SettingTest.php
  42 *
  43 * You can see the outcome of the API tests at
  44 * http://tests.dev.civicrm.org/trunk/results-api_v3
  45 *
  46 * To Learn about the API read
  47 * http://book.civicrm.org/developer/current/techniques/api/
  48 *
  49 * and review the wiki at
  50 * http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs
  51 *
  52 * Read more about testing here
  53 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  54 *
  55 * API Standards documentation:
  56 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  57 */