Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
50fb255d | 2 | /** |
a828d7b8 | 3 | * Test Generated example demonstrating the PriceField.get API. |
50fb255d | 4 | * |
50fb255d | 5 | * @return array |
6 | * API result array | |
7 | */ | |
8 | function price_field_get_example() { | |
cf8f0fff | 9 | $params = [ |
50fb255d | 10 | 'name' => 'contribution_amount', |
cf8f0fff | 11 | ]; |
6a488035 | 12 | |
50fb255d | 13 | try{ |
a828d7b8 | 14 | $result = civicrm_api3('PriceField', 'get', $params); |
50fb255d | 15 | } |
16 | catch (CiviCRM_API3_Exception $e) { | |
17 | // Handle error here. | |
18 | $errorMessage = $e->getMessage(); | |
19 | $errorCode = $e->getErrorCode(); | |
20 | $errorData = $e->getExtraParams(); | |
cf8f0fff | 21 | return [ |
1d8ee3d6 | 22 | 'is_error' => 1, |
23 | 'error_message' => $errorMessage, | |
50fb255d | 24 | 'error_code' => $errorCode, |
25 | 'error_data' => $errorData, | |
cf8f0fff | 26 | ]; |
50fb255d | 27 | } |
28 | ||
29 | return $result; | |
6a488035 TO |
30 | } |
31 | ||
fb32de45 | 32 | /** |
50fb255d | 33 | * Function returns array of result expected from previous function. |
34 | * | |
35 | * @return array | |
36 | * API result array | |
6a488035 | 37 | */ |
50fb255d | 38 | function price_field_get_expectedresult() { |
6a488035 | 39 | |
cf8f0fff | 40 | $expectedResult = [ |
50fb255d | 41 | 'is_error' => 0, |
42 | 'version' => 3, | |
43 | 'count' => 1, | |
44 | 'id' => 1, | |
cf8f0fff CW |
45 | 'values' => [ |
46 | '1' => [ | |
50fb255d | 47 | 'id' => '1', |
48 | 'price_set_id' => '1', | |
49 | 'name' => 'contribution_amount', | |
50 | 'label' => 'Contribution Amount', | |
51 | 'html_type' => 'Text', | |
52 | 'is_enter_qty' => 0, | |
53 | 'weight' => '1', | |
54 | 'is_display_amounts' => '1', | |
55 | 'options_per_line' => '1', | |
56 | 'is_active' => '1', | |
57 | 'is_required' => '1', | |
58 | 'visibility_id' => '1', | |
cf8f0fff CW |
59 | ], |
60 | ], | |
61 | ]; | |
6a488035 | 62 | |
fb32de45 | 63 | return $expectedResult; |
6a488035 TO |
64 | } |
65 | ||
a828d7b8 | 66 | /* |
50fb255d | 67 | * This example has been generated from the API test suite. |
a828d7b8 CW |
68 | * The test that created it is called "testGetBasicPriceField" |
69 | * and can be found at: | |
69d79249 | 70 | * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/PriceFieldTest.php |
6a488035 TO |
71 | * |
72 | * You can see the outcome of the API tests at | |
8390b11b | 73 | * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ |
6a488035 TO |
74 | * |
75 | * To Learn about the API read | |
8390b11b | 76 | * https://docs.civicrm.org/dev/en/latest/api/ |
6a488035 | 77 | * |
8390b11b SL |
78 | * Browse the API on your own site with the API Explorer. It is in the main |
79 | * CiviCRM menu, under: Support > Development > API Explorer. | |
6a488035 TO |
80 | * |
81 | * Read more about testing here | |
8390b11b | 82 | * https://docs.civicrm.org/dev/en/latest/testing/ |
6a488035 TO |
83 | * |
84 | * API Standards documentation: | |
8390b11b | 85 | * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ |
b259a4ab | 86 | */ |