api/v3/Pledge.php

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