Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
50fb255d | 2 | /** |
a828d7b8 | 3 | * Test Generated example demonstrating the OptionValue.getsingle API. |
50fb255d | 4 | * |
5c49fee0 | 5 | * Demonstrates use of Sort param (available in many api functions). Also, getsingle. |
50fb255d | 6 | * |
7 | * @return array | |
8 | * API result array | |
9 | */ | |
10 | function option_value_getsingle_example() { | |
11 | $params = array( | |
12 | 'option_group_id' => 1, | |
13 | 'options' => array( | |
6a488035 TO |
14 | 'sort' => 'label DESC', |
15 | 'limit' => 1, | |
16 | ), | |
50fb255d | 17 | ); |
6a488035 | 18 | |
50fb255d | 19 | try{ |
a828d7b8 | 20 | $result = civicrm_api3('OptionValue', 'getsingle', $params); |
50fb255d | 21 | } |
22 | catch (CiviCRM_API3_Exception $e) { | |
23 | // Handle error here. | |
24 | $errorMessage = $e->getMessage(); | |
25 | $errorCode = $e->getErrorCode(); | |
26 | $errorData = $e->getExtraParams(); | |
27 | return array( | |
28 | 'error' => $errorMessage, | |
29 | 'error_code' => $errorCode, | |
30 | 'error_data' => $errorData, | |
31 | ); | |
32 | } | |
6a488035 | 33 | |
50fb255d | 34 | return $result; |
6a488035 TO |
35 | } |
36 | ||
fb32de45 | 37 | /** |
50fb255d | 38 | * Function returns array of result expected from previous function. |
39 | * | |
40 | * @return array | |
41 | * API result array | |
6a488035 | 42 | */ |
50fb255d | 43 | function option_value_getsingle_expectedresult() { |
6a488035 | 44 | |
53ca8fd7 | 45 | $expectedResult = array( |
50fb255d | 46 | 'id' => '4', |
47 | 'option_group_id' => '1', | |
48 | 'label' => 'SMS', | |
49 | 'value' => '4', | |
50 | 'filter' => 0, | |
51 | 'weight' => '4', | |
52 | 'is_optgroup' => 0, | |
53 | 'is_reserved' => 0, | |
54 | 'is_active' => '1', | |
55 | ); | |
6a488035 | 56 | |
fb32de45 | 57 | return $expectedResult; |
6a488035 TO |
58 | } |
59 | ||
a828d7b8 | 60 | /* |
50fb255d | 61 | * This example has been generated from the API test suite. |
a828d7b8 CW |
62 | * The test that created it is called "testGetSingleValueOptionValueSort" |
63 | * and can be found at: | |
69d79249 | 64 | * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/OptionValueTest.php |
6a488035 TO |
65 | * |
66 | * You can see the outcome of the API tests at | |
69d79249 | 67 | * https://test.civicrm.org/job/CiviCRM-master-git/ |
6a488035 TO |
68 | * |
69 | * To Learn about the API read | |
69d79249 | 70 | * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API |
6a488035 | 71 | * |
69d79249 | 72 | * Browse the api on your own site with the api explorer |
41d4d31f | 73 | * http://MYSITE.ORG/path/to/civicrm/api |
6a488035 TO |
74 | * |
75 | * Read more about testing here | |
76 | * http://wiki.civicrm.org/confluence/display/CRM/Testing | |
77 | * | |
78 | * API Standards documentation: | |
79 | * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards | |
89ab5601 | 80 | */ |