Commit | Line | Data |
---|---|---|
31a99426 PN |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
fee14197 | 4 | | CiviCRM version 5 | |
31a99426 | 5 | +--------------------------------------------------------------------+ |
6b83d5bd | 6 | | Copyright CiviCRM LLC (c) 2004-2019 | |
31a99426 PN |
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 | +--------------------------------------------------------------------+ | |
26 | */ | |
27 | ||
28 | /** | |
7cad285e JM |
29 | * This api exposes CiviCRM Order objects, an abstract entity |
30 | * comprised of contributions and related line items. | |
31a99426 PN |
31 | * |
32 | * @package CiviCRM_APIv3 | |
33 | */ | |
34 | ||
35 | /** | |
36 | * Retrieve a set of Order. | |
37 | * | |
38 | * @param array $params | |
39 | * Input parameters. | |
40 | * | |
41 | * @return array | |
42 | * Array of Order, if error an array with an error id and error message | |
43 | */ | |
44 | function civicrm_api3_order_get($params) { | |
cf8f0fff CW |
45 | $contributions = []; |
46 | $params['api.line_item.get'] = ['qty' => ['<>' => 0]]; | |
31a99426 | 47 | $isSequential = FALSE; |
de6c59ca | 48 | if (!empty($params['sequential'])) { |
31a99426 PN |
49 | $params['sequential'] = 0; |
50 | $isSequential = TRUE; | |
51 | } | |
52 | $result = civicrm_api3('Contribution', 'get', $params); | |
53 | if (!empty($result['values'])) { | |
54 | foreach ($result['values'] as $key => $contribution) { | |
55 | $contributions[$key] = $contribution; | |
56 | $contributions[$key]['line_items'] = $contribution['api.line_item.get']['values']; | |
57 | unset($contributions[$key]['api.line_item.get']); | |
58 | } | |
59 | } | |
60 | $params['sequential'] = $isSequential; | |
61 | return civicrm_api3_create_success($contributions, $params, 'Order', 'get'); | |
62 | } | |
b8644ae3 | 63 | |
785f03e2 | 64 | /** |
65 | * Adjust Metadata for Get action. | |
66 | * | |
67 | * The metadata is used for setting defaults, documentation & validation. | |
68 | * | |
69 | * @param array $params | |
70 | * Array of parameters determined by getfields. | |
71 | */ | |
72 | function _civicrm_api3_order_get_spec(&$params) { | |
73 | $params['id']['api.aliases'] = ['order_id']; | |
74 | $params['id']['title'] = ts('Contribution / Order ID'); | |
75 | } | |
76 | ||
b8644ae3 PN |
77 | /** |
78 | * Add or update a Order. | |
79 | * | |
80 | * @param array $params | |
81 | * Input parameters. | |
82 | * | |
b8644ae3 PN |
83 | * @return array |
84 | * Api result array | |
9c5edcd4 | 85 | * |
86 | * @throws \CiviCRM_API3_Exception | |
87 | * @throws API_Exception | |
b8644ae3 | 88 | */ |
1c31aa41 | 89 | function civicrm_api3_order_create($params) { |
9c5edcd4 | 90 | civicrm_api3_verify_one_mandatory($params, NULL, ['line_items', 'total_amount']); |
b8644ae3 | 91 | $entity = NULL; |
cf8f0fff | 92 | $entityIds = []; |
de6c59ca | 93 | if (!empty($params['line_items']) && is_array($params['line_items'])) { |
b8644ae3 PN |
94 | $priceSetID = NULL; |
95 | CRM_Contribute_BAO_Contribution::checkLineItems($params); | |
96 | foreach ($params['line_items'] as $lineItems) { | |
cf8f0fff | 97 | $entityParams = CRM_Utils_Array::value('params', $lineItems, []); |
b8644ae3 PN |
98 | if (!empty($entityParams) && !empty($lineItems['line_item'])) { |
99 | $item = reset($lineItems['line_item']); | |
100 | $entity = str_replace('civicrm_', '', $item['entity_table']); | |
101 | } | |
102 | if ($entityParams) { | |
cf8f0fff | 103 | if (in_array($entity, ['participant', 'membership'])) { |
b8644ae3 PN |
104 | $entityParams['skipLineItem'] = TRUE; |
105 | $entityResult = civicrm_api3($entity, 'create', $entityParams); | |
106 | $params['contribution_mode'] = $entity; | |
107 | $entityIds[] = $params[$entity . '_id'] = $entityResult['id']; | |
108 | foreach ($lineItems['line_item'] as &$items) { | |
109 | $items['entity_id'] = $entityResult['id']; | |
110 | } | |
111 | } | |
112 | else { | |
113 | // pledge payment | |
114 | } | |
115 | } | |
116 | if (empty($priceSetID)) { | |
117 | $item = reset($lineItems['line_item']); | |
cf8f0fff | 118 | $priceSetID = civicrm_api3('PriceField', 'getvalue', [ |
b8644ae3 PN |
119 | 'return' => 'price_set_id', |
120 | 'id' => $item['price_field_id'], | |
cf8f0fff CW |
121 | ]); |
122 | $params['line_item'][$priceSetID] = []; | |
b8644ae3 PN |
123 | } |
124 | $params['line_item'][$priceSetID] = array_merge($params['line_item'][$priceSetID], $lineItems['line_item']); | |
125 | } | |
126 | } | |
127 | $contribution = civicrm_api3('Contribution', 'create', $params); | |
128 | // add payments | |
de6c59ca | 129 | if ($entity && !empty($contribution['id'])) { |
b8644ae3 | 130 | foreach ($entityIds as $entityId) { |
cf8f0fff | 131 | $paymentParams = [ |
b8644ae3 PN |
132 | 'contribution_id' => $contribution['id'], |
133 | $entity . '_id' => $entityId, | |
cf8f0fff | 134 | ]; |
b8644ae3 PN |
135 | // if entity is pledge then build pledge param |
136 | if ($entity == 'pledge') { | |
137 | $paymentParams += $entityParams; | |
138 | } | |
139 | $payments = civicrm_api3($entity . '_payment', 'create', $paymentParams); | |
140 | } | |
141 | } | |
142 | return civicrm_api3_create_success(CRM_Utils_Array::value('values', $contribution), $params, 'Order', 'create'); | |
143 | } | |
144 | ||
5f44f698 PN |
145 | /** |
146 | * Delete a Order. | |
147 | * | |
148 | * @param array $params | |
149 | * Input parameters. | |
5f44f698 | 150 | * @return array |
8089541a SL |
151 | * @throws API_Exception |
152 | * @throws CiviCRM_API3_Exception | |
5f44f698 PN |
153 | */ |
154 | function civicrm_api3_order_delete($params) { | |
cf8f0fff CW |
155 | $contribution = civicrm_api3('Contribution', 'get', [ |
156 | 'return' => ['is_test'], | |
95c4e89e | 157 | 'id' => $params['id'], |
cf8f0fff | 158 | ]); |
5f44f698 PN |
159 | if ($contribution['id'] && $contribution['values'][$contribution['id']]['is_test'] == TRUE) { |
160 | $result = civicrm_api3('Contribution', 'delete', $params); | |
161 | } | |
162 | else { | |
95c4e89e | 163 | throw new API_Exception('Only test orders can be deleted.'); |
5f44f698 | 164 | } |
95c4e89e | 165 | return civicrm_api3_create_success($result['values'], $params, 'Order', 'delete'); |
5f44f698 PN |
166 | } |
167 | ||
65f7f9f6 | 168 | /** |
9d8e81c8 | 169 | * Cancel an Order. |
65f7f9f6 PN |
170 | * |
171 | * @param array $params | |
172 | * Input parameters. | |
173 | * | |
174 | * @return array | |
175 | */ | |
176 | function civicrm_api3_order_cancel($params) { | |
177 | $contributionStatuses = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name'); | |
a5c7fd46 | 178 | $params['contribution_status_id'] = array_search('Cancelled', $contributionStatuses); |
65f7f9f6 | 179 | $result = civicrm_api3('Contribution', 'create', $params); |
9d8e81c8 PN |
180 | CRM_Contribute_BAO_Contribution::transitionComponents($params); |
181 | return civicrm_api3_create_success($result['values'], $params, 'Order', 'cancel'); | |
65f7f9f6 PN |
182 | } |
183 | ||
184 | /** | |
185 | * Adjust Metadata for Cancel action. | |
186 | * | |
187 | * The metadata is used for setting defaults, documentation & validation. | |
188 | * | |
189 | * @param array $params | |
190 | * Array of parameters determined by getfields. | |
191 | */ | |
192 | function _civicrm_api3_order_cancel_spec(&$params) { | |
cf8f0fff | 193 | $params['contribution_id'] = [ |
7c31ae57 | 194 | 'api.required' => 1, |
65f7f9f6 PN |
195 | 'title' => 'Contribution ID', |
196 | 'type' => CRM_Utils_Type::T_INT, | |
cf8f0fff | 197 | ]; |
65f7f9f6 PN |
198 | } |
199 | ||
b8644ae3 PN |
200 | /** |
201 | * Adjust Metadata for Create action. | |
202 | * | |
203 | * The metadata is used for setting defaults, documentation & validation. | |
204 | * | |
205 | * @param array $params | |
206 | * Array of parameters determined by getfields. | |
207 | */ | |
208 | function _civicrm_api3_order_create_spec(&$params) { | |
cf8f0fff | 209 | $params['contact_id'] = [ |
b8644ae3 PN |
210 | 'name' => 'contact_id', |
211 | 'title' => 'Contact ID', | |
212 | 'type' => CRM_Utils_Type::T_INT, | |
213 | 'api.required' => TRUE, | |
cf8f0fff CW |
214 | ]; |
215 | $params['total_amount'] = [ | |
b8644ae3 PN |
216 | 'name' => 'total_amount', |
217 | 'title' => 'Total Amount', | |
cf8f0fff | 218 | ]; |
785f03e2 | 219 | $params['financial_type_id'] = [ |
b8644ae3 PN |
220 | 'name' => 'financial_type_id', |
221 | 'title' => 'Financial Type', | |
222 | 'type' => CRM_Utils_Type::T_INT, | |
223 | 'api.required' => TRUE, | |
785f03e2 | 224 | 'table_name' => 'civicrm_contribution', |
225 | 'entity' => 'Contribution', | |
226 | 'bao' => 'CRM_Contribute_BAO_Contribution', | |
227 | 'pseudoconstant' => [ | |
228 | 'table' => 'civicrm_financial_type', | |
229 | 'keyColumn' => 'id', | |
230 | 'labelColumn' => 'name', | |
231 | ], | |
232 | ]; | |
b8644ae3 | 233 | } |
5f44f698 PN |
234 | |
235 | /** | |
236 | * Adjust Metadata for Delete action. | |
237 | * | |
238 | * The metadata is used for setting defaults, documentation & validation. | |
239 | * | |
240 | * @param array $params | |
241 | * Array of parameters determined by getfields. | |
242 | */ | |
243 | function _civicrm_api3_order_delete_spec(&$params) { | |
cf8f0fff | 244 | $params['contribution_id'] = [ |
5f44f698 PN |
245 | 'api.required' => TRUE, |
246 | 'title' => 'Contribution ID', | |
247 | 'type' => CRM_Utils_Type::T_INT, | |
cf8f0fff CW |
248 | ]; |
249 | $params['id']['api.aliases'] = ['contribution_id']; | |
5f44f698 | 250 | } |