api/v3/PledgePayment.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_Payment
  34  *
  35  * @copyright CiviCRM LLC (c) 2004-2014
  36  * @version $Id: PledgePayment.php
  37  *
  38  */
  39
  40 /**
  41  * Add or update a plege payment. Pledge Payment API doesn't actually add a pledge
  42  *  if the request is to 'create' and 'id' is not passed in
  43  * the oldest pledge with no associated contribution is updated
  44  *
  45  * @todo possibly add ability to add payment if there are less payments than pledge installments
  46  * @todo possibly add ability to recalculate dates if the schedule is changed
  47  *
  48  * @param array $params
  49  *   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']) && empty($params['option.create_new'])) {
  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   //update pledge status
  77   CRM_Pledge_BAO_PledgePayment::updatePledgePaymentStatus($dao->pledge_id);
  78
  79   return civicrm_api3_create_success($result, $params, 'pledge_payment', 'create', $dao);
  80 }
  81
  82 /**
  83  * Adjust Metadata for Create action
  84  *
  85  * The metadata is used for setting defaults, documentation & validation
  86  * @param array $params
  87  *   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
  98  *   Input parameters.
  99  * {@getfields PledgePayment_delete}
 100  * @example PledgePaymentDelete.php
 101  *
 102  * @return array API result
 103  * @static void
 104  * @access public
 105  */
 106 function civicrm_api3_pledge_payment_delete($params) {
 107
 108   if (CRM_Pledge_BAO_PledgePayment::del($params['id'])) {
 109     return civicrm_api3_create_success(array('id' => $params['id']), $params, 'pledge_payment', 'delete');
 110   }
 111   else {
 112     return civicrm_api3_create_error('Could not delete payment');
 113   }
 114 }
 115
 116 /**
 117  * Retrieve a set of pledges, given a set of input params
 118  *
 119  * @param array $params
 120  *   Input parameters.
 121  * {@getfields PledgePayment_get}
 122  * @example PledgePaymentGet.php *
 123  *
 124  * @return array (reference )        array of pledges, if error an array with an error id and error message
 125  * @static void
 126  * @access public
 127  */
 128 function civicrm_api3_pledge_payment_get($params) {
 129
 130   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 131 }
 132
 133 /**
 134  * @param int $pledgeId
 135  * @param int $paymentStatusId
 136  * @param $paymentIds
 137  *
 138  * @return mixed
 139  */
 140 function updatePledgePayments($pledgeId, $paymentStatusId, $paymentIds) {
 141
 142   $result = updatePledgePayments($pledgeId, $paymentStatusId, $paymentIds = NULL);
 143   return $result;
 144 }
 145
 146 /**
 147  * Gets field for civicrm_pledge_payment functions
 148  *
 149  * @param array $params
 150  *
 151  * @return array fields valid for other functions
 152  */
 153 function civicrm_api3_pledge_payment_get_spec(&$params) {
 154   $params['option.create_new'] = array('title' => "Create new field rather than update an unpaid payment");
 155 }