b0ed2bdaf49bbfb30f1e8ca6e14788f58397bb1e
3 * Test Generated example demonstrating the OptionValue.getsingle API.
5 * Demonstrates use of Sort param (available in many api functions). Also, getsingle.
10 function option_value_getsingle_example() {
12 'option_group_id' => 1,
14 'sort' => 'label DESC',
20 $result = civicrm_api3('OptionValue', 'getsingle', $params);
22 catch (CiviCRM_API3_Exception
$e) {
24 $errorMessage = $e->getMessage();
25 $errorCode = $e->getErrorCode();
26 $errorData = $e->getExtraParams();
28 'error' => $errorMessage,
29 'error_code' => $errorCode,
30 'error_data' => $errorData,
38 * Function returns array of result expected from previous function.
43 function option_value_getsingle_expectedresult() {
45 $expectedResult = array(
47 'option_group_id' => '1',
57 return $expectedResult;
61 * This example has been generated from the API test suite.
62 * The test that created it is called "testGetSingleValueOptionValueSort"
63 * and can be found at:
64 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/OptionValueTest.php
66 * You can see the outcome of the API tests at
67 * https://test.civicrm.org/job/CiviCRM-master-git/
69 * To Learn about the API read
70 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
72 * Browse the api on your own site with the api explorer
73 * http://MYSITE.ORG/path/to/civicrm/api
75 * Read more about testing here
76 * http://wiki.civicrm.org/confluence/display/CRM/Testing
78 * API Standards documentation:
79 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards