Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
fee14197 | 4 | | CiviCRM version 5 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
6b83d5bd | 6 | | Copyright CiviCRM LLC (c) 2004-2019 | |
6a488035 TO |
7 | +--------------------------------------------------------------------+ |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
10 | | CiviCRM is free software; you can copy, modify, and distribute it | | |
11 | | under the terms of the GNU Affero General Public License | | |
12 | | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. | | |
13 | | | | |
14 | | CiviCRM is distributed in the hope that it will be useful, but | | |
15 | | WITHOUT ANY WARRANTY; without even the implied warranty of | | |
16 | | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | | |
17 | | See the GNU Affero General Public License for more details. | | |
18 | | | | |
19 | | You should have received a copy of the GNU Affero General Public | | |
20 | | License and the CiviCRM Licensing Exception along | | |
21 | | with this program; if not, contact CiviCRM LLC | | |
22 | | at info[AT]civicrm[DOT]org. If you have questions about the | | |
23 | | GNU Affero General Public License or the licensing of CiviCRM, | | |
24 | | see the CiviCRM license FAQ at http://civicrm.org/licensing | | |
25 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
6a488035 TO |
27 | |
28 | ||
29 | /** | |
244bbdd8 CW |
30 | * This api exposes CiviCRM price field values. |
31 | * | |
32 | * PriceFields may contain zero or more PriceFieldValues. | |
33 | * Use chaining to create PriceFields and values in one api call. | |
6a488035 TO |
34 | * |
35 | * @package CiviCRM_APIv3 | |
6a488035 TO |
36 | */ |
37 | ||
38 | /** | |
244bbdd8 | 39 | * Create or update a PriceFieldValue. |
6a488035 | 40 | * |
cf470720 | 41 | * @param array $params |
244bbdd8 | 42 | * name/value pairs to insert in new 'PriceFieldValue' |
6a488035 | 43 | * |
a6c01b45 | 44 | * @return array |
1747ab99 | 45 | * API result array. |
6a488035 TO |
46 | */ |
47 | function civicrm_api3_price_field_value_create($params) { | |
48 | $ids = array(); | |
9b873358 | 49 | if (!empty($params['id'])) { |
6a488035 TO |
50 | $ids['id'] = $params['id']; |
51 | } | |
52 | ||
9da8dc8c | 53 | $bao = CRM_Price_BAO_PriceFieldValue::create($params, $ids); |
6a488035 TO |
54 | |
55 | $values = array(); | |
56 | _civicrm_api3_object_to_array($bao, $values[$bao->id]); | |
244bbdd8 | 57 | return civicrm_api3_create_success($values, $params, 'PriceFieldValue', 'create', $bao); |
6a488035 | 58 | |
11e09c59 TO |
59 | } |
60 | ||
61 | /** | |
0aa0303c EM |
62 | * Adjust Metadata for Create action. |
63 | * | |
64 | * The metadata is used for setting defaults, documentation & validation. | |
6a488035 | 65 | * |
cf470720 | 66 | * @param array $params |
b081365f | 67 | * Array of parameters determined by getfields. |
6a488035 TO |
68 | */ |
69 | function _civicrm_api3_price_field_value_create_spec(&$params) { | |
418e884f | 70 | $params['price_field_id']['api.required'] = TRUE; |
e825f029 | 71 | $params['label']['api.required'] = TRUE; |
aa52367c EM |
72 | $params['amount']['api.required'] = TRUE; |
73 | $params['is_active']['api.default'] = TRUE; | |
15a25cec | 74 | $params['financial_type_id']['api.default'] = TRUE; |
6a488035 TO |
75 | } |
76 | ||
77 | /** | |
244bbdd8 | 78 | * Returns array of PriceFieldValues matching a set of one or more group properties. |
6a488035 | 79 | * |
cf470720 TO |
80 | * @param array $params |
81 | * Array of one or more valid property_name=>value pairs. If $params is set. | |
16b10e64 | 82 | * as null, all price_field_values will be returned (default limit is 25) |
6a488035 | 83 | * |
a6c01b45 | 84 | * @return array |
1747ab99 | 85 | * API result array. |
6a488035 TO |
86 | */ |
87 | function civicrm_api3_price_field_value_get($params) { | |
88 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
89 | } | |
90 | ||
91 | /** | |
244bbdd8 | 92 | * Delete an existing PriceFieldValue. |
6a488035 | 93 | * |
244bbdd8 | 94 | * This method is used to delete any existing PriceFieldValue given its id. |
6a488035 | 95 | * |
cf470720 | 96 | * @param array $params |
b081365f | 97 | * Array containing id of the group to be deleted. |
6a488035 | 98 | * |
a6c01b45 | 99 | * @return array |
1747ab99 | 100 | * API result array. |
6a488035 TO |
101 | */ |
102 | function civicrm_api3_price_field_value_delete($params) { | |
103 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
104 | } |