Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
39de6fd5 | 4 | | CiviCRM version 4.6 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
731a0992 | 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
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 | /** | |
30 | * File for the CiviCRM APIv3 group functions | |
31 | * | |
32 | * @package CiviCRM_APIv3 | |
33 | * @subpackage API_PriceField | |
34 | * @copyright CiviCRM LLC (c) 20042012 | |
35 | */ | |
36 | ||
37 | /** | |
2e66abf8 | 38 | * Create or update a price_field. |
6a488035 | 39 | * |
cf470720 TO |
40 | * @param array $params |
41 | * Associative array of property. | |
6a488035 | 42 | * name/value pairs to insert in new 'price_field' |
6a488035 | 43 | * |
a6c01b45 | 44 | * @return array |
72b3a70c | 45 | * api result array |
6a488035 TO |
46 | */ |
47 | function civicrm_api3_price_field_create($params) { | |
48 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
49 | } | |
11e09c59 TO |
50 | |
51 | /** | |
0aa0303c EM |
52 | * Adjust Metadata for Create action. |
53 | * | |
54 | * The metadata is used for setting defaults, documentation & validation. | |
6a488035 | 55 | * |
cf470720 TO |
56 | * @param array $params |
57 | * Array or parameters determined by getfields. | |
6a488035 TO |
58 | */ |
59 | function _civicrm_api3_price_field_create_spec(&$params) { | |
291ebece | 60 | $params['label']['api.required'] = TRUE; |
6a488035 TO |
61 | } |
62 | ||
63 | /** | |
2e66abf8 | 64 | * Returns array of price_fields matching a set of one or more group properties. |
6a488035 | 65 | * |
cf470720 TO |
66 | * @param array $params |
67 | * Array of one or more valid property_name=>value pairs. If $params is set. | |
16b10e64 | 68 | * as null, all price_fields will be returned (default limit is 25) |
6a488035 | 69 | * |
a6c01b45 | 70 | * @return array |
72b3a70c | 71 | * Array of matching price_fields |
6a488035 TO |
72 | */ |
73 | function civicrm_api3_price_field_get($params) { | |
74 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
75 | } | |
76 | ||
77 | /** | |
2e66abf8 | 78 | * Delete an existing price_field. |
6a488035 TO |
79 | * |
80 | * This method is used to delete any existing price_field. id of the group | |
81 | * to be deleted is required field in $params array | |
82 | * | |
cf470720 TO |
83 | * @param array $params |
84 | * Array containing id of the group. | |
16b10e64 | 85 | * to be deleted |
6a488035 | 86 | * |
a6c01b45 | 87 | * @return array |
72b3a70c | 88 | * API result array |
6a488035 TO |
89 | */ |
90 | function civicrm_api3_price_field_delete($params) { | |
91 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
92 | } |