| 1 | <?php |
| 2 | |
| 3 | /* |
| 4 | +--------------------------------------------------------------------+ |
| 5 | | CiviCRM version 4.3 | |
| 6 | +--------------------------------------------------------------------+ |
| 7 | | Copyright CiviCRM LLC (c) 2004-2013 | |
| 8 | +--------------------------------------------------------------------+ |
| 9 | | This file is a part of CiviCRM. | |
| 10 | | | |
| 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. | |
| 14 | | | |
| 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. | |
| 19 | | | |
| 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 | +--------------------------------------------------------------------+ |
| 27 | */ |
| 28 | |
| 29 | /** |
| 30 | * File for the CiviCRM APIv3 Pledge functions |
| 31 | * |
| 32 | * @package CiviCRM_APIv3 |
| 33 | * @subpackage API_Pledge |
| 34 | * |
| 35 | * @copyright CiviCRM LLC (c) 2004-2013 |
| 36 | * @version $Id: Pledge.php |
| 37 | * |
| 38 | */ |
| 39 | |
| 40 | /** |
| 41 | * Include utility functions |
| 42 | */ |
| 43 | |
| 44 | /** |
| 45 | * Creates or updates an Activity. See the example for usage |
| 46 | * |
| 47 | * @param array $params Associative array of property name/value |
| 48 | * pairs for the activity. |
| 49 | * {@getfields pledge_create} |
| 50 | * |
| 51 | * @return array Array containing 'is_error' to denote success or failure and details of the created pledge |
| 52 | * |
| 53 | * @example PledgeCreate.php Standard create example |
| 54 | * |
| 55 | */ |
| 56 | function civicrm_api3_pledge_create($params) { |
| 57 | _civicrm_api3_pledge_format_params($params, TRUE); |
| 58 | $values = $params; |
| 59 | //format the custom fields |
| 60 | _civicrm_api3_custom_format_params($params, $values, 'Pledge'); |
| 61 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $values); |
| 62 | } |
| 63 | |
| 64 | /** |
| 65 | * Delete a pledge |
| 66 | * |
| 67 | * @param array $params array included 'pledge_id' of pledge to delete |
| 68 | * |
| 69 | * @return boolean true if success, else false |
| 70 | * @static void |
| 71 | * {@getfields pledge_delete} |
| 72 | * @example PledgeDelete.php |
| 73 | * @access public |
| 74 | */ |
| 75 | function civicrm_api3_pledge_delete($params) { |
| 76 | if (CRM_Pledge_BAO_Pledge::deletePledge($params['id'])) { |
| 77 | return civicrm_api3_create_success(array( |
| 78 | 'id' => $params['id'] |
| 79 | ), $params, 'pledge', 'delete'); |
| 80 | } |
| 81 | else { |
| 82 | return civicrm_api3_create_error('Could not delete pledge'); |
| 83 | } |
| 84 | } |
| 85 | |
| 86 | function _civicrm_api3_pledge_delete_spec(&$params) { |
| 87 | // set as not required as pledge_id also acceptable & no either/or std yet |
| 88 | $params['id']['api.aliases'] = array('pledge_id'); |
| 89 | } |
| 90 | |
| 91 | /** |
| 92 | * return field specification specific to get requests |
| 93 | */ |
| 94 | function _civicrm_api3_pledge_get_spec(&$params) { |
| 95 | $params['next_pay_date'] = array( |
| 96 | 'name' => 'next_pay_date', |
| 97 | 'type' => 12, |
| 98 | 'title' => 'Pledge Made', |
| 99 | 'api.filter' => 0, |
| 100 | 'api.return' => 1, |
| 101 | ); |
| 102 | $params['pledge_is_test']['api.default'] = 0; |
| 103 | $params['pledge_financial_type_id']['api.aliases'] = array('contribution_type_id', 'contribution_type'); |
| 104 | |
| 105 | } |
| 106 | |
| 107 | /** |
| 108 | * return field specification specific to get requests |
| 109 | */ |
| 110 | function _civicrm_api3_pledge_create_spec(&$params) { |
| 111 | |
| 112 | $required = array('contact_id', 'amount', 'installments', 'start_date', 'financial_type_id'); |
| 113 | foreach ($required as $required_field) { |
| 114 | $params[$required_field]['api.required'] = 1; |
| 115 | } |
| 116 | // @todo this can come from xml |
| 117 | $params['amount']['api.aliases'] = array('pledge_amount'); |
| 118 | $params['financial_type_id']['api.aliases'] = array('contribution_type_id', 'contribution_type'); |
| 119 | } |
| 120 | |
| 121 | /** |
| 122 | * Retrieve a set of pledges, given a set of input params |
| 123 | * |
| 124 | * @param array $params (reference ) input parameters. Use interogate for possible fields |
| 125 | * |
| 126 | * @return array (reference ) array of pledges, if error an array with an error id and error message |
| 127 | * {@getfields pledge_get} |
| 128 | * @example PledgeGet.php |
| 129 | * @access public |
| 130 | */ |
| 131 | function civicrm_api3_pledge_get($params) { |
| 132 | |
| 133 | $options = _civicrm_api3_get_options_from_params($params, TRUE, 'pledge','get'); |
| 134 | if (empty($options['return'])) { |
| 135 | $options['return'] = CRM_Pledge_BAO_Query::defaultReturnProperties(CRM_Contact_BAO_Query::MODE_PLEDGE); |
| 136 | } |
| 137 | else { |
| 138 | $options['return']['pledge_id'] = 1; |
| 139 | } |
| 140 | $newParams = CRM_Contact_BAO_Query::convertFormValues($options['input_params']); |
| 141 | $query = new CRM_Contact_BAO_Query($newParams, $options['return'], NULL, |
| 142 | FALSE, FALSE, CRM_Contact_BAO_Query::MODE_PLEDGE |
| 143 | ); |
| 144 | list($select, $from, $where) = $query->query(); |
| 145 | $sql = "$select $from $where"; |
| 146 | if (!empty($options['sort'])) { |
| 147 | $sql .= " ORDER BY " . $options['sort']; |
| 148 | } |
| 149 | $sql .= " LIMIT " . $options['offset'] . " , " . $options['limit']; |
| 150 | $dao = CRM_Core_DAO::executeQuery($sql); |
| 151 | $pledge = array(); |
| 152 | while ($dao->fetch()) { |
| 153 | $pledge[$dao->pledge_id] = $query->store($dao); |
| 154 | } |
| 155 | |
| 156 | return civicrm_api3_create_success($pledge, $params, 'pledge', 'get', $dao); |
| 157 | } |
| 158 | |
| 159 | /** |
| 160 | * Set default to not return test params |
| 161 | */ |
| 162 | function _civicrm_api3_pledge_get_defaults() { |
| 163 | return array('pledge_test' => 0); |
| 164 | } |
| 165 | |
| 166 | /** |
| 167 | * Legacy function - I removed a bunch of stuff no longer required from here but it still needs |
| 168 | * more culling |
| 169 | * take the input parameter list as specified in the data model and |
| 170 | * convert it into the same format that we use in QF and BAO object |
| 171 | * |
| 172 | * @param array $params Associative array of property name/value |
| 173 | * pairs to insert in new contact. |
| 174 | * @param array $values The reformatted properties that we can use internally |
| 175 | * ' |
| 176 | * |
| 177 | * @return array|CRM_Error |
| 178 | * @access public |
| 179 | */ |
| 180 | function _civicrm_api3_pledge_format_params(&$values, $create = FALSE) { |
| 181 | |
| 182 | // probably most of the below can be removed.... just needs a little more review |
| 183 | if (array_key_exists('original_installment_amount', $values)) { |
| 184 | $values['installment_amount'] = $values['original_installment_amount']; |
| 185 | //it seems it will only create correctly with BOTH installment amount AND pledge_installment_amount set |
| 186 | //pledge installment amount required for pledge payments |
| 187 | $values['pledge_original_installment_amount'] = $values['original_installment_amount']; |
| 188 | } |
| 189 | |
| 190 | if (array_key_exists('pledge_original_installment_amount', $values)) { |
| 191 | $values['installment_amount'] = $values['pledge_original_installment_amount']; |
| 192 | } |
| 193 | |
| 194 | if (empty($values['id'])) { |
| 195 | //at this point both should be the same so unset both if not set - passing in empty |
| 196 | //value causes crash rather creating new - do it before next section as null values ignored in 'switch' |
| 197 | unset($values['id']); |
| 198 | |
| 199 | //if you have a single installment when creating & you don't set the pledge status (not a required field) then |
| 200 | //status id is left null for pledge payments in BAO |
| 201 | // so we are hacking in the addition of the pledge_status_id to pending here |
| 202 | if (empty($values['status_id']) && $values['installments'] == 1) { |
| 203 | $contributionStatus = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name'); |
| 204 | $values['status_id'] = array_search('Pending', $contributionStatus); |
| 205 | } |
| 206 | } |
| 207 | if (empty($values['scheduled_date']) && array_key_exists('start_date', $values)) { |
| 208 | $values['scheduled_date'] = $values['start_date']; |
| 209 | } |
| 210 | } |
| 211 | |