api/v3/MembershipPayment.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 membership contribution link functions
  30  *
  31  * @package CiviCRM_APIv3
  32  * @subpackage API_Membership
  33  * @todo delete function doesn't exist
  34  * @copyright CiviCRM LLC (c) 2004-2014
  35  * @version $Id: MembershipContributionLink.php 30171 2010-10-14 09:11:27Z mover $
  36  */
  37
  38 /**
  39  * Add or update a link between contribution and membership
  40  *
  41  * @param array $params
  42  *   (reference ) input parameters.
  43  *
  44  * @return array
  45  *   (reference )        membership_payment_id of created or updated record
  46  * {@getfields MembershipPayment_create}
  47  * @example MembershipPaymentCreate.php
  48  * @access public
  49  */
  50 function civicrm_api3_membership_payment_create($params) {
  51   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  52 }
  53
  54 /**
  55  * Adjust Metadata for Create action
  56  *
  57  * The metadata is used for setting defaults, documentation & validation
  58  * @param array $params
  59  *   Array or parameters determined by getfields.
  60  */
  61 function _civicrm_api3_membership_payment_create_spec(&$params) {
  62   $params['membership_id']['api.required'] = 1;
  63   $params['contribution_id']['api.required'] = 1;
  64 }
  65
  66 /**
  67  * Retrieve one / all contribution(s) / membership(s) linked to a
  68  * membership / contrbution.
  69  *
  70  * @param array $params
  71  *   Input parameters.
  72  *
  73  * @return array
  74  *   array of properties, if error an array with an error id and error message
  75  * @example MembershipPaymentGet
  76  * {@getfields MembershipPayment_get}
  77  * @access public
  78  */
  79 function civicrm_api3_membership_payment_get($params) {
  80   return _civicrm_api3_basic_get('CRM_Member_DAO_MembershipPayment', $params);
  81 }