api/v3/MembershipPayment.php

   1 <?php
   2
   3 /*
   4  +--------------------------------------------------------------------+
   5  | CiviCRM version 4.5                                                |
   6  +--------------------------------------------------------------------+
   7  | Copyright CiviCRM LLC (c) 2004-2014                                |
   8  +--------------------------------------------------------------------+
   9  | This file is a part of CiviCRM.                                    |
  10  |                                                                    |
  11  | CiviCRM is free software; you can copy, modify, and distribute it  |
  12  | under the terms of the GNU Affero General Public License           |
  13  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  14  |                                                                    |
  15  | CiviCRM is distributed in the hope that it will be useful, but     |
  16  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  17  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  18  | See the GNU Affero General Public License for more details.        |
  19  |                                                                    |
  20  | You should have received a copy of the GNU Affero General Public   |
  21  | License and the CiviCRM Licensing Exception along                  |
  22  | with this program; if not, contact CiviCRM LLC                     |
  23  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  24  | GNU Affero General Public License or the licensing of CiviCRM,     |
  25  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  26  +--------------------------------------------------------------------+
  27  */
  28
  29 /**
  30  * File for the CiviCRM APIv3 membership contribution link functions
  31  *
  32  * @package CiviCRM_APIv3
  33  * @subpackage API_Membership
  34  * @todo delete function doesn't exist
  35  * @copyright CiviCRM LLC (c) 2004-2014
  36  * @version $Id: MembershipContributionLink.php 30171 2010-10-14 09:11:27Z mover $
  37  */
  38
  39 /**
  40  * Add or update a link between contribution and membership
  41  *
  42  * @param  array   $params           (reference ) input parameters
  43  *
  44  * @return array (reference )        membership_payment_id of created or updated record
  45  * {@getfields MembershipPayment_create}
  46  * @example MembershipPaymentCreate.php
  47  * @access public
  48  */
  49 function civicrm_api3_membership_payment_create($params) {
  50   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  51 }
  52
  53 /**
  54  * Adjust Metadata for Create action
  55  *
  56  * The metadata is used for setting defaults, documentation & validation
  57  * @param array $params array or parameters determined by getfields
  58  */
  59 function _civicrm_api3_membership_payment_create_spec(&$params) {
  60   $params['membership_id']['api.required'] = 1;
  61   $params['contribution_id']['api.required'] = 1;
  62 }
  63
  64 /**
  65  * Retrieve one / all contribution(s) / membership(s) linked to a
  66  * membership / contrbution.
  67  *
  68  * @param  array   $params  input parameters
  69  *
  70  * @return array  array of properties, if error an array with an error id and error message
  71  *  @example MembershipPaymentGet
  72  * {@getfields MembershipPayment_get}
  73  * @access public
  74  */
  75 function civicrm_api3_membership_payment_get($params) {
  76   return _civicrm_api3_basic_get('CRM_Member_DAO_MembershipPayment', $params);
  77 }
  78