Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
39de6fd5 | 4 | | CiviCRM version 4.6 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
731a0992 | 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
6a488035 TO |
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 | * | |
731a0992 | 34 | * @copyright CiviCRM LLC (c) 2004-2014 |
6a488035 TO |
35 | * @version $Id: Participant.php 30486 2010-11-02 16:12:09Z shot $ |
36 | * | |
37 | */ | |
38 | ||
6a488035 TO |
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 | * | |
cf470720 TO |
45 | * @param array $params |
46 | * An associative array of name/value property values of civicrm_participant_payment. | |
6a488035 TO |
47 | * @example ParticipantPaymentCreate.php |
48 | * {@example ParticipantPaymentCreate.php 0} | |
49 | * | |
a6c01b45 | 50 | * @return array |
16b10e64 | 51 | * Array of newly created payment property values. |
6a488035 | 52 | * {@getfields ParticipantPayment_create} |
6a488035 TO |
53 | */ |
54 | function civicrm_api3_participant_payment_create($params) { | |
55 | ||
56 | $ids = array(); | |
a7488080 | 57 | if (!empty($params['id'])) { |
6a488035 TO |
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 | } | |
11e09c59 TO |
67 | |
68 | /** | |
6a488035 | 69 | * Adjust Metadata for Create action |
1c88e578 | 70 | * |
6a488035 | 71 | * The metadata is used for setting defaults, documentation & validation |
cf470720 TO |
72 | * @param array $params |
73 | * Array or parameters determined by getfields. | |
6a488035 TO |
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 | * | |
c490a46a | 85 | * @param array $params |
6a488035 | 86 | * |
a6c01b45 | 87 | * @return array |
72b3a70c | 88 | * API result |
6a488035 TO |
89 | * @example ParticipantPaymentDelete.php |
90 | * {@getfields ParticipantPayment_delete} | |
6a488035 TO |
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 | |
7c285037 | 99 | * contribution. |
6a488035 | 100 | * |
cf470720 TO |
101 | * @param array $params |
102 | * Input parameters. | |
6a488035 | 103 | * |
a6c01b45 | 104 | * @return array |
72b3a70c | 105 | * array of properties, if error an array with an error id and error message |
35671d00 | 106 | * @example ParticipantPaymentGet |
6a488035 | 107 | * {@getfields ParticipantPayment_get} |
6a488035 TO |
108 | */ |
109 | function civicrm_api3_participant_payment_get($params) { | |
110 | return _civicrm_api3_basic_get('CRM_Event_DAO_ParticipantPayment', $params); | |
111 | } |