4 +--------------------------------------------------------------------+
5 | CiviCRM version 4.5 |
6 +--------------------------------------------------------------------+
7 | Copyright CiviCRM LLC (c) 2004-2014 |
8 +--------------------------------------------------------------------+
9 | This file is a part of CiviCRM. |
11 | CiviCRM is free software; you can copy, modify, and distribute it |
12 | under the terms of the GNU Affero General Public License |
13 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
15 | CiviCRM is distributed in the hope that it will be useful, but |
16 | WITHOUT ANY WARRANTY; without even the implied warranty of |
17 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
18 | See the GNU Affero General Public License for more details. |
20 | You should have received a copy of the GNU Affero General Public |
21 | License and the CiviCRM Licensing Exception along |
22 | with this program; if not, contact CiviCRM LLC |
23 | at info[AT]civicrm[DOT]org. If you have questions about the |
24 | GNU Affero General Public License or the licensing of CiviCRM, |
25 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
26 +--------------------------------------------------------------------+
30 * File for the CiviCRM APIv3 Contribution functions
32 * @package CiviCRM_APIv3
33 * @subpackage API_Contribute
35 * @copyright CiviCRM LLC (c) 2004-2014
36 * @version $Id: Contribution.php 30486 2010-11-02 16:12:09Z shot $
41 * Add or update a contribution
43 * @param array $params (reference ) input parameters
45 * @throws API_Exception
46 * @return array Api result array
49 * @example ContributionCreate.php
50 * {@getfields Contribution_create}
52 function civicrm_api3_contribution_create(&$params) {
54 _civicrm_api3_custom_format_params($params, $values, 'Contribution');
55 $params = array_merge($params, $values);
57 //legacy soft credit handling - recommended approach is chaining
58 if(!empty($params['soft_credit_to'])){
59 $params['soft_credit'] = array(array(
60 'contact_id' => $params['soft_credit_to'],
61 'amount' => $params['total_amount']));
64 if (!empty($params['id']) && !empty($params['contribution_status_id'])) {
66 //throw error for invalid status change such as setting completed back to pending
67 //@todo this sort of validation belongs in the BAO not the API - if it is not an OK
68 // action it needs to be blocked there. If it is Ok through a form it needs to be OK through the api
69 CRM_Contribute_BAO_Contribution
::checkStatusValidation(NULL, $params, $error);
70 if (array_key_exists('contribution_status_id', $error)) {
71 throw new API_Exception($error['contribution_status_id']);
74 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params, 'Contribution');
78 * Adjust Metadata for Create action
80 * The metadata is used for setting defaults, documentation & validation
81 * @param array $params array or parameters determined by getfields
83 function _civicrm_api3_contribution_create_spec(&$params) {
84 $params['contact_id']['api.required'] = 1;
85 $params['total_amount']['api.required'] = 1;
86 $params['payment_instrument_id']['api.aliases'] = array('payment_instrument');
87 $params['receive_date']['api.default'] = 'now';
88 $params['payment_processor'] = array(
89 'name' => 'payment_processor',
90 'title' => 'Payment Processor ID',
91 'description' => 'ID of payment processor used for this contribution',
92 // field is called payment processor - not payment processor id but can only be one id so
93 // it seems likely someone will fix it up one day to be more consistent - lets alias it from the start
94 'api.aliases' => array('payment_processor_id'),
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(
100 'uniqueName' => 'contribution_note',
103 'description' => 'Associated Note in the notes table',
105 $params['soft_credit_to'] = array(
106 'name' => 'soft_credit_to',
107 'title' => 'Soft Credit contact ID',
109 'description' => 'ID of Contact to be Soft credited to',
110 'FKClassName' => 'CRM_Contact_DAO_Contact',
112 // note this is a recommended option but not adding as a default to avoid
113 // creating unecessary changes for the dev
114 $params['skipRecentView'] = array(
115 'name' => 'skipRecentView',
116 'title' => 'Skip adding to recent view',
117 'type' => CRM_Utils_Type
::T_BOOLEAN
,
118 'description' => 'Do not add to recent view (setting this improves performance)',
120 $params['skipLineItem'] = array(
121 'name' => 'skipLineItem',
122 'title' => 'Skip adding line items',
125 'description' => 'Do not add line items by default (if you wish to add your own)',
127 $params['batch_id'] = array(
130 'description' => 'Batch which relevant transactions should be added to',
135 * Delete a contribution
137 * @param array $params (reference ) input parameters
139 * @return boolean true if success, else false
142 * {@getfields Contribution_delete}
143 * @example ContributionDelete.php
145 function civicrm_api3_contribution_delete($params) {
147 $contributionID = !empty($params['contribution_id']) ?
$params['contribution_id'] : $params['id'];
148 if (CRM_Contribute_BAO_Contribution
::deleteContribution($contributionID)) {
149 return civicrm_api3_create_success(array($contributionID => 1));
152 return civicrm_api3_create_error('Could not delete contribution');
157 * modify metadata. Legacy support for contribution_id
159 function _civicrm_api3_contribution_delete_spec(&$params) {
160 $params['id']['api.aliases'] = array('contribution_id');
164 * Retrieve a set of contributions, given a set of input params
166 * @param array $params (reference ) input parameters
168 * @internal param array $returnProperties Which properties should be included in the
169 * returned Contribution object. If NULL, the default
170 * set of properties will be included.
172 * @return array (reference ) array of contributions, if error an array with an error id and error message
175 * {@getfields Contribution_get}
176 * @example ContributionGet.php
178 function civicrm_api3_contribution_get($params) {
180 $mode = CRM_Contact_BAO_Query
::MODE_CONTRIBUTE
;
181 $entity = 'contribution';
182 list($dao, $query) = _civicrm_api3_get_query_object($params, $mode, $entity);
184 $contribution = array();
185 while ($dao->fetch()) {
187 $contribution_details = $query->store($dao);
188 $softContribution = CRM_Contribute_BAO_ContributionSoft
::getSoftContribution($dao->contribution_id
, TRUE);
189 $contribution[$dao->contribution_id
] = array_merge($contribution_details, $softContribution);
190 if(isset($contribution[$dao->contribution_id
]['financial_type_id'])){
191 $contribution[$dao->contribution_id
]['financial_type_id'] = $contribution[$dao->contribution_id
]['financial_type_id'];
193 // format soft credit for backward compatibility
194 _civicrm_api3_format_soft_credit($contribution[$dao->contribution_id
]);
196 return civicrm_api3_create_success($contribution, $params, 'contribution', 'get', $dao);
200 * This function is used to format the soft credit for backward compatibility
201 * as of v4.4 we support multiple soft credit, so now contribution returns array with 'soft_credit' as key
202 * but we still return first soft credit as a part of contribution array
204 function _civicrm_api3_format_soft_credit(&$contribution) {
205 if (!empty($contribution['soft_credit'])) {
206 $contribution['soft_credit_to'] = $contribution['soft_credit'][1]['contact_id'];
207 $contribution['soft_credit_id'] = $contribution['soft_credit'][1]['soft_credit_id'];
212 * Adjust Metadata for Get action
214 * The metadata is used for setting defaults, documentation & validation
215 * @param array $params array or parameters determined by getfields
217 function _civicrm_api3_contribution_get_spec(&$params) {
218 $params['contribution_test']['api.default'] = 0;
219 $params['financial_type_id']['api.aliases'] = array('contribution_type_id');
220 $params['contact_id'] = $params['contribution_contact_id'];
221 $params['contact_id']['api.aliases'] = array('contribution_contact_id');
222 unset($params['contribution_contact_id']);
226 * take the input parameter list as specified in the data model and
227 * convert it into the same format that we use in QF and BAO object
229 * @param array $params Associative array of property name/value
230 * pairs to insert in new contact.
231 * @param array $values The reformatted properties that we can use internally
234 * @param bool $create
236 * @return array|CRM_Error
239 function _civicrm_api3_contribute_format_params($params, &$values, $create = FALSE) {
240 //legacy way of formatting from v2 api - v3 way is to define metadata & do it in the api layer
241 _civicrm_api3_filter_fields_for_bao('Contribution', $params, $values);
246 * Adjust Metadata for Transact action
248 * The metadata is used for setting defaults, documentation & validation
249 * @param array $params array or parameters determined by getfields
251 function _civicrm_api3_contribution_transact_spec(&$params) {
252 // This function calls create, so should inherit create spec
253 _civicrm_api3_contribution_create_spec($params);
254 $params['receive_date']['api.default'] = 'now';
258 * Process a transaction and record it against the contact.
260 * @param array $params (reference ) input parameters
262 * @return array (reference ) contribution of created or updated record (or a civicrm error)
267 function civicrm_api3_contribution_transact($params) {
268 // Set some params specific to payment processing
269 $params['payment_processor_mode'] = empty($params['is_test']) ?
'live' : 'test';
270 $params['amount'] = $params['total_amount'];
271 if (!isset($params['net_amount'])) {
272 $params['net_amount'] = $params['amount'];
274 if (!isset($params['invoiceID']) && isset($params['invoice_id'])) {
275 $params['invoiceID'] = $params['invoice_id'];
278 $paymentProcessor = CRM_Financial_BAO_PaymentProcessor
::getPayment($params['payment_processor'], $params['payment_processor_mode']);
279 if (civicrm_error($paymentProcessor)) {
280 return $paymentProcessor;
283 $payment = CRM_Core_Payment
::singleton($params['payment_processor_mode'], $paymentProcessor);
284 if (civicrm_error($payment)) {
288 $transaction = $payment->doDirectPayment($params);
289 if (civicrm_error($transaction)) {
293 // but actually, $payment->doDirectPayment() doesn't return a
294 // CRM_Core_Error by itself
295 if (is_object($transaction) && get_class($transaction) == 'CRM_Core_Error') {
296 $errs = $transaction->getErrors();
298 $last_error = array_shift($errs);
299 return CRM_Core_Error
::createApiError($last_error['message']);
303 return civicrm_api('contribution', 'create', $params);
307 * Send a contribution confirmation (receipt or invoice)
308 * The appropriate online template will be used (the existence of related objects
309 * (e.g. memberships ) will affect this selection
311 * @param array $params input parameters
312 * {@getfields Contribution_sendconfirmation}
315 * @return array Api result array
319 function civicrm_api3_contribution_sendconfirmation($params) {
320 $contribution = new CRM_Contribute_BAO_Contribution();
321 $contribution->id
= $params['id'];
322 if (! $contribution->find(TRUE)) {
323 throw new Exception('Contribution does not exist');
325 $input = $ids = $cvalues = array('receipt_from_email' => $params['receipt_from_email']);
326 $contribution->loadRelatedObjects($input, $ids, FALSE, TRUE);
327 $contribution->composeMessageArray($input, $ids, $cvalues, FALSE, FALSE);
331 * Adjust Metadata for sendconfirmation action
333 * The metadata is used for setting defaults, documentation & validation
334 * @param array $params array or parameters determined by getfields
336 function _civicrm_api3_contribution_sendconfirmation_spec(&$params) {
337 $params['id'] = array(
339 'title' => 'Contribution ID'
341 $params['receipt_from_email'] = array(
343 'title' => 'From Email address (string) required until someone provides a patch :-)',
345 $params['receipt_from_name'] = array(
346 'title' => 'From Name (string)',
348 $params['cc_receipt'] = array(
349 'title' => 'CC Email address (string)',
351 $params['bcc_receipt'] = array(
352 'title' => 'BCC Email address (string)',
354 $params['receipt_text'] = array(
355 'title' => 'Message (string)',
360 * Complete an existing (pending) transaction, updating related entities (participant, membership, pledge etc)
361 * and taking any complete actions from the contribution page (e.g. send receipt)
363 * @todo - most of this should live in the BAO layer but as we want it to be an addition
364 * to 4.3 which is already stable we should add it to the api layer & re-factor into the BAO layer later
366 * @param array $params input parameters
367 * {@getfields Contribution_completetransaction}
369 * @throws API_Exception
370 * @return array Api result array
374 function civicrm_api3_contribution_completetransaction(&$params) {
376 $input = $ids = array();
377 $contribution = new CRM_Contribute_BAO_Contribution();
378 $contribution->id
= $params['id'];
379 $contribution->find(TRUE);
380 if(!$contribution->id
== $params['id']){
381 throw new API_Exception('A valid contribution ID is required', 'invalid_data');
384 if(!$contribution->loadRelatedObjects($input, $ids, FALSE, TRUE)){
385 throw new API_Exception('failed to load related objects');
387 elseif ($contribution->contribution_status_id
== CRM_Core_OptionGroup
::getValue('contribution_status', 'Completed', 'name')) {
388 throw new API_Exception(ts('Contribution already completed'));
390 $objects = $contribution->_relatedObjects
;
391 $objects['contribution'] = &$contribution;
392 $input['component'] = $contribution->_component
;
393 $input['is_test'] = $contribution->is_test
;
394 $input['trxn_id']= !empty($params['trxn_id']) ?
$params['trxn_id'] : $contribution->trxn_id
;
395 $input['amount'] = $contribution->total_amount
;
396 if(isset($params['is_email_receipt'])){
397 $input['is_email_receipt'] = $params['is_email_receipt'];
399 // @todo required for base ipn but problematic as api layer handles this
400 $transaction = new CRM_Core_Transaction();
401 $ipn = new CRM_Core_Payment_BaseIPN();
402 $ipn->completeTransaction($input, $ids, $objects, $transaction);
404 catch(Exception
$e) {
405 throw new API_Exception('failed to load related objects' . $e->getMessage() . "\n" . $e->getTraceAsString());
412 function _civicrm_api3_contribution_completetransaction(&$params) {
413 $params['id'] = array(
414 'title' => 'Contribution ID',
415 'type' => CRM_Utils_Type
::T_INT
,
416 'api.required' => TRUE,
418 $params['trxn_id'] = array(
419 'title' => 'Transaction ID',
420 'type' => CRM_Utils_Type
::T_STRING
,
422 $params['is_email_receipt'] = array(
423 'title' => 'Send email Receipt?',
424 'type' => CRM_Utils_Type
::T_BOOLEAN
,