3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
30 * This api exposes CiviCRM price field values.
32 * PriceFields may contain zero or more PriceFieldValues.
33 * Use chaining to create PriceFields and values in one api call.
35 * @package CiviCRM_APIv3
39 * Create or update a PriceFieldValue.
41 * @param array $params
42 * name/value pairs to insert in new 'PriceFieldValue'
47 function civicrm_api3_price_field_value_create($params) {
49 if (!empty($params['id'])) {
50 $ids['id'] = $params['id'];
53 $bao = CRM_Price_BAO_PriceFieldValue
::create($params, $ids);
56 _civicrm_api3_object_to_array($bao, $values[$bao->id
]);
57 return civicrm_api3_create_success($values, $params, 'PriceFieldValue', 'create', $bao);
62 * Adjust Metadata for Create action.
64 * The metadata is used for setting defaults, documentation & validation.
66 * @param array $params
67 * Array of parameters determined by getfields.
69 function _civicrm_api3_price_field_value_create_spec(&$params) {
70 $params['price_field_id']['api.required'] = TRUE;
71 $params['label']['api.required'] = TRUE;
72 $params['amount']['api.required'] = TRUE;
73 $params['is_active']['api.default'] = TRUE;
77 * Returns array of PriceFieldValues matching a set of one or more group properties.
79 * @param array $params
80 * Array of one or more valid property_name=>value pairs. If $params is set.
81 * as null, all price_field_values will be returned (default limit is 25)
86 function civicrm_api3_price_field_value_get($params) {
87 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
91 * Delete an existing PriceFieldValue.
93 * This method is used to delete any existing PriceFieldValue given its id.
95 * @param array $params
96 * Array containing id of the group to be deleted.
101 function civicrm_api3_price_field_value_delete($params) {
102 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);