api/v3/Order.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   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 /**
  29  * This api exposes CiviCRM Order objects, an abstract entity
  30  * comprised of contributions and related line items.
  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) {
  45   $contributions = [];
  46   $params['api.line_item.get'] = ['qty' => ['<>' => 0]];
  47   $isSequential = FALSE;
  48   if (!empty($params['sequential'])) {
  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 }
  63
  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
  77 /**
  78  * Add or update a Order.
  79  *
  80  * @param array $params
  81  *   Input parameters.
  82  *
  83  * @return array
  84  *   Api result array
  85  *
  86  * @throws \CiviCRM_API3_Exception
  87  * @throws API_Exception
  88  */
  89 function civicrm_api3_order_create($params) {
  90   civicrm_api3_verify_one_mandatory($params, NULL, ['line_items', 'total_amount']);
  91   $entity = NULL;
  92   $entityIds = [];
  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');
  96   }
  97   if (!empty($params['line_items']) && is_array($params['line_items'])) {
  98     $priceSetID = NULL;
  99     CRM_Contribute_BAO_Contribution::checkLineItems($params);
 100     foreach ($params['line_items'] as $lineItems) {
 101       $entityParams = CRM_Utils_Array::value('params', $lineItems, []);
 102       if (!empty($entityParams) && !empty($lineItems['line_item'])) {
 103         $item = reset($lineItems['line_item']);
 104         $entity = str_replace('civicrm_', '', $item['entity_table']);
 105       }
 106       if ($entityParams) {
 107         if (in_array($entity, ['participant', 'membership'])) {
 108           $entityParams['skipLineItem'] = TRUE;
 109           if ($contributionStatus === 'Pending') {
 110             $entityParams['status_id'] = ($entity === 'participant' ? 'Pending from incomplete transaction' : 'Pending');
 111           }
 112           $entityResult = civicrm_api3($entity, 'create', $entityParams);
 113           $params['contribution_mode'] = $entity;
 114           $entityIds[] = $params[$entity . '_id'] = $entityResult['id'];
 115           foreach ($lineItems['line_item'] as &$items) {
 116             $items['entity_id'] = $entityResult['id'];
 117           }
 118         }
 119         else {
 120           // pledge payment
 121         }
 122       }
 123       if (empty($priceSetID)) {
 124         $item = reset($lineItems['line_item']);
 125         $priceSetID = civicrm_api3('PriceField', 'getvalue', [
 126           'return' => 'price_set_id',
 127           'id' => $item['price_field_id'],
 128         ]);
 129         $params['line_item'][$priceSetID] = [];
 130       }
 131       $params['line_item'][$priceSetID] = array_merge($params['line_item'][$priceSetID], $lineItems['line_item']);
 132     }
 133   }
 134   $contribution = civicrm_api3('Contribution', 'create', $params);
 135   // add payments
 136   if ($entity && !empty($contribution['id'])) {
 137     foreach ($entityIds as $entityId) {
 138       $paymentParams = [
 139         'contribution_id' => $contribution['id'],
 140         $entity . '_id' => $entityId,
 141       ];
 142       // if entity is pledge then build pledge param
 143       if ($entity == 'pledge') {
 144         $paymentParams += $entityParams;
 145       }
 146       $payments = civicrm_api3($entity . '_payment', 'create', $paymentParams);
 147     }
 148   }
 149   return civicrm_api3_create_success(CRM_Utils_Array::value('values', $contribution), $params, 'Order', 'create');
 150 }
 151
 152 /**
 153  * Delete a Order.
 154  *
 155  * @param array $params
 156  *   Input parameters.
 157  * @return array
 158  * @throws API_Exception
 159  * @throws CiviCRM_API3_Exception
 160  */
 161 function civicrm_api3_order_delete($params) {
 162   $contribution = civicrm_api3('Contribution', 'get', [
 163     'return' => ['is_test'],
 164     'id' => $params['id'],
 165   ]);
 166   if ($contribution['id'] && $contribution['values'][$contribution['id']]['is_test'] == TRUE) {
 167     $result = civicrm_api3('Contribution', 'delete', $params);
 168   }
 169   else {
 170     throw new API_Exception('Only test orders can be deleted.');
 171   }
 172   return civicrm_api3_create_success($result['values'], $params, 'Order', 'delete');
 173 }
 174
 175 /**
 176  * Cancel an Order.
 177  *
 178  * @param array $params
 179  *   Input parameters.
 180  *
 181  * @return array
 182  */
 183 function civicrm_api3_order_cancel($params) {
 184   $contributionStatuses = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
 185   $params['contribution_status_id'] = array_search('Cancelled', $contributionStatuses);
 186   $result = civicrm_api3('Contribution', 'create', $params);
 187   CRM_Contribute_BAO_Contribution::transitionComponents($params);
 188   return civicrm_api3_create_success($result['values'], $params, 'Order', 'cancel');
 189 }
 190
 191 /**
 192  * Adjust Metadata for Cancel action.
 193  *
 194  * The metadata is used for setting defaults, documentation & validation.
 195  *
 196  * @param array $params
 197  *   Array of parameters determined by getfields.
 198  */
 199 function _civicrm_api3_order_cancel_spec(&$params) {
 200   $params['contribution_id'] = [
 201     'api.required' => 1,
 202     'title' => 'Contribution ID',
 203     'type' => CRM_Utils_Type::T_INT,
 204   ];
 205 }
 206
 207 /**
 208  * Adjust Metadata for Create action.
 209  *
 210  * The metadata is used for setting defaults, documentation & validation.
 211  *
 212  * @param array $params
 213  *   Array of parameters determined by getfields.
 214  */
 215 function _civicrm_api3_order_create_spec(&$params) {
 216   $params['contact_id'] = [
 217     'name' => 'contact_id',
 218     'title' => 'Contact ID',
 219     'type' => CRM_Utils_Type::T_INT,
 220     'api.required' => TRUE,
 221   ];
 222   $params['total_amount'] = [
 223     'name' => 'total_amount',
 224     'title' => 'Total Amount',
 225   ];
 226   $params['financial_type_id'] = [
 227     'name' => 'financial_type_id',
 228     'title' => 'Financial Type',
 229     'type' => CRM_Utils_Type::T_INT,
 230     'api.required' => TRUE,
 231     'table_name' => 'civicrm_contribution',
 232     'entity' => 'Contribution',
 233     'bao' => 'CRM_Contribute_BAO_Contribution',
 234     'pseudoconstant' => [
 235       'table' => 'civicrm_financial_type',
 236       'keyColumn' => 'id',
 237       'labelColumn' => 'name',
 238     ],
 239   ];
 240 }
 241
 242 /**
 243  * Adjust Metadata for Delete action.
 244  *
 245  * The metadata is used for setting defaults, documentation & validation.
 246  *
 247  * @param array $params
 248  *   Array of parameters determined by getfields.
 249  */
 250 function _civicrm_api3_order_delete_spec(&$params) {
 251   $params['contribution_id'] = [
 252     'api.required' => TRUE,
 253     'title' => 'Contribution ID',
 254     'type' => CRM_Utils_Type::T_INT,
 255   ];
 256   $params['id']['api.aliases'] = ['contribution_id'];
 257 }