Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
fee14197 | 4 | | CiviCRM version 5 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
1f4ea726 | 6 | | Copyright CiviCRM LLC (c) 2004-2017 | |
6a488035 TO |
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 | /** | |
c28e1768 | 29 | * This api exposes CiviCRM membership contribution link. |
6a488035 TO |
30 | * |
31 | * @package CiviCRM_APIv3 | |
6a488035 | 32 | * @todo delete function doesn't exist |
6a488035 TO |
33 | */ |
34 | ||
6a488035 | 35 | /** |
1747ab99 | 36 | * Add or update a link between contribution and membership. |
6a488035 | 37 | * |
cf470720 | 38 | * @param array $params |
1747ab99 | 39 | * Input parameters. |
6a488035 | 40 | * |
a6c01b45 | 41 | * @return array |
1747ab99 | 42 | * API result array. |
6a488035 TO |
43 | */ |
44 | function civicrm_api3_membership_payment_create($params) { | |
a25b46e9 | 45 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'MembershipPayment'); |
6a488035 | 46 | } |
11e09c59 TO |
47 | |
48 | /** | |
0aa0303c EM |
49 | * Adjust Metadata for Create action. |
50 | * | |
51 | * The metadata is used for setting defaults, documentation & validation. | |
1c88e578 | 52 | * |
cf470720 | 53 | * @param array $params |
b081365f | 54 | * Array of parameters determined by getfields. |
6a488035 TO |
55 | */ |
56 | function _civicrm_api3_membership_payment_create_spec(&$params) { | |
57 | $params['membership_id']['api.required'] = 1; | |
58 | $params['contribution_id']['api.required'] = 1; | |
7185fe92 MM |
59 | $params['membership_type_id'] = array( |
60 | 'title' => 'Membership type id', | |
61 | 'description' => 'The id of the membership type', | |
62 | 'type' => CRM_Utils_Type::T_INT, | |
63 | ); | |
6a488035 TO |
64 | } |
65 | ||
66 | /** | |
1747ab99 | 67 | * Retrieve one or more membership payment records. |
6a488035 | 68 | * |
cf470720 TO |
69 | * @param array $params |
70 | * Input parameters. | |
6a488035 | 71 | * |
a6c01b45 | 72 | * @return array |
1747ab99 | 73 | * API result array. |
6a488035 TO |
74 | */ |
75 | function civicrm_api3_membership_payment_get($params) { | |
6a488035 TO |
76 | return _civicrm_api3_basic_get('CRM_Member_DAO_MembershipPayment', $params); |
77 | } |