3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
29 * File for the CiviCRM APIv3 participant functions
31 * @package CiviCRM_APIv3
32 * @subpackage API_Participant
34 * @copyright CiviCRM LLC (c) 2004-2014
35 * @version $Id: Participant.php 30486 2010-11-02 16:12:09Z shot $
40 * Create a Event Participant Payment
42 * This API is used for creating a Participant Payment of Event.
43 * Required parameters : participant_id, contribution_id.
45 * @param array $params
46 * An associative array of name/value property values of civicrm_participant_payment.
49 * Array of newly created payment property values.
51 function civicrm_api3_participant_payment_create($params) {
54 if (!empty($params['id'])) {
55 $ids['id'] = $params['id'];
57 $participantPayment = CRM_Event_BAO_ParticipantPayment
::create($params, $ids);
60 _civicrm_api3_object_to_array($participantPayment, $payment[$participantPayment->id
]);
62 return civicrm_api3_create_success($payment, $params);
66 * Adjust Metadata for Create action.
68 * The metadata is used for setting defaults, documentation & validation.
70 * @param array $params
71 * Array or parameters determined by getfields.
73 function _civicrm_api3_participant_payment_create_spec(&$params) {
74 $params['participant_id']['api.required'] = 1;
75 $params['contribution_id']['api.required'] = 1;
79 * Deletes an existing Participant Payment
81 * This API is used for deleting a Participant Payment
83 * @param array $params
87 * @example ParticipantPaymentDelete.php
88 * {@getfields ParticipantPayment_delete}
90 function civicrm_api3_participant_payment_delete($params) {
91 $participant = new CRM_Event_BAO_ParticipantPayment();
92 return $participant->deleteParticipantPayment($params) ?
civicrm_api3_create_success() : civicrm_api3_create_error('Error while deleting participantPayment');
96 * Retrieve one / all contribution(s) / participant(s) linked to a
99 * @param array $params
103 * array of properties, if error an array with an error id and error message
104 * @example ParticipantPaymentGet
105 * {@getfields ParticipantPayment_get}
107 function civicrm_api3_participant_payment_get($params) {
108 return _civicrm_api3_basic_get('CRM_Event_DAO_ParticipantPayment', $params);