/*
+--------------------------------------------------------------------+
- | CiviCRM version 4.4 |
+ | CiviCRM version 4.5 |
+--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2013 |
+ | Copyright CiviCRM LLC (c) 2004-2014 |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
* @package CiviCRM_APIv3
* @subpackage API_Contribute
*
- * @copyright CiviCRM LLC (c) 2004-2013
+ * @copyright CiviCRM LLC (c) 2004-2014
* @version $Id: Contribution.php 30486 2010-11-02 16:12:09Z shot $
*
*/
/**
* Add or update a contribution
*
- * @param array $params (reference ) input parameters
+ * @param array $params (reference ) input parameters
*
+ * @throws API_Exception
* @return array Api result array
* @static void
* @access public
_civicrm_api3_custom_format_params($params, $values, 'Contribution');
$params = array_merge($params, $values);
- //legacy soft credit handling - recommended approach is chaining
- if(!empty($params['soft_credit_to'])){
- $params['soft_credit'] = array(array(
- 'contact_id' => $params['soft_credit_to'],
- 'amount' => $params['total_amount']));
- }
-
- if (CRM_Utils_Array::value('id', $params) && CRM_Utils_Array::value('contribution_status_id', $params)) {
+ if (!empty($params['id']) && !empty($params['contribution_status_id'])) {
$error = array();
//throw error for invalid status change such as setting completed back to pending
//@todo this sort of validation belongs in the BAO not the API - if it is not an OK
throw new API_Exception($error['contribution_status_id']);
}
}
+
+ _civicrm_api3_contribution_create_legacy_support_45($params);
+
+ // make sure tax calculation is handled via api
+ $params = CRM_Contribute_BAO_Contribution::checkTaxAmount($params);
+
return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Contribution');
}
'description' => 'ID of Contact to be Soft credited to',
'FKClassName' => 'CRM_Contact_DAO_Contact',
);
+ $params['honor_contact_id'] = array(
+ 'name' => 'honor_contact_id',
+ 'title' => 'Honoree contact ID',
+ 'type' => 1,
+ 'description' => 'ID of honoree contact',
+ 'FKClassName' => 'CRM_Contact_DAO_Contact',
+ );
// note this is a recommended option but not adding as a default to avoid
- // creating unecessary changes for the dev
+ // creating unnecessary changes for the dev
$params['skipRecentView'] = array(
'name' => 'skipRecentView',
'title' => 'Skip adding to recent view',
);
}
+/**
+* Support for schema changes made in 4.5
+* The main purpose of the API is to provide integrators a level of stability not provided by
+* the core code or schema - this means we have to provide support for api calls (where possible)
+* across schema changes.
+*/
+function _civicrm_api3_contribution_create_legacy_support_45(&$params){
+ //legacy soft credit handling - recommended approach is chaining
+ if(!empty($params['soft_credit_to'])){
+ $params['soft_credit'] = array(array(
+ 'contact_id' => $params['soft_credit_to'],
+ 'amount' => $params['total_amount'],
+ 'soft_credit_type_id' => CRM_Core_OptionGroup::getDefaultValue("soft_credit_type")));
+ }
+ if(!empty($params['honor_contact_id'])){
+ $params['soft_credit'] = array(array(
+ 'contact_id' => $params['honor_contact_id'],
+ 'amount' => $params['total_amount'],
+ 'soft_credit_type_id' => CRM_Core_OptionGroup::getValue('soft_credit_type', 'in_honor_of', 'name')));
+ }
+}
+
/**
* Delete a contribution
*
*/
function civicrm_api3_contribution_delete($params) {
- $contributionID = CRM_Utils_Array::value('contribution_id', $params) ? $params['contribution_id'] : $params['id'];
+ $contributionID = !empty($params['contribution_id']) ? $params['contribution_id'] : $params['id'];
if (CRM_Contribute_BAO_Contribution::deleteContribution($contributionID)) {
return civicrm_api3_create_success(array($contributionID => 1));
}
/**
* Retrieve a set of contributions, given a set of input params
*
- * @param array $params (reference ) input parameters
- * @param array $returnProperties Which properties should be included in the
+ * @param array $params (reference ) input parameters
+ *
+ * @internal param array $returnProperties Which properties should be included in the
* returned Contribution object. If NULL, the default
* set of properties will be included.
*
*/
function _civicrm_api3_contribution_get_spec(&$params) {
$params['contribution_test']['api.default'] = 0;
+ $params['contribution_test']['title'] = 'Get Test Contributions?';
$params['financial_type_id']['api.aliases'] = array('contribution_type_id');
$params['contact_id'] = $params['contribution_contact_id'];
$params['contact_id']['api.aliases'] = array('contribution_contact_id');
* take the input parameter list as specified in the data model and
* convert it into the same format that we use in QF and BAO object
*
- * @param array $params Associative array of property name/value
+ * @param array $params Associative array of property name/value
* pairs to insert in new contact.
- * @param array $values The reformatted properties that we can use internally
+ * @param array $values The reformatted properties that we can use internally
* '
*
+ * @param bool $create
+ *
* @return array|CRM_Error
* @access public
*/
* @param array $params array or parameters determined by getfields
*/
function _civicrm_api3_contribution_transact_spec(&$params) {
- // This function calls create, so should inherit create spec
- _civicrm_api3_contribution_create_spec($params);
+ $fields = civicrm_api3('contribution', 'getfields', array('action' => 'create'));
+ $params = array_merge($params, $fields['values']);
$params['receive_date']['api.default'] = 'now';
}
$params['payment_instrument_id'] = CRM_Core_DAO::getFieldValue('CRM_Financial_DAO_PaymentProcessorType', $paymentProcessor['payment_processor_type_id'], 'payment_type') == 1 ? 'Credit Card' : 'Debit Card';
return civicrm_api('contribution', 'create', $params);
}
+
/**
* Send a contribution confirmation (receipt or invoice)
* The appropriate online template will be used (the existence of related objects
* (e.g. memberships ) will affect this selection
+ *
* @param array $params input parameters
* {@getfields Contribution_sendconfirmation}
+ *
+ * @throws Exception
* @return array Api result array
* @static void
* @access public
- *
*/
function civicrm_api3_contribution_sendconfirmation($params) {
$contribution = new CRM_Contribute_BAO_Contribution();
*
* @param array $params input parameters
* {@getfields Contribution_completetransaction}
+ *
+ * @throws API_Exception
* @return array Api result array
* @static void
* @access public
- *
*/
function civicrm_api3_contribution_completetransaction(&$params) {
if(!$contribution->loadRelatedObjects($input, $ids, FALSE, TRUE)){
throw new API_Exception('failed to load related objects');
}
+ elseif ($contribution->contribution_status_id == CRM_Core_OptionGroup::getValue('contribution_status', 'Completed', 'name')) {
+ throw new API_Exception(ts('Contribution already completed'));
+ }
$objects = $contribution->_relatedObjects;
$objects['contribution'] = &$contribution;
$input['component'] = $contribution->_component;
// @todo required for base ipn but problematic as api layer handles this
$transaction = new CRM_Core_Transaction();
$ipn = new CRM_Core_Payment_BaseIPN();
- $ipn->completeTransaction($input, $ids, $objects, $transaction);
+ $ipn->completeTransaction($input, $ids, $objects, $transaction, !empty($contribution->contribution_recur_id));
}
catch(Exception $e) {
throw new API_Exception('failed to load related objects' . $e->getMessage() . "\n" . $e->getTraceAsString());
}
}
-function _civicrm_api3_contribution_completetransaction(&$params) {
+/**
+ * provide function metadata
+ * @param $params
+ */
+function _civicrm_api3_contribution_completetransaction_spec(&$params) {
$params['id'] = array(
'title' => 'Contribution ID',
'type' => CRM_Utils_Type::T_INT,
projects / civicrm-core.git / blobdiff