Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
39de6fd5 | 4 | | CiviCRM version 4.6 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
e7112fa7 | 6 | | Copyright CiviCRM LLC (c) 2004-2015 | |
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 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
6a488035 TO |
27 | |
28 | /** | |
c28e1768 | 29 | * This api exposes CiviCRM membership type. |
6a488035 TO |
30 | * |
31 | * @package CiviCRM_APIv3 | |
6a488035 TO |
32 | */ |
33 | ||
6a488035 | 34 | /** |
1747ab99 | 35 | * API to Create or update a Membership Type. |
6a488035 | 36 | * |
cf470720 | 37 | * @param array $params |
1747ab99 | 38 | * Array of name/value property values of civicrm_membership_type. |
6a488035 | 39 | * |
a6c01b45 | 40 | * @return array |
1747ab99 | 41 | * API result array. |
6a488035 TO |
42 | */ |
43 | function civicrm_api3_membership_type_create($params) { | |
452b9e04 | 44 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Membership_type'); |
6a488035 | 45 | } |
11e09c59 TO |
46 | |
47 | /** | |
0aa0303c EM |
48 | * Adjust Metadata for Create action. |
49 | * | |
50 | * The metadata is used for setting defaults, documentation & validation. | |
1c88e578 | 51 | * |
cf470720 | 52 | * @param array $params |
b081365f | 53 | * Array of parameters determined by getfields. |
6a488035 TO |
54 | */ |
55 | function _civicrm_api3_membership_type_create_spec(&$params) { | |
56 | // todo could set default here probably | |
57 | $params['domain_id']['api.required'] = 1; | |
58 | $params['member_of_contact_id']['api.required'] = 1; | |
35671d00 | 59 | $params['financial_type_id']['api.required'] = 1; |
6a488035 TO |
60 | $params['name']['api.required'] = 1; |
61 | $params['duration_unit']['api.required'] = 1; | |
62 | $params['duration_interval']['api.required'] = 1; | |
08fd4b45 | 63 | $params['is_active']['api.default'] = 1; |
6a488035 TO |
64 | } |
65 | ||
66 | /** | |
67 | * Get a Membership Type. | |
68 | * | |
69 | * This api is used for finding an existing membership type. | |
70 | * | |
cf470720 | 71 | * @param array $params |
1747ab99 | 72 | * Array of name/value property values of civicrm_membership_type. |
6a488035 | 73 | * |
16b10e64 | 74 | * @return array |
1747ab99 | 75 | * API result array. |
6a488035 TO |
76 | */ |
77 | function civicrm_api3_membership_type_get($params) { | |
6a488035 TO |
78 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
79 | } | |
80 | ||
81 | /** | |
1747ab99 | 82 | * Deletes an existing membership type. |
6a488035 | 83 | * |
cf470720 | 84 | * @param array $params |
6a488035 | 85 | * |
1747ab99 EM |
86 | * @return array |
87 | * API result array. | |
6a488035 TO |
88 | */ |
89 | function civicrm_api3_membership_type_delete($params) { | |
8c33a68c | 90 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
6a488035 | 91 | } |