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  * Add or update a pledge payment.
  40  *
  41  * 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  *
  51  * @return array
  52  *   API Result
  53  */
  54 function civicrm_api3_pledge_payment_create($params) {
  55
  56   $paymentParams = $params;
  57   if (empty($params['id']) && empty($params['option.create_new'])) {
  58     $paymentDetails = CRM_Pledge_BAO_PledgePayment::getOldestPledgePayment($params['pledge_id']);
  59     if (empty($paymentDetails)) {
  60       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");
  61     }
  62     elseif (is_array($paymentDetails)) {
  63       $paymentParams = array_merge($params, $paymentDetails);
  64     }
  65   }
  66
  67   $dao = CRM_Pledge_BAO_PledgePayment::add($paymentParams);
  68   $result = array();
  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  *
  85  * @param array $params
  86  *   Array or parameters determined by getfields.
  87  */
  88 function _civicrm_api3_pledge_payment_create_spec(&$params) {
  89   $params['pledge_id']['api.required'] = 1;
  90   $params['status_id']['api.required'] = 1;
  91 }
  92
  93 /**
  94  * Delete a pledge Payment - Note this deletes the contribution not just the link.
  95  *
  96  * @param array $params
  97  *   Input parameters.
  98  *
  99  * @return array
 100  *   API result
 101  */
 102 function civicrm_api3_pledge_payment_delete($params) {
 103
 104   if (CRM_Pledge_BAO_PledgePayment::del($params['id'])) {
 105     return civicrm_api3_create_success(array('id' => $params['id']), $params, 'pledge_payment', 'delete');
 106   }
 107   else {
 108     return civicrm_api3_create_error('Could not delete payment');
 109   }
 110 }
 111
 112 /**
 113  * Retrieve a set of pledges, given a set of input params.
 114  *
 115  * @param array $params
 116  *   Input parameters.
 117  *
 118  * @return array
 119  *   array of pledges, if error an array with an error id and error message
 120  */
 121 function civicrm_api3_pledge_payment_get($params) {
 122
 123   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 124 }
 125
 126 /**
 127  * Gets field for civicrm_pledge_payment functions.
 128  *
 129  * @param array $params
 130  *   Modifiable list of fields allowed for the PledgePayment.get action.
 131  */
 132 function civicrm_api3_pledge_payment_get_spec(&$params) {
 133   $params['option.create_new'] = array('title' => "Create new field rather than update an unpaid payment");
 134 }