Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
fee14197 | 4 | | CiviCRM version 5 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
6b83d5bd | 6 | | Copyright CiviCRM LLC (c) 2004-2019 | |
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) { | |
baccd59e CW |
44 | // Workaround for fields using nonstandard serialization |
45 | foreach (array('relationship_type_id', 'relationship_direction') as $field) { | |
46 | if (isset($params[$field]) && is_array($params[$field])) { | |
47 | $params[$field] = implode(CRM_Core_DAO::VALUE_SEPARATOR, $params[$field]); | |
48 | } | |
49 | } | |
1237d8d7 | 50 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'MembershipType'); |
6a488035 | 51 | } |
11e09c59 TO |
52 | |
53 | /** | |
0aa0303c EM |
54 | * Adjust Metadata for Create action. |
55 | * | |
56 | * The metadata is used for setting defaults, documentation & validation. | |
1c88e578 | 57 | * |
cf470720 | 58 | * @param array $params |
b081365f | 59 | * Array of parameters determined by getfields. |
6a488035 TO |
60 | */ |
61 | function _civicrm_api3_membership_type_create_spec(&$params) { | |
fb38ab8d | 62 | $params['domain_id']['api.default'] = CRM_Core_Config::domainID(); |
6a488035 | 63 | $params['member_of_contact_id']['api.required'] = 1; |
35671d00 | 64 | $params['financial_type_id']['api.required'] = 1; |
6a488035 TO |
65 | $params['name']['api.required'] = 1; |
66 | $params['duration_unit']['api.required'] = 1; | |
67 | $params['duration_interval']['api.required'] = 1; | |
5b1b8db2 | 68 | $params['period_type']['api.required'] = 1; |
08fd4b45 | 69 | $params['is_active']['api.default'] = 1; |
6a488035 TO |
70 | } |
71 | ||
72 | /** | |
73 | * Get a Membership Type. | |
74 | * | |
75 | * This api is used for finding an existing membership type. | |
76 | * | |
cf470720 | 77 | * @param array $params |
1747ab99 | 78 | * Array of name/value property values of civicrm_membership_type. |
6a488035 | 79 | * |
16b10e64 | 80 | * @return array |
1747ab99 | 81 | * API result array. |
6a488035 TO |
82 | */ |
83 | function civicrm_api3_membership_type_get($params) { | |
baccd59e | 84 | $results = _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
9559d77f | 85 | if (!empty($results['values']) && is_array($results['values'])) { |
baccd59e CW |
86 | foreach ($results['values'] as &$item) { |
87 | // Workaround for fields using nonstandard serialization | |
88 | foreach (array('relationship_type_id', 'relationship_direction') as $field) { | |
89 | if (isset($item[$field]) && !is_array($item[$field])) { | |
90 | $item[$field] = (array) $item[$field]; | |
91 | } | |
92 | } | |
93 | } | |
94 | } | |
95 | return $results; | |
6a488035 TO |
96 | } |
97 | ||
1b193115 | 98 | /** |
99 | * Adjust input for getlist action. | |
100 | * | |
101 | * We want to only return active membership types for getlist. It's a bit | |
102 | * arguable whether this should be applied at the 'get' level but, since it's hard | |
103 | * to unset we'll just do it here. | |
104 | * | |
105 | * The usage of getlist is entity-reference fields & the like | |
106 | * so using only active ones makes sense. | |
107 | * | |
108 | * @param array $request | |
109 | * Array of parameters determined by getfields. | |
110 | */ | |
111 | function _civicrm_api3_membership_type_getlist_params(&$request) { | |
38a14841 | 112 | if (!isset($request['params']['is_active']) && empty($request['params']['id'])) { |
1b193115 | 113 | $request['params']['is_active'] = 1; |
114 | } | |
115 | } | |
116 | ||
6a488035 | 117 | /** |
1747ab99 | 118 | * Deletes an existing membership type. |
6a488035 | 119 | * |
cf470720 | 120 | * @param array $params |
6a488035 | 121 | * |
1747ab99 EM |
122 | * @return array |
123 | * API result array. | |
6a488035 TO |
124 | */ |
125 | function civicrm_api3_membership_type_delete($params) { | |
8c33a68c | 126 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
6a488035 | 127 | } |