97 lines
3.5 KiB
PHP
97 lines
3.5 KiB
PHP
<?php
|
|
/*
|
|
+--------------------------------------------------------------------+
|
|
| CiviCRM version 4.7 |
|
|
+--------------------------------------------------------------------+
|
|
| Copyright CiviCRM LLC (c) 2004-2017 |
|
|
+--------------------------------------------------------------------+
|
|
| This file is a part of CiviCRM. |
|
|
| |
|
|
| CiviCRM is free software; you can copy, modify, and distribute it |
|
|
| under the terms of the GNU Affero General Public License |
|
|
| Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
|
|
| |
|
|
| CiviCRM is distributed in the hope that it will be useful, but |
|
|
| WITHOUT ANY WARRANTY; without even the implied warranty of |
|
|
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
|
|
| See the GNU Affero General Public License for more details. |
|
|
| |
|
|
| You should have received a copy of the GNU Affero General Public |
|
|
| License and the CiviCRM Licensing Exception along |
|
|
| with this program; if not, contact CiviCRM LLC |
|
|
| at info[AT]civicrm[DOT]org. If you have questions about the |
|
|
| GNU Affero General Public License or the licensing of CiviCRM, |
|
|
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
|
|
+--------------------------------------------------------------------+
|
|
*/
|
|
|
|
/**
|
|
* This api exposes CiviCRM participant payments.
|
|
*
|
|
* @package CiviCRM_APIv3
|
|
*/
|
|
|
|
/**
|
|
* Create a Event Participant Payment.
|
|
*
|
|
* This API is used for creating a Participant Payment of Event.
|
|
* Required parameters: participant_id, contribution_id.
|
|
*
|
|
* @param array $params
|
|
* An associative array of name/value property values of civicrm_participant_payment.
|
|
*
|
|
* @return array
|
|
*/
|
|
function civicrm_api3_participant_payment_create($params) {
|
|
|
|
$ids = array();
|
|
if (!empty($params['id'])) {
|
|
$ids['id'] = $params['id'];
|
|
}
|
|
$participantPayment = CRM_Event_BAO_ParticipantPayment::create($params, $ids);
|
|
|
|
$payment = array();
|
|
_civicrm_api3_object_to_array($participantPayment, $payment[$participantPayment->id]);
|
|
|
|
return civicrm_api3_create_success($payment, $params);
|
|
}
|
|
|
|
/**
|
|
* Adjust Metadata for Create action.
|
|
*
|
|
* The metadata is used for setting defaults, documentation & validation.
|
|
*
|
|
* @param array $params
|
|
* Array of parameters determined by getfields.
|
|
*/
|
|
function _civicrm_api3_participant_payment_create_spec(&$params) {
|
|
$params['participant_id']['api.required'] = 1;
|
|
$params['contribution_id']['api.required'] = 1;
|
|
}
|
|
|
|
/**
|
|
* Deletes an existing Participant Payment.
|
|
*
|
|
* @param array $params
|
|
*
|
|
* @return array
|
|
* API result
|
|
*/
|
|
function civicrm_api3_participant_payment_delete($params) {
|
|
$participant = new CRM_Event_BAO_ParticipantPayment();
|
|
return $participant->deleteParticipantPayment($params) ? civicrm_api3_create_success() : civicrm_api3_create_error('Error while deleting participantPayment');
|
|
}
|
|
|
|
/**
|
|
* Retrieve one or more participant payment records.
|
|
*
|
|
* @param array $params
|
|
* Input parameters.
|
|
*
|
|
* @return array
|
|
* array of properties, if error an array with an error id and error message
|
|
*/
|
|
function civicrm_api3_participant_payment_get($params) {
|
|
return _civicrm_api3_basic_get('CRM_Event_DAO_ParticipantPayment', $params);
|
|
}
|