3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
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 +--------------------------------------------------------------------+
29 * This api exposes CiviCRM Order objects, an abstract entity
30 * comprised of contributions and related line items.
32 * @package CiviCRM_APIv3
36 * Retrieve a set of Order.
38 * @param array $params
42 * Array of Order, if error an array with an error id and error message
44 function civicrm_api3_order_get($params) {
46 $params['api.line_item.get'] = ['qty' => ['<>' => 0]];
47 $isSequential = FALSE;
48 if (!empty($params['sequential'])) {
49 $params['sequential'] = 0;
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']);
60 $params['sequential'] = $isSequential;
61 return civicrm_api3_create_success($contributions, $params, 'Order', 'get');
65 * Adjust Metadata for Get action.
67 * The metadata is used for setting defaults, documentation & validation.
69 * @param array $params
70 * Array of parameters determined by getfields.
72 function _civicrm_api3_order_get_spec(&$params) {
73 $params['id']['api.aliases'] = ['order_id'];
74 $params['id']['title'] = ts('Contribution / Order ID');
78 * Add or update a Order.
80 * @param array $params
86 * @throws \CiviCRM_API3_Exception
87 * @throws API_Exception
89 function civicrm_api3_order_create($params) {
90 civicrm_api3_verify_one_mandatory($params, NULL, ['line_items', 'total_amount']);
93 $contributionStatus = CRM_Utils_Array
::value('contribution_status_id', $params);
94 if ($contributionStatus !== 'Pending' && 'Pending' !== CRM_Core_PseudoConstant
::getName('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $contributionStatus)) {
95 CRM_Core_Error
::deprecatedFunctionWarning("Creating a Order with a status other than pending is deprecated. Currently empty defaults to 'Completed' so as a transition not passing in 'Pending' is deprecated. You can chain payment creation e.g civicrm_api3('Order', 'create', ['blah' => 'blah', 'contribution_status_id' => 'Pending', 'api.Payment.create => ['total_amount' => 5]]");
98 if (!empty($params['line_items']) && is_array($params['line_items'])) {
100 CRM_Contribute_BAO_Contribution
::checkLineItems($params);
101 foreach ($params['line_items'] as $lineItems) {
102 $entityParams = CRM_Utils_Array
::value('params', $lineItems, []);
103 if (!empty($entityParams) && !empty($lineItems['line_item'])) {
104 $item = reset($lineItems['line_item']);
105 $entity = str_replace('civicrm_', '', $item['entity_table']);
108 if (in_array($entity, ['participant', 'membership'])) {
109 $entityParams['skipLineItem'] = TRUE;
110 if ($contributionStatus === 'Pending') {
111 $entityParams['status_id'] = ($entity === 'participant' ?
'Pending from incomplete transaction' : 'Pending');
113 $entityResult = civicrm_api3($entity, 'create', $entityParams);
114 $params['contribution_mode'] = $entity;
115 $entityIds[] = $params[$entity . '_id'] = $entityResult['id'];
116 foreach ($lineItems['line_item'] as &$items) {
117 $items['entity_id'] = $entityResult['id'];
124 if (empty($priceSetID)) {
125 $item = reset($lineItems['line_item']);
126 $priceSetID = civicrm_api3('PriceField', 'getvalue', [
127 'return' => 'price_set_id',
128 'id' => $item['price_field_id'],
130 $params['line_item'][$priceSetID] = [];
132 $params['line_item'][$priceSetID] = array_merge($params['line_item'][$priceSetID], $lineItems['line_item']);
135 $contributionParams = $params;
136 foreach ($contributionParams as $key => $value) {
137 // Unset chained keys so the code does not attempt to do this chaining twice.
138 // e.g if calling 'api.Payment.create' We want to finish creating the order first.
139 // it would probably be better to have a full whitelist of contributionParams
140 if (substr($key, 0, 3) === 'api') {
141 unset($contributionParams[$key]);
145 $contribution = civicrm_api3('Contribution', 'create', $contributionParams);
147 if ($entity && !empty($contribution['id'])) {
148 foreach ($entityIds as $entityId) {
150 'contribution_id' => $contribution['id'],
151 $entity . '_id' => $entityId,
153 // if entity is pledge then build pledge param
154 if ($entity == 'pledge') {
155 $paymentParams +
= $entityParams;
157 $payments = civicrm_api3($entity . '_payment', 'create', $paymentParams);
160 return civicrm_api3_create_success(CRM_Utils_Array
::value('values', $contribution), $params, 'Order', 'create');
166 * @param array $params
169 * @throws API_Exception
170 * @throws CiviCRM_API3_Exception
172 function civicrm_api3_order_delete($params) {
173 $contribution = civicrm_api3('Contribution', 'get', [
174 'return' => ['is_test'],
175 'id' => $params['id'],
177 if ($contribution['id'] && $contribution['values'][$contribution['id']]['is_test'] == TRUE) {
178 $result = civicrm_api3('Contribution', 'delete', $params);
181 throw new API_Exception('Only test orders can be deleted.');
183 return civicrm_api3_create_success($result['values'], $params, 'Order', 'delete');
189 * @param array $params
194 function civicrm_api3_order_cancel($params) {
195 $contributionStatuses = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
196 $params['contribution_status_id'] = array_search('Cancelled', $contributionStatuses);
197 $result = civicrm_api3('Contribution', 'create', $params);
198 CRM_Contribute_BAO_Contribution
::transitionComponents($params);
199 return civicrm_api3_create_success($result['values'], $params, 'Order', 'cancel');
203 * Adjust Metadata for Cancel action.
205 * The metadata is used for setting defaults, documentation & validation.
207 * @param array $params
208 * Array of parameters determined by getfields.
210 function _civicrm_api3_order_cancel_spec(&$params) {
211 $params['contribution_id'] = [
213 'title' => 'Contribution ID',
214 'type' => CRM_Utils_Type
::T_INT
,
219 * Adjust Metadata for Create action.
221 * The metadata is used for setting defaults, documentation & validation.
223 * @param array $params
224 * Array of parameters determined by getfields.
226 function _civicrm_api3_order_create_spec(&$params) {
227 $params['contact_id'] = [
228 'name' => 'contact_id',
229 'title' => 'Contact ID',
230 'type' => CRM_Utils_Type
::T_INT
,
231 'api.required' => TRUE,
233 $params['total_amount'] = [
234 'name' => 'total_amount',
235 'title' => 'Total Amount',
237 $params['financial_type_id'] = [
238 'name' => 'financial_type_id',
239 'title' => 'Financial Type',
240 'type' => CRM_Utils_Type
::T_INT
,
241 'api.required' => TRUE,
242 'table_name' => 'civicrm_contribution',
243 'entity' => 'Contribution',
244 'bao' => 'CRM_Contribute_BAO_Contribution',
245 'pseudoconstant' => [
246 'table' => 'civicrm_financial_type',
248 'labelColumn' => 'name',
254 * Adjust Metadata for Delete action.
256 * The metadata is used for setting defaults, documentation & validation.
258 * @param array $params
259 * Array of parameters determined by getfields.
261 function _civicrm_api3_order_delete_spec(&$params) {
262 $params['contribution_id'] = [
263 'api.required' => TRUE,
264 'title' => 'Contribution ID',
265 'type' => CRM_Utils_Type
::T_INT
,
267 $params['id']['api.aliases'] = ['contribution_id'];