api/v3/ParticipantPayment.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  * This api exposes CiviCRM participant payments.
  30  *
  31  * @package CiviCRM_APIv3
  32  */
  33
  34 /**
  35  * Create a Event Participant Payment.
  36  *
  37  * This API is used for creating a Participant Payment of Event.
  38  * Required parameters: participant_id, contribution_id.
  39  *
  40  * @param array $params
  41  *   An associative array of name/value property values of civicrm_participant_payment.
  42  *
  43  * @return array
  44  *   Array of newly created payment property values.
  45  */
  46 function civicrm_api3_participant_payment_create($params) {
  47
  48   $ids = array();
  49   if (!empty($params['id'])) {
  50     $ids['id'] = $params['id'];
  51   }
  52   $participantPayment = CRM_Event_BAO_ParticipantPayment::create($params, $ids);
  53
  54   $payment = array();
  55   _civicrm_api3_object_to_array($participantPayment, $payment[$participantPayment->id]);
  56
  57   return civicrm_api3_create_success($payment, $params);
  58 }
  59
  60 /**
  61  * Adjust Metadata for Create action.
  62  *
  63  * The metadata is used for setting defaults, documentation & validation.
  64  *
  65  * @param array $params
  66  *   Array of parameters determined by getfields.
  67  */
  68 function _civicrm_api3_participant_payment_create_spec(&$params) {
  69   $params['participant_id']['api.required'] = 1;
  70   $params['contribution_id']['api.required'] = 1;
  71 }
  72
  73 /**
  74  * Deletes an existing Participant Payment.
  75  *
  76  * @param array $params
  77  *
  78  * @return array
  79  *   API result
  80  */
  81 function civicrm_api3_participant_payment_delete($params) {
  82   $participant = new CRM_Event_BAO_ParticipantPayment();
  83   return $participant->deleteParticipantPayment($params) ? civicrm_api3_create_success() : civicrm_api3_create_error('Error while deleting participantPayment');
  84 }
  85
  86 /**
  87  * Retrieve one or more participant payment records.
  88  *
  89  * @param array $params
  90  *   Input parameters.
  91  *
  92  * @return array
  93  *   array of properties, if error an array with an error id and error message
  94  */
  95 function civicrm_api3_participant_payment_get($params) {
  96   return _civicrm_api3_basic_get('CRM_Event_DAO_ParticipantPayment', $params);
  97 }