3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
29 * This api exposes CiviCRM Pledge.
31 * @package CiviCRM_APIv3
35 * Create or updates an Pledge.
40 * Array containing 'is_error' to denote success or failure and details of the created pledge
41 * @throws \API_Exception
43 function civicrm_api3_pledge_create($params) {
44 _civicrm_api3_pledge_format_params($params, TRUE);
45 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params, 'Pledge');
51 * @param array $params
52 * Array included 'pledge_id' of pledge to delete.
56 function civicrm_api3_pledge_delete($params) {
57 if (CRM_Pledge_BAO_Pledge
::deletePledge($params['id'])) {
58 return civicrm_api3_create_success([
59 'id' => $params['id'],
60 ], $params, 'Pledge', 'delete');
63 return civicrm_api3_create_error('Could not delete pledge');
68 * Adjust metadata for pledge delete action.
70 * @param array $params
72 function _civicrm_api3_pledge_delete_spec(&$params) {
73 // set as not required as pledge_id also acceptable & no either/or std yet
74 $params['id']['api.aliases'] = ['pledge_id'];
78 * Adjust field specification specific to get requests.
80 * @param array $params
82 function _civicrm_api3_pledge_get_spec(&$params) {
83 $params['next_pay_date'] = [
84 'name' => 'next_pay_date',
86 'title' => 'Pledge Made',
90 $params['pledge_is_test']['api.default'] = 0;
91 $params['pledge_financial_type_id']['api.aliases'] = ['contribution_type_id', 'contribution_type'];
96 * Adjust field specification specific to get requests.
98 * @param array $params
100 function _civicrm_api3_pledge_create_spec(&$params) {
102 $required = ['contact_id', 'amount', 'installments', 'start_date', 'financial_type_id'];
103 foreach ($required as $required_field) {
104 $params[$required_field]['api.required'] = 1;
106 // @todo this can come from xml
107 $params['amount']['api.aliases'] = ['pledge_amount'];
108 $params['financial_type_id']['api.aliases'] = ['contribution_type_id', 'contribution_type'];
112 * Retrieve a set of pledges, given a set of input params.
114 * @param array $params
115 * Input parameters. Use interrogate for possible fields.
118 * array of pledges, if error an array with an error id and error message
120 function civicrm_api3_pledge_get($params) {
121 $mode = CRM_Contact_BAO_Query
::MODE_PLEDGE
;
123 list($dao, $query) = _civicrm_api3_get_query_object($params, $mode, 'Pledge');
126 while ($dao->fetch()) {
127 $pledge[$dao->pledge_id
] = $query->store($dao);
130 return civicrm_api3_create_success($pledge, $params, 'Pledge', 'get', $dao);
134 * Set default to not return test params.
136 function _civicrm_api3_pledge_get_defaults() {
137 return ['pledge_test' => 0];
141 * Legacy function to format pledge parameters.
143 * I removed a bunch of stuff no longer required from here but it still needs
145 * take the input parameter list as specified in the data model and
146 * convert it into the same format that we use in QF and BAO object
148 * @param array $values
149 * The reformatted properties that we can use internally.
151 function _civicrm_api3_pledge_format_params(&$values) {
153 // probably most of the below can be removed.... just needs a little more review
154 if (array_key_exists('original_installment_amount', $values)) {
155 $values['installment_amount'] = $values['original_installment_amount'];
156 //it seems it will only create correctly with BOTH installment amount AND pledge_installment_amount set
157 //pledge installment amount required for pledge payments
158 $values['pledge_original_installment_amount'] = $values['original_installment_amount'];
161 if (array_key_exists('pledge_original_installment_amount', $values)) {
162 $values['installment_amount'] = $values['pledge_original_installment_amount'];
165 if (empty($values['id'])) {
166 //at this point both should be the same so unset both if not set - passing in empty
167 //value causes crash rather creating new - do it before next section as null values ignored in 'switch'
168 unset($values['id']);
170 //if you have a single installment when creating & you don't set the pledge status (not a required field) then
171 //status id is left null for pledge payments in BAO
172 // so we are hacking in the addition of the pledge_status_id to pending here
173 if (empty($values['status_id']) && $values['installments'] == 1) {
174 $contributionStatus = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
175 $values['status_id'] = array_search('Pending', $contributionStatus);
178 if (empty($values['scheduled_date']) && array_key_exists('start_date', $values)) {
179 $values['scheduled_date'] = $values['start_date'];