3 * Test Generated example of using option_value getsingle API
4 * demonstrates use of Sort param (available in many api functions). Also, getsingle *
6 function option_value_getsingle_example(){
8 'option_group_id' => 1,
10 'sort' => 'label DESC',
16 $result = civicrm_api3('option_value', 'getsingle', $params);
18 catch (CiviCRM_API3_Exception
$e) {
20 $errorMessage = $e->getMessage();
21 $errorCode = $e->getErrorCode();
22 $errorData = $e->getExtraParams();
23 return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
30 * Function returns array of result expected from previous function
32 function option_value_getsingle_expectedresult(){
34 $expectedResult = array(
36 'option_group_id' => '1',
46 return $expectedResult;
51 * This example has been generated from the API test suite. The test that created it is called
53 * testGetSingleValueOptionValueSort and can be found in
54 * http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/OptionValueTest.php
56 * You can see the outcome of the API tests at
57 * http://tests.dev.civicrm.org/trunk/results-api_v3
59 * To Learn about the API read
60 * http://book.civicrm.org/developer/current/techniques/api/
62 * and review the wiki at
63 * http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs
65 * Read more about testing here
66 * http://wiki.civicrm.org/confluence/display/CRM/Testing
68 * API Standards documentation:
69 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards