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 LineItem records. |
31 | * | |
32 | * Line items are sub-components of a complete financial transaction record. | |
6a488035 TO |
33 | * |
34 | * @package CiviCRM_APIv3 | |
6a488035 TO |
35 | */ |
36 | ||
37 | /** | |
22242c87 | 38 | * Create or update a line_item. |
6a488035 | 39 | * |
cf470720 | 40 | * @param array $params |
dc64d047 | 41 | * Array of property name/value pairs to insert in new 'line_item' |
6a488035 | 42 | * |
a6c01b45 | 43 | * @return array |
72b3a70c | 44 | * api result array |
6a488035 TO |
45 | */ |
46 | function civicrm_api3_line_item_create($params) { | |
1c281d1d | 47 | // @todo the following line is not really appropriate for the api. The BAO should |
48 | // do the work, and it should be in a tighter function. The below function is not really | |
49 | // readable because it is handling contribution and line item together. | |
8cb8ae98 | 50 | $params = CRM_Contribute_BAO_Contribution::checkTaxAmount($params, TRUE); |
ddaf2161 | 51 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'LineItem'); |
6a488035 | 52 | } |
11e09c59 TO |
53 | |
54 | /** | |
0aa0303c EM |
55 | * Adjust Metadata for Create action. |
56 | * | |
57 | * The metadata is used for setting defaults, documentation & validation. | |
6a488035 | 58 | * |
cf470720 | 59 | * @param array $params |
b081365f | 60 | * Array of parameters determined by getfields. |
6a488035 TO |
61 | */ |
62 | function _civicrm_api3_line_item_create_spec(&$params) { | |
63 | $params['entity_id']['api.required'] = 1; | |
64 | $params['qty']['api.required'] = 1; | |
65 | $params['unit_price']['api.required'] = 1; | |
66 | $params['line_total']['api.required'] = 1; | |
67 | $params['label']['api.default'] = 'line item'; | |
68 | } | |
69 | ||
70 | /** | |
d1b0d05e | 71 | * Returns array of line_items matching a set of one or more group properties. |
6a488035 | 72 | * |
cf470720 TO |
73 | * @param array $params |
74 | * Array of one or more valid property_name=>value pairs. If $params is set. | |
16b10e64 | 75 | * as null, all line_items will be returned (default limit is 25) |
6a488035 | 76 | * |
a6c01b45 | 77 | * @return array |
72b3a70c | 78 | * Array of matching line_items |
6a488035 TO |
79 | */ |
80 | function civicrm_api3_line_item_get($params) { | |
93b21909 | 81 | if (CRM_Financial_BAO_FinancialType::isACLFinancialTypeStatus() && CRM_Utils_Array::value('check_permissions', $params)) { |
ac5a0d1c | 82 | CRM_Price_BAO_LineItem::getAPILineItemParams($params); |
2344a42b | 83 | } |
6a488035 TO |
84 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
85 | } | |
86 | ||
87 | /** | |
244bbdd8 | 88 | * Delete an existing LineItem. |
6a488035 | 89 | * |
244bbdd8 | 90 | * This method is used to delete any existing LineItem given its id. |
6a488035 | 91 | * |
cf470720 | 92 | * @param array $params |
b081365f | 93 | * Array containing id of the group to be deleted. |
8089541a | 94 | * @return array API result array |
8089541a | 95 | * @throws API_Exception |
6a488035 TO |
96 | */ |
97 | function civicrm_api3_line_item_delete($params) { | |
93b21909 | 98 | if (CRM_Financial_BAO_FinancialType::isACLFinancialTypeStatus() && CRM_Utils_Array::value('check_permissions', $params)) { |
a3fa0340 | 99 | CRM_Financial_BAO_FinancialType::getAvailableFinancialTypes($types, CRM_Core_Action::DELETE); |
8cb8ae98 | 100 | if (empty($params['financial_type_id'])) { |
ac5a0d1c | 101 | $params['financial_type_id'] = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_LineItem', $params['id'], 'financial_type_id'); |
8cb8ae98 E |
102 | } |
103 | if (!in_array($params['financial_type_id'], array_keys($types))) { | |
104 | throw new API_Exception('You do not have permission to delete this line item'); | |
105 | } | |
106 | } | |
6a488035 | 107 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
9716cd7c | 108 | } |