api/v3/PledgePayment.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_Payment
  33  *
  34  * @copyright CiviCRM LLC (c) 2004-2014
  35  * @version $Id: PledgePayment.php
  36  *
  37  */
  38
  39 /**
  40  * Add or update a plege payment. Pledge Payment API doesn't actually add a pledge
  41  *  if the request is to 'create' and 'id' is not passed in
  42  * the oldest pledge with no associated contribution is updated
  43  *
  44  * @todo possibly add ability to add payment if there are less payments than pledge installments
  45  * @todo possibly add ability to recalculate dates if the schedule is changed
  46  *
  47  * @param array $params
  48  *   Input parameters.
  49  * {@getfields PledgePayment_create}
  50  * @example PledgePaymentCreate.php
  51  *
  52  * @return array
  53  *   API Result
  54  */
  55 function civicrm_api3_pledge_payment_create($params) {
  56
  57   $paymentParams = $params;
  58   if (empty($params['id']) && empty($params['option.create_new'])) {
  59     $paymentDetails = CRM_Pledge_BAO_PledgePayment::getOldestPledgePayment($params['pledge_id']);
  60     if (empty($paymentDetails)) {
  61       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");
  62     }
  63     elseif (is_array($paymentDetails)) {
  64       $paymentParams = array_merge($params, $paymentDetails);
  65     }
  66   }
  67
  68   $dao = CRM_Pledge_BAO_PledgePayment::add($paymentParams);
  69   if (empty($dao->pledge_id)) {
  70     $dao->find(TRUE);
  71   }
  72   _civicrm_api3_object_to_array($dao, $result[$dao->id]);
  73
  74   //update pledge status
  75   CRM_Pledge_BAO_PledgePayment::updatePledgePaymentStatus($dao->pledge_id);
  76
  77   return civicrm_api3_create_success($result, $params, 'pledge_payment', 'create', $dao);
  78 }
  79
  80 /**
  81  * Adjust Metadata for Create action
  82  *
  83  * The metadata is used for setting defaults, documentation & validation
  84  * @param array $params
  85  *   Array or parameters determined by getfields.
  86  */
  87 function _civicrm_api3_pledge_payment_create_spec(&$params) {
  88   $params['pledge_id']['api.required'] = 1;
  89   $params['status_id']['api.required'] = 1;
  90 }
  91
  92 /**
  93  * Delete a pledge Payment - Note this deletes the contribution not just the link
  94  *
  95  * @param array $params
  96  *   Input parameters.
  97  * {@getfields PledgePayment_delete}
  98  * @example PledgePaymentDelete.php
  99  *
 100  * @return array
 101  *   API result
 102  */
 103 function civicrm_api3_pledge_payment_delete($params) {
 104
 105   if (CRM_Pledge_BAO_PledgePayment::del($params['id'])) {
 106     return civicrm_api3_create_success(array('id' => $params['id']), $params, 'pledge_payment', 'delete');
 107   }
 108   else {
 109     return civicrm_api3_create_error('Could not delete payment');
 110   }
 111 }
 112
 113 /**
 114  * Retrieve a set of pledges, given a set of input params
 115  *
 116  * @param array $params
 117  *   Input parameters.
 118  * {@getfields PledgePayment_get}
 119  * @example PledgePaymentGet.php *
 120  *
 121  * @return array
 122  *   (reference )        array of pledges, if error an array with an error id and error message
 123  */
 124 function civicrm_api3_pledge_payment_get($params) {
 125
 126   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 127 }
 128
 129 /**
 130  * @param int $pledgeId
 131  * @param int $paymentStatusId
 132  * @param $paymentIds
 133  *
 134  * @return mixed
 135  */
 136 function updatePledgePayments($pledgeId, $paymentStatusId, $paymentIds) {
 137
 138   $result = updatePledgePayments($pledgeId, $paymentStatusId, $paymentIds = NULL);
 139   return $result;
 140 }
 141
 142 /**
 143  * Gets field for civicrm_pledge_payment functions
 144  *
 145  * @param array $params
 146  *
 147  * @return array
 148  *   fields valid for other functions
 149  */
 150 function civicrm_api3_pledge_payment_get_spec(&$params) {
 151   $params['option.create_new'] = array('title' => "Create new field rather than update an unpaid payment");
 152 }