/*
+--------------------------------------------------------------------+
- | 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
'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
$params['contact_id']['api.required'] = 1;
$params['total_amount']['api.required'] = 1;
$params['payment_instrument_id']['api.aliases'] = array('payment_instrument');
+ $params['receive_date']['api.default'] = 'now';
$params['payment_processor'] = array(
'name' => 'payment_processor',
'title' => 'Payment Processor ID',
'api.default' => 0,
'description' => 'Do not add line items by default (if you wish to add your own)',
);
+ $params['batch_id'] = array(
+ 'title' => 'Batch',
+ 'type' => 1,
+ 'description' => 'Batch which relevant transactions should be added to',
+ );
}
/**
*/
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($params) {
- $options = _civicrm_api3_get_options_from_params($params, TRUE,'contribution','get');
- $sort = CRM_Utils_Array::value('sort', $options, NULL);
- $offset = CRM_Utils_Array::value('offset', $options);
- $rowCount = CRM_Utils_Array::value('limit', $options);
- $smartGroupCache = CRM_Utils_Array::value('smartGroupCache', $params);
- $inputParams = CRM_Utils_Array::value('input_params', $options, array());
- $returnProperties = CRM_Utils_Array::value('return', $options, NULL);
- if (empty($returnProperties)) {
- $returnProperties = CRM_Contribute_BAO_Query::defaultReturnProperties(CRM_Contact_BAO_Query::MODE_CONTRIBUTE);
- }
-
- $newParams = CRM_Contact_BAO_Query::convertFormValues($inputParams);
- $query = new CRM_Contact_BAO_Query($newParams, $returnProperties, NULL,
- FALSE, FALSE, CRM_Contact_BAO_Query::MODE_CONTRIBUTE
- );
- list($select, $from, $where, $having) = $query->query();
-
- $sql = "$select $from $where $having";
-
- if (!empty($sort)) {
- $sql .= " ORDER BY $sort ";
- }
- $sql .= " LIMIT $offset, $rowCount ";
- $dao = CRM_Core_DAO::executeQuery($sql);
+ $mode = CRM_Contact_BAO_Query::MODE_CONTRIBUTE;
+ $entity = 'contribution';
+ list($dao, $query) = _civicrm_api3_get_query_object($params, $mode, $entity);
$contribution = array();
while ($dao->fetch()) {
* 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
*/
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) {
$objects['contribution'] = &$contribution;
$input['component'] = $contribution->_component;
$input['is_test'] = $contribution->is_test;
- $input['trxn_id']= $contribution->trxn_id;
+ $input['trxn_id']= !empty($params['trxn_id']) ? $params['trxn_id'] : $contribution->trxn_id;
$input['amount'] = $contribution->total_amount;
if(isset($params['is_email_receipt'])){
$input['is_email_receipt'] = $params['is_email_receipt'];
}
}
+/**
+ * @param $params
+ */
function _civicrm_api3_contribution_completetransaction(&$params) {
-
+ $params['id'] = array(
+ 'title' => 'Contribution ID',
+ 'type' => CRM_Utils_Type::T_INT,
+ 'api.required' => TRUE,
+ );
+ $params['trxn_id'] = array(
+ 'title' => 'Transaction ID',
+ 'type' => CRM_Utils_Type::T_STRING,
+ );
+ $params['is_email_receipt'] = array(
+ 'title' => 'Send email Receipt?',
+ 'type' => CRM_Utils_Type::T_BOOLEAN,
+ );
}