3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
29 * This api exposes CiviCRM membership type.
31 * @package CiviCRM_APIv3
35 * API to Create or update a Membership Type.
37 * @param array $params
38 * Array of name/value property values of civicrm_membership_type.
43 function civicrm_api3_membership_type_create($params) {
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]);
50 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params, 'Membership_type');
54 * Adjust Metadata for Create action.
56 * The metadata is used for setting defaults, documentation & validation.
58 * @param array $params
59 * Array of parameters determined by getfields.
61 function _civicrm_api3_membership_type_create_spec(&$params) {
62 // todo could set default here probably
63 $params['domain_id']['api.required'] = 1;
64 $params['member_of_contact_id']['api.required'] = 1;
65 $params['financial_type_id']['api.required'] = 1;
66 $params['name']['api.required'] = 1;
67 $params['duration_unit']['api.required'] = 1;
68 $params['duration_interval']['api.required'] = 1;
69 $params['period_type']['api.required'] = 1;
70 $params['is_active']['api.default'] = 1;
74 * Get a Membership Type.
76 * This api is used for finding an existing membership type.
78 * @param array $params
79 * Array of name/value property values of civicrm_membership_type.
84 function civicrm_api3_membership_type_get($params) {
85 $results = _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
86 if (!empty($results['values']) && is_array($results['values'])) {
87 foreach ($results['values'] as &$item) {
88 // Workaround for fields using nonstandard serialization
89 foreach (array('relationship_type_id', 'relationship_direction') as $field) {
90 if (isset($item[$field]) && !is_array($item[$field])) {
91 $item[$field] = (array) $item[$field];
100 * Adjust input for getlist action.
102 * We want to only return active membership types for getlist. It's a bit
103 * arguable whether this should be applied at the 'get' level but, since it's hard
104 * to unset we'll just do it here.
106 * The usage of getlist is entity-reference fields & the like
107 * so using only active ones makes sense.
109 * @param array $request
110 * Array of parameters determined by getfields.
112 function _civicrm_api3_membership_type_getlist_params(&$request) {
113 if (!isset($request['params']['is_active']) && empty($request['params']['id'])) {
114 $request['params']['is_active'] = 1;
119 * Deletes an existing membership type.
121 * @param array $params
126 function civicrm_api3_membership_type_delete($params) {
127 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);