3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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 * File for the CiviCRM APIv3 group functions
32 * @package CiviCRM_APIv3
33 * @subpackage API_PriceField
34 * @copyright CiviCRM LLC (c) 20042012
38 * Create or update a price_field
40 * @param array $params
41 * Associative array of property.
42 * name/value pairs to insert in new 'price_field'
43 * @example PriceFieldCreate.php Std Create example
47 * {@getfields price_field_create}
49 function civicrm_api3_price_field_create($params) {
50 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
54 * Adjust Metadata for Create action.
56 * The metadata is used for setting defaults, documentation & validation.
58 * @param array $params
59 * Array or parameters determined by getfields.
61 function _civicrm_api3_price_field_create_spec(&$params) {
62 $params['label']['api.required'] = TRUE;
66 * Returns array of price_fields matching a set of one or more group properties
68 * @param array $params
69 * Array of one or more valid property_name=>value pairs. If $params is set.
70 * as null, all price_fields will be returned (default limit is 25)
73 * Array of matching price_fields
74 * {@getfields price_field_get}
76 function civicrm_api3_price_field_get($params) {
77 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
81 * delete an existing price_field
83 * This method is used to delete any existing price_field. id of the group
84 * to be deleted is required field in $params array
86 * @param array $params
87 * Array containing id of the group.
92 * {@getfields price_field_delete}
94 function civicrm_api3_price_field_delete($params) {
95 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);