api/v3/Contribution.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 Contribution records.
  30  *
  31  * @package CiviCRM_APIv3
  32  */
  33
  34 /**
  35  * Add or update a Contribution.
  36  *
  37  * @param array $params
  38  *   Input parameters.
  39  *
  40  * @throws API_Exception
  41  * @return array
  42  *   Api result array
  43  */
  44 function civicrm_api3_contribution_create($params) {
  45   $values = [];
  46   _civicrm_api3_custom_format_params($params, $values, 'Contribution');
  47   $params = array_merge($params, $values);
  48   // The BAO should not clean money - it should be done in the form layer & api wrapper
  49   // (although arguably the api should expect pre-cleaned it seems to do some cleaning.)
  50   if (empty($params['skipCleanMoney'])) {
  51     foreach (['total_amount', 'net_amount', 'fee_amount'] as $field) {
  52       if (isset($params[$field])) {
  53         $params[$field] = CRM_Utils_Rule::cleanMoney($params[$field]);
  54       }
  55     }
  56   }
  57   $params['skipCleanMoney'] = TRUE;
  58
  59   if (!empty($params['check_permissions']) && CRM_Financial_BAO_FinancialType::isACLFinancialTypeStatus()) {
  60     if (empty($params['id'])) {
  61       $op = CRM_Core_Action::ADD;
  62     }
  63     else {
  64       if (empty($params['financial_type_id'])) {
  65         $params['financial_type_id'] = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution', $params['id'], 'financial_type_id');
  66       }
  67       $op = CRM_Core_Action::UPDATE;
  68     }
  69     CRM_Financial_BAO_FinancialType::getAvailableFinancialTypes($types, $op);
  70     if (!in_array($params['financial_type_id'], array_keys($types))) {
  71       throw new API_Exception('You do not have permission to create this contribution');
  72     }
  73   }
  74   if (!empty($params['id']) && !empty($params['contribution_status_id'])) {
  75     $error = [];
  76     //throw error for invalid status change such as setting completed back to pending
  77     //@todo this sort of validation belongs in the BAO not the API - if it is not an OK
  78     // action it needs to be blocked there. If it is Ok through a form it needs to be OK through the api
  79     CRM_Contribute_BAO_Contribution::checkStatusValidation(NULL, $params, $error);
  80     if (array_key_exists('contribution_status_id', $error)) {
  81       throw new API_Exception($error['contribution_status_id']);
  82     }
  83   }
  84   if (!empty($params['id']) && !empty($params['financial_type_id'])) {
  85     $error = [];
  86     CRM_Contribute_BAO_Contribution::checkFinancialTypeChange($params['financial_type_id'], $params['id'], $error);
  87     if (array_key_exists('financial_type_id', $error)) {
  88       throw new API_Exception($error['financial_type_id']);
  89     }
  90   }
  91   _civicrm_api3_contribution_create_legacy_support_45($params);
  92
  93   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Contribution');
  94 }
  95
  96 /**
  97  * Adjust Metadata for Create action.
  98  *
  99  * The metadata is used for setting defaults, documentation & validation.
 100  *
 101  * @param array $params
 102  *   Array of parameters determined by getfields.
 103  */
 104 function _civicrm_api3_contribution_create_spec(&$params) {
 105   $params['contact_id']['api.required'] = 1;
 106   $params['total_amount']['api.required'] = 1;
 107   $params['payment_instrument_id']['api.aliases'] = ['payment_instrument'];
 108   $params['receive_date']['api.default'] = 'now';
 109   $params['receive_date']['api.required'] = TRUE;
 110   $params['payment_processor'] = [
 111     'name' => 'payment_processor',
 112     'title' => 'Payment Processor ID',
 113     'description' => 'ID of payment processor used for this contribution',
 114     // field is called payment processor - not payment processor id but can only be one id so
 115     // it seems likely someone will fix it up one day to be more consistent - lets alias it from the start
 116     'api.aliases' => ['payment_processor_id'],
 117     'type' => CRM_Utils_Type::T_INT,
 118   ];
 119   $params['financial_type_id']['api.aliases'] = ['contribution_type_id', 'contribution_type'];
 120   $params['financial_type_id']['api.required'] = 1;
 121   $params['note'] = [
 122     'name' => 'note',
 123     'uniqueName' => 'contribution_note',
 124     'title' => 'note',
 125     'type' => 2,
 126     'description' => 'Associated Note in the notes table',
 127   ];
 128   $params['soft_credit_to'] = [
 129     'name' => 'soft_credit_to',
 130     'title' => 'Soft Credit contact ID (legacy)',
 131     'type' => CRM_Utils_Type::T_INT,
 132     'description' => 'ID of Contact to be Soft credited to (deprecated - use contribution_soft api)',
 133     'FKClassName' => 'CRM_Contact_DAO_Contact',
 134   ];
 135   $params['honor_contact_id'] = [
 136     'name' => 'honor_contact_id',
 137     'title' => 'Honoree contact ID (legacy)',
 138     'type' => CRM_Utils_Type::T_INT,
 139     'description' => 'ID of honoree contact (deprecated - use contribution_soft api)',
 140     'FKClassName' => 'CRM_Contact_DAO_Contact',
 141   ];
 142   $params['honor_type_id'] = [
 143     'name' => 'honor_type_id',
 144     'title' => 'Honoree Type (legacy)',
 145     'type' => CRM_Utils_Type::T_INT,
 146     'description' => 'Type of honoree contact (deprecated - use contribution_soft api)',
 147     'pseudoconstant' => TRUE,
 148   ];
 149   // note this is a recommended option but not adding as a default to avoid
 150   // creating unnecessary changes for the dev
 151   $params['skipRecentView'] = [
 152     'name' => 'skipRecentView',
 153     'title' => 'Skip adding to recent view',
 154     'type' => CRM_Utils_Type::T_BOOLEAN,
 155     'description' => 'Do not add to recent view (setting this improves performance)',
 156   ];
 157   $params['skipLineItem'] = [
 158     'name' => 'skipLineItem',
 159     'title' => 'Skip adding line items',
 160     'type' => CRM_Utils_Type::T_BOOLEAN,
 161     'api.default' => 0,
 162     'description' => 'Do not add line items by default (if you wish to add your own)',
 163   ];
 164   $params['batch_id'] = [
 165     'title' => 'Batch',
 166     'type' => CRM_Utils_Type::T_INT,
 167     'description' => 'Batch which relevant transactions should be added to',
 168   ];
 169   $params['refund_trxn_id'] = [
 170     'title' => 'Refund Transaction ID',
 171     'type' => CRM_Utils_Type::T_STRING,
 172     'description' => 'Transaction ID specific to the refund taking place',
 173   ];
 174   $params['card_type_id'] = [
 175     'title' => 'Card Type ID',
 176     'description' => 'Providing Credit Card Type ID',
 177     'type' => CRM_Utils_Type::T_INT,
 178     'pseudoconstant' => [
 179       'optionGroupName' => 'accept_creditcard',
 180     ],
 181   ];
 182 }
 183
 184 /**
 185  * Support for schema changes made in 4.5.
 186  *
 187  * The main purpose of the API is to provide integrators a level of stability not provided by
 188  * the core code or schema - this means we have to provide support for api calls (where possible)
 189  * across schema changes.
 190  *
 191  * @param array $params
 192  */
 193 function _civicrm_api3_contribution_create_legacy_support_45(&$params) {
 194   //legacy soft credit handling - recommended approach is chaining
 195   if (!empty($params['soft_credit_to'])) {
 196     $params['soft_credit'][] = [
 197       'contact_id'          => $params['soft_credit_to'],
 198       'amount'              => $params['total_amount'],
 199       'soft_credit_type_id' => CRM_Core_OptionGroup::getDefaultValue("soft_credit_type"),
 200     ];
 201   }
 202   if (!empty($params['honor_contact_id'])) {
 203     $params['soft_credit'][] = [
 204       'contact_id'          => $params['honor_contact_id'],
 205       'amount'              => $params['total_amount'],
 206       'soft_credit_type_id' => CRM_Utils_Array::value('honor_type_id', $params, CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_ContributionSoft', 'soft_credit_type_id', 'in_honor_of')),
 207     ];
 208   }
 209 }
 210
 211 /**
 212  * Delete a Contribution.
 213  *
 214  * @param array $params
 215  *   Input parameters.
 216  *
 217  * @return array
 218  * @throws \API_Exception
 219  */
 220 function civicrm_api3_contribution_delete($params) {
 221
 222   $contributionID = !empty($params['contribution_id']) ? $params['contribution_id'] : $params['id'];
 223   // First check contribution financial type
 224   $financialType = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution', $contributionID, 'financial_type_id');
 225   // Now check permissioned lineitems & permissioned contribution
 226   if (!empty($params['check_permissions']) && CRM_Financial_BAO_FinancialType::isACLFinancialTypeStatus() &&
 227     (
 228       !CRM_Core_Permission::check('delete contributions of type ' . CRM_Contribute_PseudoConstant::financialType($financialType))
 229       || !CRM_Financial_BAO_FinancialType::checkPermissionedLineItems($contributionID, 'delete', FALSE)
 230     )
 231   ) {
 232     throw new API_Exception('You do not have permission to delete this contribution');
 233   }
 234   if (CRM_Contribute_BAO_Contribution::deleteContribution($contributionID)) {
 235     return civicrm_api3_create_success([$contributionID => 1]);
 236   }
 237   else {
 238     throw new API_Exception('Could not delete contribution');
 239   }
 240 }
 241
 242 /**
 243  * Modify metadata for delete action.
 244  *
 245  * Legacy support for contribution_id.
 246  *
 247  * @param array $params
 248  */
 249 function _civicrm_api3_contribution_delete_spec(&$params) {
 250   $params['id']['api.aliases'] = ['contribution_id'];
 251 }
 252
 253 /**
 254  * Retrieve a set of contributions.
 255  *
 256  * @param array $params
 257  *  Input parameters.
 258  *
 259  * @return array
 260  *   Array of contributions, if error an array with an error id and error message
 261  */
 262 function civicrm_api3_contribution_get($params) {
 263
 264   $mode = CRM_Contact_BAO_Query::MODE_CONTRIBUTE;
 265   $additionalOptions = _civicrm_api3_contribution_get_support_nonunique_returns($params);
 266   $returnProperties = CRM_Contribute_BAO_Query::defaultReturnProperties($mode);
 267
 268   // Get the contributions based on parameters passed in
 269   $contributions = _civicrm_api3_get_using_query_object('Contribution', $params, $additionalOptions, NULL, $mode, $returnProperties);
 270   if (!empty($contributions)) {
 271     $softContributions = CRM_Contribute_BAO_ContributionSoft::getSoftCreditContributionFields(array_keys($contributions), TRUE);
 272     foreach ($contributions as $id => $contribution) {
 273       $contributions[$id] = isset($softContributions[$id]) ? array_merge($contribution, $softContributions[$id]) : $contribution;
 274       // format soft credit for backward compatibility
 275       _civicrm_api3_format_soft_credit($contributions[$id]);
 276       _civicrm_api3_contribution_add_supported_fields($contributions[$id]);
 277     }
 278   }
 279   return civicrm_api3_create_success($contributions, $params, 'Contribution', 'get');
 280 }
 281
 282 /**
 283  * Fix the return values to reflect cases where the schema has been changed.
 284  *
 285  * At the query object level using uniquenames dismbiguates between tables.
 286  *
 287  * However, adding uniquename can change inputs accepted by the api, so we need
 288  * to ensure we are asking for the unique name return fields.
 289  *
 290  * @param array $params
 291  *
 292  * @return array
 293  * @throws \API_Exception
 294  */
 295 function _civicrm_api3_contribution_get_support_nonunique_returns($params) {
 296   $additionalOptions = [];
 297   $options = _civicrm_api3_get_options_from_params($params, TRUE);
 298   foreach (['check_number', 'address_id', 'cancel_date'] as $changedVariable) {
 299     if (isset($options['return']) && !empty($options['return'][$changedVariable])) {
 300       $additionalOptions['return']['contribution_' . $changedVariable] = 1;
 301     }
 302   }
 303   return $additionalOptions;
 304 }
 305
 306 /**
 307  * Support for supported output variables.
 308  *
 309  * @param $contribution
 310  */
 311 function _civicrm_api3_contribution_add_supported_fields(&$contribution) {
 312   // These are output fields that are supported in our test contract.
 313   // Arguably we should also do the same with 'campaign_id' &
 314   // 'source' - which are also fields being rendered with unique names.
 315   // That seems more consistent with other api where we output the actual field names.
 316   $outputAliases = [
 317     'contribution_check_number' => 'check_number',
 318     'contribution_address_id' => 'address_id',
 319     'payment_instrument_id' => 'instrument_id',
 320     'contribution_cancel_date' => 'cancel_date',
 321   ];
 322   foreach ($outputAliases as $returnName => $copyTo) {
 323     if (array_key_exists($returnName, $contribution)) {
 324       $contribution[$copyTo] = $contribution[$returnName];
 325     }
 326   }
 327
 328 }
 329
 330 /**
 331  * Get number of contacts matching the supplied criteria.
 332  *
 333  * @param array $params
 334  *
 335  * @return int
 336  */
 337 function civicrm_api3_contribution_getcount($params) {
 338   $count = _civicrm_api3_get_using_query_object('Contribution', $params, [], TRUE, CRM_Contact_BAO_Query::MODE_CONTRIBUTE);
 339   return (int) $count;
 340 }
 341
 342 /**
 343  * This function is used to format the soft credit for backward compatibility.
 344  *
 345  * As of v4.4 we support multiple soft credit, so now contribution returns array with 'soft_credit' as key
 346  * but we still return first soft credit as a part of contribution array
 347  *
 348  * @param $contribution
 349  */
 350 function _civicrm_api3_format_soft_credit(&$contribution) {
 351   if (!empty($contribution['soft_credit'])) {
 352     $contribution['soft_credit_to'] = $contribution['soft_credit'][1]['contact_id'];
 353     $contribution['soft_credit_id'] = $contribution['soft_credit'][1]['soft_credit_id'];
 354   }
 355 }
 356
 357 /**
 358  * Adjust Metadata for Get action.
 359  *
 360  * The metadata is used for setting defaults, documentation & validation.
 361  *
 362  * @param array $params
 363  *   Array of parameters determined by getfields.
 364  */
 365 function _civicrm_api3_contribution_get_spec(&$params) {
 366   $params['contribution_test'] = [
 367     'api.default' => 0,
 368     'type' => CRM_Utils_Type::T_BOOLEAN,
 369     'title' => 'Get Test Contributions?',
 370     'api.aliases' => ['is_test'],
 371   ];
 372
 373   $params['financial_type_id']['api.aliases'] = ['contribution_type_id'];
 374   $params['payment_instrument_id']['api.aliases'] = ['contribution_payment_instrument', 'payment_instrument'];
 375   $params['contact_id'] = CRM_Utils_Array::value('contribution_contact_id', $params);
 376   $params['contact_id']['api.aliases'] = ['contribution_contact_id'];
 377   $params['is_template']['api.default'] = 0;
 378   unset($params['contribution_contact_id']);
 379 }
 380
 381 /**
 382  * Legacy handling for contribution parameters.
 383  *
 384  * Take the input parameter list as specified in the data model and
 385  * convert it into the same format that we use in QF and BAO object.
 386  *
 387  * @param array $params
 388  *   property name/value  pairs to insert in new contact.
 389  * @param array $values
 390  *   The reformatted properties that we can use internally.
 391  *
 392  * @return array
 393  */
 394 function _civicrm_api3_contribute_format_params($params, &$values) {
 395   //legacy way of formatting from v2 api - v3 way is to define metadata & do it in the api layer
 396   _civicrm_api3_filter_fields_for_bao('Contribution', $params, $values);
 397   return [];
 398 }
 399
 400 /**
 401  * Send a contribution confirmation (receipt or invoice).
 402  *
 403  * The appropriate online template will be used (the existence of related objects
 404  * (e.g. memberships ) will affect this selection
 405  *
 406  * @param array $params
 407  *   Input parameters.
 408  *
 409  * @throws Exception
 410  */
 411 function civicrm_api3_contribution_sendconfirmation($params) {
 412   $ids = $values = [];
 413   $allowedParams = [
 414     'receipt_from_email',
 415     'receipt_from_name',
 416     'receipt_update',
 417     'cc_receipt',
 418     'bcc_receipt',
 419     'receipt_text',
 420     'payment_processor_id',
 421   ];
 422   $input = array_intersect_key($params, array_flip($allowedParams));
 423   $input['is_email_receipt'] = TRUE;
 424   CRM_Contribute_BAO_Contribution::sendMail($input, $ids, $params['id'], $values);
 425 }
 426
 427 /**
 428  * Adjust Metadata for sendconfirmation action.
 429  *
 430  * The metadata is used for setting defaults, documentation & validation.
 431  *
 432  * @param array $params
 433  *   Array of parameters determined by getfields.
 434  */
 435 function _civicrm_api3_contribution_sendconfirmation_spec(&$params) {
 436   $params['id'] = [
 437     'api.required' => 1,
 438     'title' => ts('Contribution ID'),
 439     'type' => CRM_Utils_Type::T_INT,
 440   ];
 441   $params['receipt_from_email'] = [
 442     'title' => ts('From Email address (string)'),
 443     'type' => CRM_Utils_Type::T_STRING,
 444   ];
 445   $params['receipt_from_name'] = [
 446     'title' => ts('From Name (string)'),
 447     'type' => CRM_Utils_Type::T_STRING,
 448   ];
 449   $params['cc_receipt'] = [
 450     'title' => ts('CC Email address (string)'),
 451     'type' => CRM_Utils_Type::T_STRING,
 452   ];
 453   $params['bcc_receipt'] = [
 454     'title' => ts('BCC Email address (string)'),
 455     'type' => CRM_Utils_Type::T_STRING,
 456   ];
 457   $params['receipt_text'] = [
 458     'title' => ts('Message (string)'),
 459     'type' => CRM_Utils_Type::T_STRING,
 460   ];
 461   $params['receipt_update'] = [
 462     'title' => ts('Update the Receipt Date'),
 463     'type' => CRM_Utils_Type::T_BOOLEAN,
 464     'api.default' => TRUE,
 465   ];
 466   $params['payment_processor_id'] = [
 467     'title' => ts('Payment processor Id (avoids mis-guesses)'),
 468     'type' => CRM_Utils_Type::T_INT,
 469   ];
 470 }
 471
 472 /**
 473  * Complete an existing (pending) transaction.
 474  *
 475  * This will update related entities (participant, membership, pledge etc)
 476  * and take any complete actions from the contribution page (e.g. send receipt).
 477  *
 478  * @todo - most of this should live in the BAO layer but as we want it to be an addition
 479  * to 4.3 which is already stable we should add it to the api layer & re-factor into the BAO layer later
 480  *
 481  * @param array $params
 482  *   Input parameters.
 483  *
 484  * @return array
 485  *   API result array
 486  * @throws \API_Exception
 487  * @throws \CRM_Core_Exception
 488  * @throws \Exception
 489  */
 490 function civicrm_api3_contribution_completetransaction($params) {
 491   $input = $ids = [];
 492   if (isset($params['payment_processor_id'])) {
 493     $input['payment_processor_id'] = $params['payment_processor_id'];
 494   }
 495   $contribution = new CRM_Contribute_BAO_Contribution();
 496   $contribution->id = $params['id'];
 497   if (!$contribution->find(TRUE)) {
 498     throw new API_Exception('A valid contribution ID is required', 'invalid_data');
 499   }
 500
 501   if (!$contribution->loadRelatedObjects($input, $ids, TRUE)) {
 502     throw new API_Exception('failed to load related objects');
 503   }
 504   elseif ($contribution->contribution_status_id == CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed')) {
 505     throw new API_Exception(ts('Contribution already completed'), 'contribution_completed');
 506   }
 507   $input['trxn_id'] = !empty($params['trxn_id']) ? $params['trxn_id'] : $contribution->trxn_id;
 508   if (!empty($params['fee_amount'])) {
 509     $input['fee_amount'] = $params['fee_amount'];
 510   }
 511   return _ipn_process_transaction($params, $contribution, $input, $ids);
 512
 513 }
 514
 515 /**
 516  * Provide function metadata.
 517  *
 518  * @param array $params
 519  */
 520 function _civicrm_api3_contribution_completetransaction_spec(&$params) {
 521   $params['id'] = [
 522     'title' => 'Contribution ID',
 523     'type' => CRM_Utils_Type::T_INT,
 524     'api.required' => TRUE,
 525   ];
 526   $params['trxn_id'] = [
 527     'title' => 'Transaction ID',
 528     'type' => CRM_Utils_Type::T_STRING,
 529   ];
 530   $params['is_email_receipt'] = [
 531     'title' => 'Send email Receipt?',
 532     'type' => CRM_Utils_Type::T_BOOLEAN,
 533   ];
 534   $params['receipt_from_email'] = [
 535     'title' => 'Email to send receipt from.',
 536     'description' => 'If not provided this will default to being based on domain mail or contribution page',
 537     'type' => CRM_Utils_Type::T_EMAIL,
 538   ];
 539   $params['receipt_from_name'] = [
 540     'title' => 'Name to send receipt from',
 541     'description' => '. If not provided this will default to domain mail or contribution page',
 542     'type' => CRM_Utils_Type::T_STRING,
 543   ];
 544   $params['payment_processor_id'] = [
 545     'title' => 'Payment processor ID',
 546     'description' => 'Providing this is strongly recommended, as not possible to calculate it accurately always',
 547     'type' => CRM_Utils_Type::T_INT,
 548   ];
 549   $params['fee_amount'] = [
 550     'title' => 'Fee charged on transaction',
 551     'description' => 'If a fee has been charged then the amount',
 552     'type' => CRM_Utils_Type::T_FLOAT,
 553   ];
 554   $params['trxn_date'] = [
 555     'title' => 'Transaction Date',
 556     'description' => 'Date this transaction occurred',
 557     'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME,
 558   ];
 559   $params['card_type_id'] = [
 560     'title' => 'Card Type ID',
 561     'description' => 'Providing Credit Card Type ID',
 562     'type' => CRM_Utils_Type::T_INT,
 563     'pseudoconstant' => [
 564       'optionGroupName' => 'accept_creditcard',
 565     ],
 566   ];
 567   // At some point we will deprecate this api in favour of calling payment create which will in turn call this
 568   // api if appropriate to transition related entities and send receipts - ie. financial responsibility should
 569   // not exist in completetransaction. For now we just need to allow payment.create to force a bypass on the
 570   // things it does itself.
 571   $params['is_post_payment_create'] = [
 572     'title' => 'Is this being called from payment create?',
 573     'type' => CRM_Utils_Type::T_BOOLEAN,
 574     'description' => 'The \'correct\' flow is to call payment.create for the financial side & for that to call completecontribution for the entity & receipt management. However, we need to still support completetransaction directly for legacy reasons',
 575   ];
 576 }
 577
 578 /**
 579  * Complete an existing (pending) transaction.
 580  *
 581  * This will update related entities (participant, membership, pledge etc)
 582  * and take any complete actions from the contribution page (e.g. send receipt).
 583  *
 584  * @todo - most of this should live in the BAO layer but as we want it to be an addition
 585  * to 4.3 which is already stable we should add it to the api layer & re-factor into the BAO layer later
 586  *
 587  * @param array $params
 588  *   Input parameters.
 589  *
 590  * @return array
 591  *   Api result array.
 592  * @throws API_Exception
 593  */
 594 function civicrm_api3_contribution_repeattransaction($params) {
 595   $input = $ids = [];
 596   civicrm_api3_verify_one_mandatory($params, NULL, ['contribution_recur_id', 'original_contribution_id']);
 597   if (empty($params['original_contribution_id'])) {
 598     //  CRM-19873 call with test mode.
 599     $params['original_contribution_id'] = civicrm_api3('contribution', 'getvalue', [
 600       'return' => 'id',
 601       'contribution_status_id' => ['IN' => ['Completed']],
 602       'contribution_recur_id' => $params['contribution_recur_id'],
 603       'contribution_test' => CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_ContributionRecur', $params['contribution_recur_id'], 'is_test'),
 604       'options' => ['limit' => 1, 'sort' => 'id DESC'],
 605     ]);
 606   }
 607   $contribution = new CRM_Contribute_BAO_Contribution();
 608   $contribution->id = $params['original_contribution_id'];
 609   if (!$contribution->find(TRUE)) {
 610     throw new API_Exception(
 611       'A valid original contribution ID is required', 'invalid_data');
 612   }
 613   $original_contribution = clone $contribution;
 614   $input['payment_processor_id'] = civicrm_api3('contributionRecur', 'getvalue', [
 615     'return' => 'payment_processor_id',
 616     'id' => $contribution->contribution_recur_id,
 617   ]);
 618   try {
 619     if (!$contribution->loadRelatedObjects($input, $ids, TRUE)) {
 620       throw new API_Exception('failed to load related objects');
 621     }
 622
 623     unset($contribution->id, $contribution->receive_date, $contribution->invoice_id);
 624     $contribution->receive_date = $params['receive_date'];
 625
 626     $passThroughParams = [
 627       'trxn_id',
 628       'total_amount',
 629       'campaign_id',
 630       'fee_amount',
 631       'financial_type_id',
 632       'contribution_status_id',
 633       'membership_id',
 634     ];
 635     $input = array_intersect_key($params, array_fill_keys($passThroughParams, NULL));
 636
 637     return _ipn_process_transaction($params, $contribution, $input, $ids, $original_contribution);
 638   }
 639   catch (Exception $e) {
 640     throw new API_Exception('failed to load related objects' . $e->getMessage() . "\n" . $e->getTraceAsString());
 641   }
 642 }
 643
 644 /**
 645  * Calls IPN complete transaction for completing or repeating a transaction.
 646  *
 647  * The IPN function is overloaded with two purposes - this is simply a wrapper for that
 648  * when separating them in the api layer.
 649  *
 650  * @param array $params
 651  * @param CRM_Contribute_BAO_Contribution $contribution
 652  * @param array $input
 653  *
 654  * @param array $ids
 655  *
 656  * @param CRM_Contribute_BAO_Contribution $firstContribution
 657  *
 658  * @return mixed
 659  */
 660 function _ipn_process_transaction(&$params, $contribution, $input, $ids, $firstContribution = NULL) {
 661   $objects = $contribution->_relatedObjects;
 662   $objects['contribution'] = &$contribution;
 663
 664   if ($firstContribution) {
 665     $objects['first_contribution'] = $firstContribution;
 666   }
 667   $input['component'] = $contribution->_component;
 668   $input['is_test'] = $contribution->is_test;
 669   $input['amount'] = empty($input['total_amount']) ? $contribution->total_amount : $input['total_amount'];
 670
 671   if (isset($params['is_email_receipt'])) {
 672     $input['is_email_receipt'] = $params['is_email_receipt'];
 673   }
 674   if (!empty($params['trxn_date'])) {
 675     $input['trxn_date'] = $params['trxn_date'];
 676   }
 677   if (!empty($params['receive_date'])) {
 678     $input['receive_date'] = $params['receive_date'];
 679   }
 680   if (empty($contribution->contribution_page_id)) {
 681     static $domainFromName;
 682     static $domainFromEmail;
 683     if (empty($domainFromEmail) && (empty($params['receipt_from_name']) || empty($params['receipt_from_email']))) {
 684       list($domainFromName, $domainFromEmail) = CRM_Core_BAO_Domain::getNameAndEmail(TRUE);
 685     }
 686     $input['receipt_from_name'] = CRM_Utils_Array::value('receipt_from_name', $params, $domainFromName);
 687     $input['receipt_from_email'] = CRM_Utils_Array::value('receipt_from_email', $params, $domainFromEmail);
 688   }
 689   $input['card_type_id'] = CRM_Utils_Array::value('card_type_id', $params);
 690   $input['pan_truncation'] = CRM_Utils_Array::value('pan_truncation', $params);
 691   $transaction = new CRM_Core_Transaction();
 692   return CRM_Contribute_BAO_Contribution::completeOrder($input, $ids, $objects, $transaction,
 693     !empty($contribution->contribution_recur_id), $contribution, CRM_Utils_Array::value('is_post_payment_create', $params));
 694 }
 695
 696 /**
 697  * Provide function metadata.
 698  *
 699  * @param array $params
 700  */
 701 function _civicrm_api3_contribution_repeattransaction_spec(&$params) {
 702   $params['original_contribution_id'] = [
 703     'title' => 'Original Contribution ID',
 704     'description' => 'Contribution ID to copy (will be calculated from recurring contribution if not provided)',
 705     'type' => CRM_Utils_Type::T_INT,
 706   ];
 707   $params['contribution_recur_id'] = [
 708     'title' => 'Recurring contribution ID',
 709     'type' => CRM_Utils_Type::T_INT,
 710   ];
 711   $params['trxn_id'] = [
 712     'title' => 'Transaction ID',
 713     'type' => CRM_Utils_Type::T_STRING,
 714   ];
 715   $params['is_email_receipt'] = [
 716     'title' => 'Send email Receipt?',
 717     'type' => CRM_Utils_Type::T_BOOLEAN,
 718   ];
 719   $params['contribution_status_id'] = [
 720     'title' => 'Contribution Status ID',
 721     'name' => 'contribution_status_id',
 722     'type' => CRM_Utils_Type::T_INT,
 723     'pseudoconstant' => [
 724       'optionGroupName' => 'contribution_status',
 725     ],
 726     'api.required' => TRUE,
 727   ];
 728   $params['receive_date'] = [
 729     'title' => 'Contribution Receive Date',
 730     'name' => 'receive_date',
 731     'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME,
 732     'api.default' => 'now',
 733   ];
 734   $params['trxn_id'] = [
 735     'title' => 'Transaction ID',
 736     'name' => 'trxn_id',
 737     'type' => CRM_Utils_Type::T_STRING,
 738   ];
 739   $params['campaign_id'] = [
 740     'title' => 'Campaign ID',
 741     'name' => 'campaign_id',
 742     'type' => CRM_Utils_Type::T_INT,
 743     'pseudoconstant' => [
 744       'table' => 'civicrm_campaign',
 745       'keyColumn' => 'id',
 746       'labelColumn' => 'title',
 747     ],
 748   ];
 749   $params['financial_type_id'] = [
 750     'title' => 'Financial ID (ignored if more than one line item)',
 751     'name' => 'financial_type_id',
 752     'type' => CRM_Utils_Type::T_INT,
 753     'pseudoconstant' => [
 754       'table' => 'civicrm_financial_type',
 755       'keyColumn' => 'id',
 756       'labelColumn' => 'name',
 757     ],
 758   ];
 759   $params['payment_processor_id'] = [
 760     'description' => ts('Payment processor ID, will be loaded from contribution_recur if not provided'),
 761     'title' => 'Payment processor ID',
 762     'name' => 'payment_processor_id',
 763     'type' => CRM_Utils_Type::T_INT,
 764   ];
 765 }
 766
 767 /**
 768  * Declare deprecated functions.
 769  *
 770  * @return array
 771  *   Array of deprecated actions
 772  */
 773 function _civicrm_api3_contribution_deprecation() {
 774   return ['transact' => 'Contribute.transact is ureliable & unsupported - see https://docs.civicrm.org/dev/en/latest/financial/OrderAPI/  for how to move on'];
 775 }