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  * File for the CiviCRM APIv3 participant functions
  30  *
  31  * @package CiviCRM_APIv3
  32  * @subpackage API_Participant
  33  *
  34  * @copyright CiviCRM LLC (c) 2004-2014
  35  * @version $Id: Participant.php 30486 2010-11-02 16:12:09Z shot $
  36  *
  37  */
  38
  39 /**
  40  * Create a Event Participant Payment
  41  *
  42  * This API is used for creating a Participant Payment of Event.
  43  * Required parameters : participant_id, contribution_id.
  44  *
  45  * @param array $params
  46  *   An associative array of name/value property values of civicrm_participant_payment.
  47  * @example ParticipantPaymentCreate.php
  48  * {@example ParticipantPaymentCreate.php 0}
  49  *
  50  * @return array
  51  *   Array of newly created payment property values.
  52  * {@getfields ParticipantPayment_create}
  53  */
  54 function civicrm_api3_participant_payment_create($params) {
  55
  56   $ids = array();
  57   if (!empty($params['id'])) {
  58     $ids['id'] = $params['id'];
  59   }
  60   $participantPayment = CRM_Event_BAO_ParticipantPayment::create($params, $ids);
  61
  62   $payment = array();
  63   _civicrm_api3_object_to_array($participantPayment, $payment[$participantPayment->id]);
  64
  65   return civicrm_api3_create_success($payment, $params);
  66 }
  67
  68 /**
  69  * Adjust Metadata for Create action
  70  *
  71  * The metadata is used for setting defaults, documentation & validation
  72  * @param array $params
  73  *   Array or parameters determined by getfields.
  74  */
  75 function _civicrm_api3_participant_payment_create_spec(&$params) {
  76   $params['participant_id']['api.required'] = 1;
  77   $params['contribution_id']['api.required'] = 1;
  78 }
  79
  80 /**
  81  * Deletes an existing Participant Payment
  82  *
  83  * This API is used for deleting a Participant Payment
  84  *
  85  * @param array $params
  86  *
  87  * @return array
  88  *   API result
  89  * @example ParticipantPaymentDelete.php
  90  * {@getfields ParticipantPayment_delete}
  91  */
  92 function civicrm_api3_participant_payment_delete($params) {
  93   $participant = new CRM_Event_BAO_ParticipantPayment();
  94   return $participant->deleteParticipantPayment($params) ? civicrm_api3_create_success() : civicrm_api3_create_error('Error while deleting participantPayment');
  95 }
  96
  97 /**
  98  * Retrieve one / all contribution(s) / participant(s) linked to a
  99  * contribution.
 100  *
 101  * @param array $params
 102  *   Input parameters.
 103  *
 104  * @return array
 105  *   array of properties, if error an array with an error id and error message
 106  * @example ParticipantPaymentGet
 107  * {@getfields ParticipantPayment_get}
 108  */
 109 function civicrm_api3_participant_payment_get($params) {
 110   return _civicrm_api3_basic_get('CRM_Event_DAO_ParticipantPayment', $params);
 111 }