api/v3/ParticipantPayment.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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  *
  34  * @copyright CiviCRM LLC (c) 2004-2014
  35  * @version $Id: Participant.php 30486 2010-11-02 16:12:09Z shot $
  36  */
  37
  38 /**
  39  * Create a Event Participant Payment.
  40  *
  41  * This API is used for creating a Participant Payment of Event.
  42  * Required parameters : participant_id, contribution_id.
  43  *
  44  * @param array $params
  45  *   An associative array of name/value property values of civicrm_participant_payment.
  46  *
  47  * @return array
  48  *   Array of newly created payment property values.
  49  */
  50 function civicrm_api3_participant_payment_create($params) {
  51
  52   $ids = array();
  53   if (!empty($params['id'])) {
  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 }
  63
  64 /**
  65  * Adjust Metadata for Create action.
  66  *
  67  * The metadata is used for setting defaults, documentation & validation.
  68  *
  69  * @param array $params
  70  *   Array or parameters determined by getfields.
  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 /**
  78  * Deletes an existing Participant Payment.
  79  *
  80  * @param array $params
  81  *
  82  * @return array
  83  *   API result
  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 /**
  91  * Retrieve one or more participant payment records.
  92  *
  93  * @param array $params
  94  *   Input parameters.
  95  *
  96  * @return array
  97  *   array of properties, if error an array with an error id and error message
  98  */
  99 function civicrm_api3_participant_payment_get($params) {
 100   return _civicrm_api3_basic_get('CRM_Event_DAO_ParticipantPayment', $params);
 101 }