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