5 +--------------------------------------------------------------------+
6 | CiviCRM version 4.3 |
7 +--------------------------------------------------------------------+
8 | Copyright CiviCRM LLC (c) 2004-2013 |
9 +--------------------------------------------------------------------+
10 | This file is a part of CiviCRM. |
12 | CiviCRM is free software; you can copy, modify, and distribute it |
13 | under the terms of the GNU Affero General Public License |
14 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
16 | CiviCRM is distributed in the hope that it will be useful, but |
17 | WITHOUT ANY WARRANTY; without even the implied warranty of |
18 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
19 | See the GNU Affero General Public License for more details. |
21 | You should have received a copy of the GNU Affero General Public |
22 | License and the CiviCRM Licensing Exception along |
23 | with this program; if not, contact CiviCRM LLC |
24 | at info[AT]civicrm[DOT]org. If you have questions about the |
25 | GNU Affero General Public License or the licensing of CiviCRM, |
26 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
27 +--------------------------------------------------------------------+
31 * File for the CiviCRM APIv3 membership contribution link functions
33 * @package CiviCRM_APIv3
34 * @subpackage API_Membership
35 * @todo delete function doesn't exist
36 * @copyright CiviCRM LLC (c) 2004-2013
37 * @version $Id: MembershipContributionLink.php 30171 2010-10-14 09:11:27Z mover $
41 * Include utility functions
44 require_once 'CRM/Member/DAO/MembershipPayment.php';
47 * Add or update a link between contribution and membership
49 * @param array $params (reference ) input parameters
51 * @return array (reference ) membership_payment_id of created or updated record
52 * {@getfields MembershipPayment_create}
53 * @example MembershipPaymentCreate.php
56 function civicrm_api3_membership_payment_create($params) {
58 require_once 'CRM/Core/Transaction.php';
59 $transaction = new CRM_Core_Transaction();
62 $mpDAO = new CRM_Member_DAO_MembershipPayment();
63 $mpDAO->copyValues($params);
64 $result = $mpDAO->save();
66 if (is_a($result, 'CRM_Core_Error')) {
67 $transaction->rollback();
68 return civicrm_api3_create_error($result->_errors
[0]['message']);
71 $transaction->commit();
73 _civicrm_api3_object_to_array($mpDAO, $mpArray[$mpDAO->id
]);
75 return civicrm_api3_create_success($mpArray, $params);
79 * Adjust Metadata for Create action
81 * The metadata is used for setting defaults, documentation & validation
82 * @param array $params array or parameters determined by getfields
84 function _civicrm_api3_membership_payment_create_spec(&$params) {
85 $params['membership_id']['api.required'] = 1;
86 $params['contribution_id']['api.required'] = 1;
90 * Retrieve one / all contribution(s) / membership(s) linked to a
91 * membership / contrbution.
93 * @param array $params input parameters
95 * @return array array of properties, if error an array with an error id and error message
96 * @example MembershipPaymentGet
97 * {@getfields MembershipPayment_get}
100 function civicrm_api3_membership_payment_get($params) {
103 return _civicrm_api3_basic_get('CRM_Member_DAO_MembershipPayment', $params);