3 * Test Generated example of using setting getvalue API
4 * Demonstrates getvalue action - intended for runtime use as better caching than get *
6 function setting_getvalue_example(){
8 'name' => 'petition_contacts',
9 'group' => 'Campaign Preferences',
13 $result = civicrm_api3('setting', 'getvalue', $params);
15 catch (CiviCRM_API3_Exception
$e) {
17 $errorMessage = $e->getMessage();
18 $errorCode = $e->getErrorCode();
19 $errorData = $e->getExtraParams();
20 return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
27 * Function returns array of result expected from previous function
29 function setting_getvalue_expectedresult(){
31 $expectedResult = 'Petition Contacts';
33 return $expectedResult;
38 * This example has been generated from the API test suite. The test that created it is called
40 * testGetValue and can be found in
41 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/SettingTest.php
43 * You can see the outcome of the API tests at
44 * https://test.civicrm.org/job/CiviCRM-master-git/
46 * To Learn about the API read
47 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
49 * Browse the api on your own site with the api explorer
50 * http://MYSITE.ORG/path/to/civicrm/api/explorer
52 * Read more about testing here
53 * http://wiki.civicrm.org/confluence/display/CRM/Testing
55 * API Standards documentation:
56 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards