api/v3/Contribution.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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 = array();
  46   _civicrm_api3_custom_format_params($params, $values, 'Contribution');
  47   $params = array_merge($params, $values);
  48
  49   if (!empty($params['id']) && !empty($params['contribution_status_id'])) {
  50     $error = array();
  51     //throw error for invalid status change such as setting completed back to pending
  52     //@todo this sort of validation belongs in the BAO not the API - if it is not an OK
  53     // action it needs to be blocked there. If it is Ok through a form it needs to be OK through the api
  54     CRM_Contribute_BAO_Contribution::checkStatusValidation(NULL, $params, $error);
  55     if (array_key_exists('contribution_status_id', $error)) {
  56       throw new API_Exception($error['contribution_status_id']);
  57     }
  58   }
  59   if (!empty($params['id']) && !empty($params['financial_type_id'])) {
  60     $error = array();
  61     CRM_Contribute_BAO_Contribution::checkFinancialTypeChange($params['financial_type_id'], $params['id'], $error);
  62     if (array_key_exists('financial_type_id', $error)) {
  63       throw new API_Exception($error['financial_type_id']);
  64     }
  65   }
  66   _civicrm_api3_contribution_create_legacy_support_45($params);
  67
  68   // Make sure tax calculation is handled via api.
  69   $params = CRM_Contribute_BAO_Contribution::checkTaxAmount($params);
  70
  71   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Contribution');
  72 }
  73
  74 /**
  75  * Adjust Metadata for Create action.
  76  *
  77  * The metadata is used for setting defaults, documentation & validation.
  78  *
  79  * @param array $params
  80  *   Array of parameters determined by getfields.
  81  */
  82 function _civicrm_api3_contribution_create_spec(&$params) {
  83   $params['contact_id']['api.required'] = 1;
  84   $params['total_amount']['api.required'] = 1;
  85   $params['payment_instrument_id']['api.aliases'] = array('payment_instrument');
  86   $params['receive_date']['api.default'] = 'now';
  87   $params['payment_processor'] = array(
  88     'name' => 'payment_processor',
  89     'title' => 'Payment Processor ID',
  90     'description' => 'ID of payment processor used for this contribution',
  91     // field is called payment processor - not payment processor id but can only be one id so
  92     // it seems likely someone will fix it up one day to be more consistent - lets alias it from the start
  93     'api.aliases' => array('payment_processor_id'),
  94     'type' => CRM_Utils_Type::T_INT,
  95   );
  96   $params['financial_type_id']['api.aliases'] = array('contribution_type_id', 'contribution_type');
  97   $params['financial_type_id']['api.required'] = 1;
  98   $params['note'] = array(
  99     'name' => 'note',
 100     'uniqueName' => 'contribution_note',
 101     'title' => 'note',
 102     'type' => 2,
 103     'description' => 'Associated Note in the notes table',
 104   );
 105   $params['soft_credit_to'] = array(
 106     'name' => 'soft_credit_to',
 107     'title' => 'Soft Credit contact ID (legacy)',
 108     'type' => 1,
 109     'description' => 'ID of Contact to be Soft credited to (deprecated - use contribution_soft api)',
 110     'FKClassName' => 'CRM_Contact_DAO_Contact',
 111   );
 112   $params['honor_contact_id'] = array(
 113     'name' => 'honor_contact_id',
 114     'title' => 'Honoree contact ID (legacy)',
 115     'type' => 1,
 116     'description' => 'ID of honoree contact (deprecated - use contribution_soft api)',
 117     'FKClassName' => 'CRM_Contact_DAO_Contact',
 118   );
 119   $params['honor_type_id'] = array(
 120     'name' => 'honor_type_id',
 121     'title' => 'Honoree Type (legacy)',
 122     'type' => 1,
 123     'description' => 'Type of honoree contact (deprecated - use contribution_soft api)',
 124     'pseudoconstant' => TRUE,
 125   );
 126   // note this is a recommended option but not adding as a default to avoid
 127   // creating unnecessary changes for the dev
 128   $params['skipRecentView'] = array(
 129     'name' => 'skipRecentView',
 130     'title' => 'Skip adding to recent view',
 131     'type' => CRM_Utils_Type::T_BOOLEAN,
 132     'description' => 'Do not add to recent view (setting this improves performance)',
 133   );
 134   $params['skipLineItem'] = array(
 135     'name' => 'skipLineItem',
 136     'title' => 'Skip adding line items',
 137     'type' => 1,
 138     'api.default' => 0,
 139     'description' => 'Do not add line items by default (if you wish to add your own)',
 140   );
 141   $params['batch_id'] = array(
 142     'title' => 'Batch',
 143     'type' => 1,
 144     'description' => 'Batch which relevant transactions should be added to',
 145   );
 146 }
 147
 148 /**
 149  * Support for schema changes made in 4.5.
 150  *
 151  * The main purpose of the API is to provide integrators a level of stability not provided by
 152  * the core code or schema - this means we have to provide support for api calls (where possible)
 153  * across schema changes.
 154  *
 155  * @param array $params
 156  */
 157 function _civicrm_api3_contribution_create_legacy_support_45(&$params) {
 158   //legacy soft credit handling - recommended approach is chaining
 159   if (!empty($params['soft_credit_to'])) {
 160     $params['soft_credit'][] = array(
 161       'contact_id'          => $params['soft_credit_to'],
 162       'amount'              => $params['total_amount'],
 163       'soft_credit_type_id' => CRM_Core_OptionGroup::getDefaultValue("soft_credit_type"),
 164     );
 165   }
 166   if (!empty($params['honor_contact_id'])) {
 167     $params['soft_credit'][] = array(
 168       'contact_id'          => $params['honor_contact_id'],
 169       'amount'              => $params['total_amount'],
 170       'soft_credit_type_id' => CRM_Utils_Array::value('honor_type_id', $params, CRM_Core_OptionGroup::getValue('soft_credit_type', 'in_honor_of', 'name')),
 171     );
 172   }
 173 }
 174
 175 /**
 176  * Delete a Contribution.
 177  *
 178  * @param array $params
 179  *   Input parameters.
 180  *
 181  * @return array
 182  */
 183 function civicrm_api3_contribution_delete($params) {
 184
 185   $contributionID = !empty($params['contribution_id']) ? $params['contribution_id'] : $params['id'];
 186   if (CRM_Contribute_BAO_Contribution::deleteContribution($contributionID)) {
 187     return civicrm_api3_create_success(array($contributionID => 1));
 188   }
 189   else {
 190     return civicrm_api3_create_error('Could not delete contribution');
 191   }
 192 }
 193
 194 /**
 195  * Modify metadata for delete action.
 196  *
 197  * Legacy support for contribution_id.
 198  *
 199  * @param array $params
 200  */
 201 function _civicrm_api3_contribution_delete_spec(&$params) {
 202   $params['id']['api.aliases'] = array('contribution_id');
 203 }
 204
 205 /**
 206  * Retrieve a set of contributions.
 207  *
 208  * @param array $params
 209  *  Input parameters.
 210  *
 211  * @return array
 212  *   Array of contributions, if error an array with an error id and error message
 213  */
 214 function civicrm_api3_contribution_get($params) {
 215
 216   $mode = CRM_Contact_BAO_Query::MODE_CONTRIBUTE;
 217   list($dao, $query) = _civicrm_api3_get_query_object($params, $mode, 'Contribution');
 218
 219   $contribution = array();
 220   while ($dao->fetch()) {
 221     //CRM-8662
 222     $contribution_details = $query->store($dao);
 223     $softContribution = CRM_Contribute_BAO_ContributionSoft::getSoftContribution($dao->contribution_id, TRUE);
 224     $contribution[$dao->contribution_id] = array_merge($contribution_details, $softContribution);
 225     // format soft credit for backward compatibility
 226     _civicrm_api3_format_soft_credit($contribution[$dao->contribution_id]);
 227   }
 228   return civicrm_api3_create_success($contribution, $params, 'Contribution', 'get', $dao);
 229 }
 230
 231 /**
 232  * This function is used to format the soft credit for backward compatibility.
 233  *
 234  * As of v4.4 we support multiple soft credit, so now contribution returns array with 'soft_credit' as key
 235  * but we still return first soft credit as a part of contribution array
 236  *
 237  * @param $contribution
 238  */
 239 function _civicrm_api3_format_soft_credit(&$contribution) {
 240   if (!empty($contribution['soft_credit'])) {
 241     $contribution['soft_credit_to'] = $contribution['soft_credit'][1]['contact_id'];
 242     $contribution['soft_credit_id'] = $contribution['soft_credit'][1]['soft_credit_id'];
 243   }
 244 }
 245
 246 /**
 247  * Adjust Metadata for Get action.
 248  *
 249  * The metadata is used for setting defaults, documentation & validation.
 250  *
 251  * @param array $params
 252  *   Array of parameters determined by getfields.
 253  */
 254 function _civicrm_api3_contribution_get_spec(&$params) {
 255   $params['contribution_test'] = array(
 256     'api.default' => 0,
 257     'type' => CRM_Utils_Type::T_BOOLEAN,
 258     'title' => 'Get Test Contributions?',
 259   );
 260   $params['financial_type_id']['api.aliases'] = array('contribution_type_id');
 261   $params['contact_id'] = $params['contribution_contact_id'];
 262   $params['contact_id']['api.aliases'] = array('contribution_contact_id');
 263   unset($params['contribution_contact_id']);
 264 }
 265
 266 /**
 267  * Legacy handling for contribution parameters.
 268  *
 269  * Take the input parameter list as specified in the data model and
 270  * convert it into the same format that we use in QF and BAO object.
 271  *
 272  * @param array $params
 273  *   property name/value  pairs to insert in new contact.
 274  * @param array $values
 275  *   The reformatted properties that we can use internally.
 276  *
 277  * @return array
 278  */
 279 function _civicrm_api3_contribute_format_params($params, &$values) {
 280   //legacy way of formatting from v2 api - v3 way is to define metadata & do it in the api layer
 281   _civicrm_api3_filter_fields_for_bao('Contribution', $params, $values);
 282   return array();
 283 }
 284
 285 /**
 286  * Adjust Metadata for Transact action.
 287  *
 288  * The metadata is used for setting defaults, documentation & validation.
 289  *
 290  * @param array $params
 291  *   Array of parameters determined by getfields.
 292  */
 293 function _civicrm_api3_contribution_transact_spec(&$params) {
 294   $fields = civicrm_api3('Contribution', 'getfields', array('action' => 'create'));
 295   $params = array_merge($params, $fields['values']);
 296   $params['receive_date']['api.default'] = 'now';
 297 }
 298
 299 /**
 300  * Process a transaction and record it against the contact.
 301  *
 302  * @param array $params
 303  *   Input parameters.
 304  *
 305  * @return array
 306  *   contribution of created or updated record (or a civicrm error)
 307  */
 308 function civicrm_api3_contribution_transact($params) {
 309   // Set some params specific to payment processing
 310   // @todo - fix this function - none of the results checked by civicrm_error would ever be an array with
 311   // 'is_error' set
 312   // also trxn_id is not saved.
 313   // but since there is no test it's not desirable to jump in & make the obvious changes.
 314   $params['payment_processor_mode'] = empty($params['is_test']) ? 'live' : 'test';
 315   $params['amount'] = $params['total_amount'];
 316   if (!isset($params['net_amount'])) {
 317     $params['net_amount'] = $params['amount'];
 318   }
 319   if (!isset($params['invoiceID']) && isset($params['invoice_id'])) {
 320     $params['invoiceID'] = $params['invoice_id'];
 321   }
 322
 323   // Some payment processors expect a unique invoice_id - generate one if not supplied
 324   $params['invoice_id'] = CRM_Utils_Array::value('invoice_id', $params, md5(uniqid(rand(), TRUE)));
 325
 326   $paymentProcessor = CRM_Financial_BAO_PaymentProcessor::getPayment($params['payment_processor'], $params['payment_processor_mode']);
 327   if (civicrm_error($paymentProcessor)) {
 328     return $paymentProcessor;
 329   }
 330
 331   $payment = CRM_Core_Payment::singleton($params['payment_processor_mode'], $paymentProcessor);
 332   if (civicrm_error($payment)) {
 333     return $payment;
 334   }
 335
 336   $transaction = $payment->doPayment($params);
 337
 338   $params['payment_instrument_id'] = CRM_Core_DAO::getFieldValue('CRM_Financial_DAO_PaymentProcessorType', $paymentProcessor['payment_processor_type_id'], 'payment_type') == 1 ? 'Credit Card' : 'Debit Card';
 339   return civicrm_api('Contribution', 'create', $params);
 340 }
 341
 342 /**
 343  * Send a contribution confirmation (receipt or invoice).
 344  *
 345  * The appropriate online template will be used (the existence of related objects
 346  * (e.g. memberships ) will affect this selection
 347  *
 348  * @param array $params
 349  *   Input parameters.
 350  *
 351  * @throws Exception
 352  */
 353 function civicrm_api3_contribution_sendconfirmation($params) {
 354   $contribution = new CRM_Contribute_BAO_Contribution();
 355   $contribution->id = $params['id'];
 356   if (!$contribution->find(TRUE)) {
 357     throw new Exception('Contribution does not exist');
 358   }
 359   $input = $ids = $cvalues = array('receipt_from_email' => $params['receipt_from_email']);
 360   $contribution->loadRelatedObjects($input, $ids, FALSE, TRUE);
 361   $contribution->composeMessageArray($input, $ids, $cvalues, FALSE, FALSE);
 362 }
 363
 364 /**
 365  * Adjust Metadata for sendconfirmation action.
 366  *
 367  * The metadata is used for setting defaults, documentation & validation.
 368  *
 369  * @param array $params
 370  *   Array of parameters determined by getfields.
 371  */
 372 function _civicrm_api3_contribution_sendconfirmation_spec(&$params) {
 373   $params['id'] = array(
 374     'api.required' => 1,
 375     'title' => 'Contribution ID',
 376     'type' => CRM_Utils_Type::T_INT,
 377   );
 378   $params['receipt_from_email'] = array(
 379     'api.required' => 1,
 380     'title' => 'From Email address (string) required until someone provides a patch :-)',
 381     'type' => CRM_Utils_Type::T_STRING,
 382   );
 383   $params['receipt_from_name'] = array(
 384     'title' => 'From Name (string)',
 385     'type' => CRM_Utils_Type::T_STRING,
 386   );
 387   $params['cc_receipt'] = array(
 388     'title' => 'CC Email address (string)',
 389     'type' => CRM_Utils_Type::T_STRING,
 390   );
 391   $params['bcc_receipt'] = array(
 392     'title' => 'BCC Email address (string)',
 393     'type' => CRM_Utils_Type::T_STRING,
 394   );
 395   $params['receipt_text'] = array(
 396     'title' => 'Message (string)',
 397     'type' => CRM_Utils_Type::T_STRING,
 398   );
 399 }
 400
 401 /**
 402  * Complete an existing (pending) transaction.
 403  *
 404  * This will update related entities (participant, membership, pledge etc)
 405  * and take any complete actions from the contribution page (e.g. send receipt).
 406  *
 407  * @todo - most of this should live in the BAO layer but as we want it to be an addition
 408  * to 4.3 which is already stable we should add it to the api layer & re-factor into the BAO layer later
 409  *
 410  * @param array $params
 411  *   Input parameters.
 412  *
 413  * @throws API_Exception
 414  *   Api result array.
 415  */
 416 function civicrm_api3_contribution_completetransaction(&$params) {
 417
 418   $input = $ids = array();
 419   $contribution = new CRM_Contribute_BAO_Contribution();
 420   $contribution->id = $params['id'];
 421   $contribution->find(TRUE);
 422   if (!$contribution->id == $params['id']) {
 423     throw new API_Exception('A valid contribution ID is required', 'invalid_data');
 424   }
 425   try {
 426     if (!$contribution->loadRelatedObjects($input, $ids, FALSE, TRUE)) {
 427       throw new API_Exception('failed to load related objects');
 428     }
 429     elseif ($contribution->contribution_status_id == CRM_Core_OptionGroup::getValue('contribution_status', 'Completed', 'name')) {
 430       throw new API_Exception(ts('Contribution already completed'));
 431     }
 432     $input['trxn_id'] = !empty($params['trxn_id']) ? $params['trxn_id'] : $contribution->trxn_id;
 433     $params = _ipn_process_transaction($params, $contribution, $input, $ids);
 434   }
 435   catch(Exception $e) {
 436     throw new API_Exception('failed to load related objects' . $e->getMessage() . "\n" . $e->getTraceAsString());
 437   }
 438 }
 439
 440 /**
 441  * Provide function metadata.
 442  *
 443  * @param array $params
 444  */
 445 function _civicrm_api3_contribution_completetransaction_spec(&$params) {
 446   $params['id'] = array(
 447     'title' => 'Contribution ID',
 448     'type' => CRM_Utils_Type::T_INT,
 449     'api.required' => TRUE,
 450   );
 451   $params['trxn_id'] = array(
 452     'title' => 'Transaction ID',
 453     'type' => CRM_Utils_Type::T_STRING,
 454   );
 455   $params['is_email_receipt'] = array(
 456     'title' => 'Send email Receipt?',
 457     'type' => CRM_Utils_Type::T_BOOLEAN,
 458   );
 459 }
 460
 461 /**
 462  * Complete an existing (pending) transaction.
 463  *
 464  * This will update related entities (participant, membership, pledge etc)
 465  * and take any complete actions from the contribution page (e.g. send receipt).
 466  *
 467  * @todo - most of this should live in the BAO layer but as we want it to be an addition
 468  * to 4.3 which is already stable we should add it to the api layer & re-factor into the BAO layer later
 469  *
 470  * @param array $params
 471  *   Input parameters.
 472  *
 473  * @throws API_Exception
 474  *   Api result array.
 475  */
 476 function civicrm_api3_contribution_repeattransaction(&$params) {
 477   $input = $ids = array();
 478   $contribution = new CRM_Contribute_BAO_Contribution();
 479   $contribution->id = $params['original_contribution_id'];
 480   if (!$contribution->find(TRUE)) {
 481     throw new API_Exception(
 482       'A valid original contribution ID is required', 'invalid_data');
 483   }
 484   $original_contribution = clone $contribution;
 485   try {
 486     if (!$contribution->loadRelatedObjects($input, $ids, FALSE, TRUE)) {
 487       throw new API_Exception('failed to load related objects');
 488     }
 489
 490     unset($contribution->id, $contribution->receive_date, $contribution->invoice_id);
 491     $contribution->contribution_status_id = $params['contribution_status_id'];
 492     $contribution->receive_date = $params['receive_date'];
 493     // Have not set trxn_id to required but an e-notice if not provided seems appropriate.
 494     $input['trxn_id'] = $params['trxn_id'];
 495
 496     $params = _ipn_process_transaction($params, $contribution, $input, $ids, $original_contribution);
 497   }
 498   catch(Exception $e) {
 499     throw new API_Exception('failed to load related objects' . $e->getMessage() . "\n" . $e->getTraceAsString());
 500   }
 501 }
 502
 503 /**
 504  * Calls IPN complete transaction for completing or repeating a transaction.
 505  *
 506  * The IPN function is overloaded with two purposes - this is simply a wrapper for that
 507  * when separating them in the api layer.
 508  *
 509  * @param array $params
 510  * @param CRM_Contribute_BAO_Contribution $contribution
 511  * @param array $input
 512  *
 513  * @param array $ids
 514  *
 515  * @param CRM_Contribute_BAO_Contribution $firstContribution
 516  *
 517  * @return mixed
 518  */
 519 function _ipn_process_transaction(&$params, $contribution, $input, $ids, $firstContribution = NULL) {
 520   $objects = $contribution->_relatedObjects;
 521   $objects['contribution'] = &$contribution;
 522
 523   if ($firstContribution) {
 524     $objects['first_contribution'] = $firstContribution;
 525   }
 526   $input['component'] = $contribution->_component;
 527   $input['is_test'] = $contribution->is_test;
 528   $input['amount'] = $contribution->total_amount;
 529   if (isset($params['is_email_receipt'])) {
 530     $input['is_email_receipt'] = $params['is_email_receipt'];
 531   }
 532   // @todo required for base ipn but problematic as api layer handles this
 533   $transaction = new CRM_Core_Transaction();
 534   $ipn = new CRM_Core_Payment_BaseIPN();
 535   $ipn->completeTransaction($input, $ids, $objects, $transaction, !empty($contribution->contribution_recur_id));
 536   return $params;
 537 }
 538
 539 /**
 540  * Provide function metadata.
 541  *
 542  * @param array $params
 543  */
 544 function _civicrm_api3_contribution_repeattransaction_spec(&$params) {
 545   $params['original_contribution_id'] = array(
 546     'title' => 'Original Contribution ID',
 547     'type' => CRM_Utils_Type::T_INT,
 548     'api.required' => TRUE,
 549   );
 550   $params['trxn_id'] = array(
 551     'title' => 'Transaction ID',
 552     'type' => CRM_Utils_Type::T_STRING,
 553   );
 554   $params['is_email_receipt'] = array(
 555     'title' => 'Send email Receipt?',
 556     'type' => CRM_Utils_Type::T_BOOLEAN,
 557   );
 558   $params['contribution_status_id'] = array(
 559     'title' => 'Contribution Status ID',
 560     'name' => 'contribution_status_id',
 561     'type' => CRM_Utils_Type::T_INT,
 562     'pseudoconstant' => array(
 563       'optionGroupName' => 'contribution_status',
 564     ),
 565     'api.required' => TRUE,
 566   );
 567   $params['receive_date'] = array(
 568     'title' => 'Contribution Receive Date',
 569     'name' => 'receive_date',
 570     'type' => CRM_Utils_Type::T_DATE,
 571     'api.default' => 'now',
 572   );
 573   $params['trxn_id'] = array(
 574     'title' => 'Transaction ID',
 575     'name' => 'trxn_id',
 576     'type' => CRM_Utils_Type::T_STRING,
 577   );
 578   $params['payment_processor_id'] = array(
 579     'description' => ts('Payment processor ID, will be loaded from contribution_recur if not provided'),
 580     'title' => 'Payment processor ID',
 581     'name' => 'payment_processor_id',
 582     'type' => CRM_Utils_Type::T_INT,
 583   );
 584 }