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