3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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 * File for the CiviCRM APIv3 Pledge functions
31 * @package CiviCRM_APIv3
32 * @subpackage API_Pledge
34 * @copyright CiviCRM LLC (c) 2004-2014
35 * @version $Id: Pledge.php
40 * Include utility functions
44 * Creates or updates an Activity. See the example for usage
46 * @param array $params
47 * Associative array of property name/value.
48 * pairs for the activity.
49 * {@getfields pledge_create}
52 * Array containing 'is_error' to denote success or failure and details of the created pledge
54 * @example PledgeCreate.php Standard create example
57 function civicrm_api3_pledge_create($params) {
58 _civicrm_api3_pledge_format_params($params, TRUE);
60 //format the custom fields
61 _civicrm_api3_custom_format_params($params, $values, 'Pledge');
62 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $values);
68 * @param array $params
69 * Array included 'pledge_id' of pledge to delete.
72 * true if success, else false
74 * {@getfields pledge_delete}
75 * @example PledgeDelete.php
78 function civicrm_api3_pledge_delete($params) {
79 if (CRM_Pledge_BAO_Pledge
::deletePledge($params['id'])) {
80 return civicrm_api3_create_success(array(
81 'id' => $params['id'],
82 ), $params, 'pledge', 'delete');
85 return civicrm_api3_create_error('Could not delete pledge');
90 * @param array $params
92 function _civicrm_api3_pledge_delete_spec(&$params) {
93 // set as not required as pledge_id also acceptable & no either/or std yet
94 $params['id']['api.aliases'] = array('pledge_id');
98 * return field specification specific to get requests
101 function _civicrm_api3_pledge_get_spec(&$params) {
102 $params['next_pay_date'] = array(
103 'name' => 'next_pay_date',
105 'title' => 'Pledge Made',
109 $params['pledge_is_test']['api.default'] = 0;
110 $params['pledge_financial_type_id']['api.aliases'] = array('contribution_type_id', 'contribution_type');
115 * return field specification specific to get requests
118 function _civicrm_api3_pledge_create_spec(&$params) {
120 $required = array('contact_id', 'amount', 'installments', 'start_date', 'financial_type_id');
121 foreach ($required as $required_field) {
122 $params[$required_field]['api.required'] = 1;
124 // @todo this can come from xml
125 $params['amount']['api.aliases'] = array('pledge_amount');
126 $params['financial_type_id']['api.aliases'] = array('contribution_type_id', 'contribution_type');
130 * Retrieve a set of pledges, given a set of input params
132 * @param array $params
133 * Input parameters. Use interrogate for possible fields.
136 * array of pledges, if error an array with an error id and error message
137 * {@getfields pledge_get}
138 * @example PledgeGet.php
141 function civicrm_api3_pledge_get($params) {
142 $mode = CRM_Contact_BAO_Query
::MODE_PLEDGE
;
145 list($dao, $query) = _civicrm_api3_get_query_object($params, $mode, $entity);
148 while ($dao->fetch()) {
149 $pledge[$dao->pledge_id
] = $query->store($dao);
152 return civicrm_api3_create_success($pledge, $params, 'pledge', 'get', $dao);
156 * Set default to not return test params
158 function _civicrm_api3_pledge_get_defaults() {
159 return array('pledge_test' => 0);
163 * Legacy function - I removed a bunch of stuff no longer required from here but it still needs
165 * take the input parameter list as specified in the data model and
166 * convert it into the same format that we use in QF and BAO object
168 * @param array $values
169 * The reformatted properties that we can use internally.
170 * @param bool $create
172 * @return array|CRM_Error
175 function _civicrm_api3_pledge_format_params(&$values, $create = FALSE) {
177 // probably most of the below can be removed.... just needs a little more review
178 if (array_key_exists('original_installment_amount', $values)) {
179 $values['installment_amount'] = $values['original_installment_amount'];
180 //it seems it will only create correctly with BOTH installment amount AND pledge_installment_amount set
181 //pledge installment amount required for pledge payments
182 $values['pledge_original_installment_amount'] = $values['original_installment_amount'];
185 if (array_key_exists('pledge_original_installment_amount', $values)) {
186 $values['installment_amount'] = $values['pledge_original_installment_amount'];
189 if (empty($values['id'])) {
190 //at this point both should be the same so unset both if not set - passing in empty
191 //value causes crash rather creating new - do it before next section as null values ignored in 'switch'
192 unset($values['id']);
194 //if you have a single installment when creating & you don't set the pledge status (not a required field) then
195 //status id is left null for pledge payments in BAO
196 // so we are hacking in the addition of the pledge_status_id to pending here
197 if (empty($values['status_id']) && $values['installments'] == 1) {
198 $contributionStatus = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
199 $values['status_id'] = array_search('Pending', $contributionStatus);
202 if (empty($values['scheduled_date']) && array_key_exists('start_date', $values)) {
203 $values['scheduled_date'] = $values['start_date'];