api/v3/Pledge.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  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.   |
  13  |                                                                    |
  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.        |
  18  |                                                                    |
  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  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  * File for the CiviCRM APIv3 Pledge functions
  30  *
  31  * @package CiviCRM_APIv3
  32  * @subpackage API_Pledge
  33  *
  34  * @copyright CiviCRM LLC (c) 2004-2014
  35  * @version $Id: Pledge.php
  36  *
  37  */
  38
  39 /**
  40  * Include utility functions
  41  */
  42
  43 /**
  44  * Creates or updates an Activity. See the example for usage
  45  *
  46  * @param array $params
  47  *   Associative array of property name/value.
  48  *                             pairs for the activity.
  49  * {@getfields pledge_create}
  50  *
  51  * @return array
  52  *   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 bool
  72  *   true if success, else false
  73  *   {@getfields pledge_delete}
  74  * @example PledgeDelete.php
  75  */
  76 function civicrm_api3_pledge_delete($params) {
  77   if (CRM_Pledge_BAO_Pledge::deletePledge($params['id'])) {
  78     return civicrm_api3_create_success(array(
  79       'id' => $params['id'],
  80     ), $params, 'pledge', 'delete');
  81   }
  82   else {
  83     return civicrm_api3_create_error('Could not delete pledge');
  84   }
  85 }
  86
  87 /**
  88  * @param array $params
  89  */
  90 function _civicrm_api3_pledge_delete_spec(&$params) {
  91   // set as not required as pledge_id also acceptable & no either/or std yet
  92   $params['id']['api.aliases'] = array('pledge_id');
  93 }
  94
  95 /**
  96  * return field specification specific to get requests
  97  * @param array $params
  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  * @param array $params
 115  */
 116 function _civicrm_api3_pledge_create_spec(&$params) {
 117
 118   $required = array('contact_id', 'amount', 'installments', 'start_date', 'financial_type_id');
 119   foreach ($required as $required_field) {
 120     $params[$required_field]['api.required'] = 1;
 121   }
 122   // @todo this can come from xml
 123   $params['amount']['api.aliases'] = array('pledge_amount');
 124   $params['financial_type_id']['api.aliases'] = array('contribution_type_id', 'contribution_type');
 125 }
 126
 127 /**
 128  * Retrieve a set of pledges, given a set of input params
 129  *
 130  * @param array $params
 131  *   Input parameters. Use interrogate for possible fields.
 132  *
 133  * @return array
 134  *   array of pledges, if error an array with an error id and error message
 135  *   {@getfields pledge_get}
 136  * @example PledgeGet.php
 137  */
 138 function civicrm_api3_pledge_get($params) {
 139   $mode = CRM_Contact_BAO_Query::MODE_PLEDGE;
 140   $entity = 'pledge';
 141
 142   list($dao, $query) = _civicrm_api3_get_query_object($params, $mode, $entity);
 143
 144   $pledge = array();
 145   while ($dao->fetch()) {
 146     $pledge[$dao->pledge_id] = $query->store($dao);
 147   }
 148
 149   return civicrm_api3_create_success($pledge, $params, 'pledge', 'get', $dao);
 150 }
 151
 152 /**
 153  * Set default to not return test params
 154  */
 155 function _civicrm_api3_pledge_get_defaults() {
 156   return array('pledge_test' => 0);
 157 }
 158
 159 /**
 160  * Legacy function - I removed a bunch of stuff no longer required from here but it still needs
 161  * more culling
 162  * take the input parameter list as specified in the data model and
 163  * convert it into the same format that we use in QF and BAO object
 164  *
 165  * @param array $values
 166  *   The reformatted properties that we can use internally.
 167  *
 168  */
 169 function _civicrm_api3_pledge_format_params(&$values) {
 170
 171   // probably most of the below can be removed.... just needs a little more review
 172   if (array_key_exists('original_installment_amount', $values)) {
 173     $values['installment_amount'] = $values['original_installment_amount'];
 174     //it seems it will only create correctly with BOTH installment amount AND pledge_installment_amount set
 175     //pledge installment amount required for pledge payments
 176     $values['pledge_original_installment_amount'] = $values['original_installment_amount'];
 177   }
 178
 179   if (array_key_exists('pledge_original_installment_amount', $values)) {
 180     $values['installment_amount'] = $values['pledge_original_installment_amount'];
 181   }
 182
 183   if (empty($values['id'])) {
 184     //at this point both should be the same so unset both if not set - passing in empty
 185     //value causes crash rather creating new - do it before next section as null values ignored in 'switch'
 186     unset($values['id']);
 187
 188     //if you have a single installment when creating & you don't set the pledge status (not a required field) then
 189     //status id is left null for pledge payments in BAO
 190     // so we are hacking in the addition of the pledge_status_id to pending here
 191     if (empty($values['status_id']) && $values['installments'] == 1) {
 192       $contributionStatus = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
 193       $values['status_id'] = array_search('Pending', $contributionStatus);
 194     }
 195   }
 196   if (empty($values['scheduled_date']) && array_key_exists('start_date', $values)) {
 197     $values['scheduled_date'] = $values['start_date'];
 198   }
 199 }