api/v3/PledgePayment.php

   1 <?php
   2 // $Id$
   3
   4 /*
   5  +--------------------------------------------------------------------+
   6  | CiviCRM version 4.3                                                |
   7  +--------------------------------------------------------------------+
   8  | Copyright CiviCRM LLC (c) 2004-2013                                |
   9  +--------------------------------------------------------------------+
  10  | This file is a part of CiviCRM.                                    |
  11  |                                                                    |
  12  | CiviCRM is free software; you can copy, modify, and distribute it  |
  13  | under the terms of the GNU Affero General Public License           |
  14  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  15  |                                                                    |
  16  | CiviCRM is distributed in the hope that it will be useful, but     |
  17  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  18  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  19  | See the GNU Affero General Public License for more details.        |
  20  |                                                                    |
  21  | You should have received a copy of the GNU Affero General Public   |
  22  | License and the CiviCRM Licensing Exception along                  |
  23  | with this program; if not, contact CiviCRM LLC                     |
  24  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  25  | GNU Affero General Public License or the licensing of CiviCRM,     |
  26  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  27  +--------------------------------------------------------------------+
  28  */
  29
  30 /**
  31  * File for the CiviCRM APIv3 Pledge functions
  32  *
  33  * @package CiviCRM_APIv3
  34  * @subpackage API_Pledge_Payment
  35  *
  36  * @copyright CiviCRM LLC (c) 2004-2013
  37  * @version $Id: PledgePayment.php
  38  *
  39  */
  40
  41 /**
  42  * Add or update a plege payment. Pledge Payment API doesn't actually add a pledge
  43  *  if the request is to 'create' and 'id' is not passed in
  44  * the oldest pledge with no associated contribution is updated
  45  *
  46  * @todo possibly add ability to add payment if there are less payments than pledge installments
  47  * @todo possibily add ability to recalc dates if the schedule is changed
  48  *
  49  * @param  array   $params    input parameters
  50  * {@getfields PledgePayment_create}
  51  * @example PledgePaymentCreate.php
  52  *
  53  * @return array API Result
  54  * @static void
  55  * @access public
  56  */
  57 function civicrm_api3_pledge_payment_create($params) {
  58
  59   $paymentParams = $params;
  60   if (empty($params['id']) && !CRM_Utils_Array::value('option.create_new', $params)) {
  61     $paymentDetails = CRM_Pledge_BAO_PledgePayment::getOldestPledgePayment($params['pledge_id']);
  62     if (empty($paymentDetails)) {
  63       return civicrm_api3_create_error("There are no unmatched payment on this pledge. Pass in the pledge_payment id to specify one or 'option.create_new' to create one");
  64     }
  65     elseif (is_array($paymentDetails)) {
  66       $paymentParams = array_merge($params, $paymentDetails);
  67     }
  68   }
  69
  70   $dao = CRM_Pledge_BAO_PledgePayment::add($paymentParams);
  71   if(empty($dao->pledge_id)){
  72     $dao->find(True);
  73   }
  74   _civicrm_api3_object_to_array($dao, $result[$dao->id]);
  75
  76
  77   //update pledge status
  78   CRM_Pledge_BAO_PledgePayment::updatePledgePaymentStatus($dao->pledge_id);
  79
  80   return civicrm_api3_create_success($result, $params, 'pledge_payment', 'create', $dao);
  81 }
  82
  83 /**
  84  * Adjust Metadata for Create action
  85  *
  86  * The metadata is used for setting defaults, documentation & validation
  87  * @param array $params array or parameters determined by getfields
  88  */
  89 function _civicrm_api3_pledge_payment_create_spec(&$params) {
  90   $params['pledge_id']['api.required'] = 1;
  91   $params['status_id']['api.required'] = 1;
  92 }
  93
  94 /**
  95  * Delete a pledge Payment - Note this deletes the contribution not just the link
  96  *
  97  * @param  array   $params     input parameters
  98  * {@getfields PledgePayment_delete}
  99  * @example PledgePaymentDelete.php
 100  *
 101  * @return array API result
 102  * @static void
 103  * @access public
 104  */
 105 function civicrm_api3_pledge_payment_delete($params) {
 106
 107   if (CRM_Pledge_BAO_PledgePayment::del($params['id'])) {
 108     return civicrm_api3_create_success(array('id' => $params['id']), $params,'pledge_payment','delete');
 109   }
 110   else {
 111     return civicrm_api3_create_error('Could not delete payment');
 112   }
 113 }
 114
 115 /**
 116  * Retrieve a set of pledges, given a set of input params
 117  *
 118  * @param  array   $params     input parameters
 119  * {@getfields PledgePayment_get}
 120  * @example PledgePaymentGet.php *
 121  *
 122  * @return array (reference )        array of pledges, if error an array with an error id and error message
 123  * @static void
 124  * @access public
 125  */
 126 function civicrm_api3_pledge_payment_get($params) {
 127
 128
 129   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 130 }
 131
 132 function updatePledgePayments($pledgeId, $paymentStatusId, $paymentIds) {
 133
 134   $result = updatePledgePayments($pledgeId, $paymentStatusId, $paymentIds = NULL);
 135   return $result;
 136 }
 137
 138 /**
 139  * Gets field for civicrm_pledge_payment functions
 140  *
 141  * @return array fields valid for other functions
 142  */
 143 function civicrm_api3_pledge_payment_get_spec(&$params) {
 144   $params['option.create_new'] = array('title' => "Create new field rather than update an unpaid payment");
 145 }
 146