Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
fee14197 | 4 | | CiviCRM version 5 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
6b83d5bd | 6 | | Copyright CiviCRM LLC (c) 2004-2019 | |
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 | /** | |
c28e1768 | 29 | * This api exposes CiviCRM participant payments. |
6a488035 TO |
30 | * |
31 | * @package CiviCRM_APIv3 | |
6a488035 TO |
32 | */ |
33 | ||
6a488035 | 34 | /** |
dc64d047 | 35 | * Create a Event Participant Payment. |
6a488035 TO |
36 | * |
37 | * This API is used for creating a Participant Payment of Event. | |
c28e1768 | 38 | * Required parameters: participant_id, contribution_id. |
6a488035 | 39 | * |
cf470720 TO |
40 | * @param array $params |
41 | * An associative array of name/value property values of civicrm_participant_payment. | |
6a488035 | 42 | * |
a6c01b45 | 43 | * @return array |
6a488035 TO |
44 | */ |
45 | function civicrm_api3_participant_payment_create($params) { | |
a5750507 | 46 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'ParticipantPayment'); |
6a488035 | 47 | } |
11e09c59 TO |
48 | |
49 | /** | |
0aa0303c EM |
50 | * Adjust Metadata for Create action. |
51 | * | |
52 | * The metadata is used for setting defaults, documentation & validation. | |
1c88e578 | 53 | * |
cf470720 | 54 | * @param array $params |
b081365f | 55 | * Array of parameters determined by getfields. |
6a488035 TO |
56 | */ |
57 | function _civicrm_api3_participant_payment_create_spec(&$params) { | |
58 | $params['participant_id']['api.required'] = 1; | |
59 | $params['contribution_id']['api.required'] = 1; | |
60 | } | |
61 | ||
62 | /** | |
22242c87 | 63 | * Deletes an existing Participant Payment. |
6a488035 | 64 | * |
c490a46a | 65 | * @param array $params |
6a488035 | 66 | * |
a6c01b45 | 67 | * @return array |
72b3a70c | 68 | * API result |
6a488035 TO |
69 | */ |
70 | function civicrm_api3_participant_payment_delete($params) { | |
71 | $participant = new CRM_Event_BAO_ParticipantPayment(); | |
72 | return $participant->deleteParticipantPayment($params) ? civicrm_api3_create_success() : civicrm_api3_create_error('Error while deleting participantPayment'); | |
73 | } | |
74 | ||
75 | /** | |
22242c87 | 76 | * Retrieve one or more participant payment records. |
6a488035 | 77 | * |
cf470720 TO |
78 | * @param array $params |
79 | * Input parameters. | |
6a488035 | 80 | * |
a6c01b45 | 81 | * @return array |
72b3a70c | 82 | * array of properties, if error an array with an error id and error message |
6a488035 TO |
83 | */ |
84 | function civicrm_api3_participant_payment_get($params) { | |
85 | return _civicrm_api3_basic_get('CRM_Event_DAO_ParticipantPayment', $params); | |
86 | } |