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 +--------------------------------------------------------------------+
30 * This api exposes CiviCRM membership contact records.
32 * @package CiviCRM_APIv3
36 * Adjust Metadata for Delete action.
38 * The metadata is used for setting defaults, documentation & validation.
40 * @param array $params
41 * Array of parameters determined by getfields.
43 function _civicrm_api3_membership_delete_spec(&$params) {
44 $params['preserve_contribution'] = array(
46 'title' => 'Preserve Contribution',
47 'description' => 'By default this is 0, or 0 if not set. Set to 1 to preserve the associated contribution record when membership is deleted.',
48 'type' => CRM_Utils_Type
::T_BOOLEAN
,
53 * Deletes an existing contact Membership.
55 * @param array $params
56 * Array array holding id - Id of the contact membership to be deleted.
57 * @return array API result array.
58 * @throws API_Exception
60 function civicrm_api3_membership_delete($params) {
61 if (isset($params['preserve_contribution'])) {
62 if (CRM_Member_BAO_Membership
::del($params['id'], $params['preserve_contribution'])) {
63 return civicrm_api3_create_success(TRUE, $params);
66 throw new API_Exception(ts('Could not delete membership'));
70 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
75 * Create a Contact Membership.
77 * This API is used for creating a Membership for a contact.
78 * Required parameters : membership_type_id and status_id.
80 * @param array $params
81 * Array of name/value property values of civicrm_membership.
86 function civicrm_api3_membership_create($params) {
87 // check params for membership id during update
88 if (!empty($params['id']) && !isset($params['skipStatusCal'])) {
89 // Don't calculate status on existing membership - expect API use to pass them in
90 // or leave unchanged.
91 $params['skipStatusCal'] = 1;
94 // also check for status id if override is set (during add/update)
95 if (!empty($params['is_override']) && empty($params['status_id'])) {
96 return civicrm_api3_create_error('Status ID required');
101 _civicrm_api3_custom_format_params($params, $values, 'Membership');
102 $params = array_merge($params, $values);
104 // Fixme: This code belongs in the BAO
105 if (empty($params['id']) ||
!empty($params['num_terms'])) {
106 if (empty($params['id'])) {
107 $calcDates = CRM_Member_BAO_MembershipType
::getDatesForMembershipType(
108 $params['membership_type_id'],
109 CRM_Utils_Array
::value('join_date', $params),
110 CRM_Utils_Array
::value('start_date', $params),
111 CRM_Utils_Array
::value('end_date', $params),
112 CRM_Utils_Array
::value('num_terms', $params, 1)
116 $calcDates = CRM_Member_BAO_MembershipType
::getRenewalDatesForMembershipType(
119 CRM_Utils_Array
::value('membership_type_id', $params),
123 foreach (array('join_date', 'start_date', 'end_date') as $date) {
124 if (empty($params[$date]) && isset($calcDates[$date])) {
125 $params[$date] = $calcDates[$date];
130 // Fixme: This code belongs in the BAO
131 $action = CRM_Core_Action
::ADD
;
132 // we need user id during add mode
134 if (!empty($params['contact_id'])) {
135 $ids['userId'] = $params['contact_id'];
137 //for edit membership id should be present
138 // probably not required now.
139 if (!empty($params['id'])) {
140 $ids['membership'] = $params['id'];
141 $action = CRM_Core_Action
::UPDATE
;
143 //need to pass action to handle related memberships.
144 $params['action'] = $action;
146 $membershipBAO = CRM_Member_BAO_Membership
::create($params, $ids, TRUE);
148 if (array_key_exists('is_error', $membershipBAO)) {
149 // In case of no valid status for given dates, $membershipBAO
150 // is going to contain 'is_error' => "Error Message"
151 return civicrm_api3_create_error(ts('The membership can not be saved, no valid membership status for given dates'));
154 $membership = array();
155 _civicrm_api3_object_to_array($membershipBAO, $membership[$membershipBAO->id
]);
157 return civicrm_api3_create_success($membership, $params, 'Membership', 'create', $membershipBAO);
162 * Adjust Metadata for Create action.
164 * The metadata is used for setting defaults, documentation & validation.
166 * @param array $params
167 * Array of parameters determined by getfields.
169 function _civicrm_api3_membership_create_spec(&$params) {
170 $params['contact_id']['api.required'] = 1;
171 $params['membership_type_id']['api.required'] = 1;
172 $params['is_test']['api.default'] = 0;
173 $params['membership_type_id']['api.aliases'] = array('membership_type');
174 $params['status_id']['api.aliases'] = array('membership_status');
175 $params['skipStatusCal'] = array(
176 'title' => 'Skip status calculation',
177 'description' => 'By default this is 0 if id is not set and 1 if it is set.',
178 'type' => CRM_Utils_Type
::T_BOOLEAN
,
180 $params['num_terms'] = array(
181 'title' => 'Number of terms',
182 'description' => 'Terms to add/renew. If this parameter is passed, dates will be calculated automatically. If no id is passed (new membership) and no dates are given, num_terms will be assumed to be 1.',
183 'type' => CRM_Utils_Type
::T_INT
,
188 * Adjust Metadata for Get action.
190 * The metadata is used for setting defaults, documentation & validation.
192 * @param array $params
193 * Array of parameters determined by getfields.
195 function _civicrm_api3_membership_get_spec(&$params) {
196 $params['membership_type_id']['api.aliases'] = array('membership_type');
197 $params['active_only'] = array(
198 'title' => 'Active Only',
199 'description' => 'Only retrieve active memberships',
200 'type' => CRM_Utils_Type
::T_BOOLEAN
,
205 * Get contact Membership record.
207 * This api will return the membership records for the contacts
208 * having membership based on the relationship with the direct members.
210 * @param array $params
211 * Key/value pairs for contact_id and some.
212 * options affecting the desired results; has legacy support
213 * for just passing the contact_id itself as the argument
216 * Array of all found membership property values.
218 function civicrm_api3_membership_get($params) {
219 $activeOnly = $membershipTypeId = $membershipType = NULL;
221 $contactID = CRM_Utils_Array
::value('contact_id', $params);
222 if (!empty($params['filters']) && is_array($params['filters']) && isset($params['filters']['is_current'])) {
223 $activeOnly = $params['filters']['is_current'];
224 unset($params['filters']['is_current']);
226 $activeOnly = CRM_Utils_Array
::value('active_only', $params, $activeOnly);
227 if ($activeOnly && empty($params['status_id'])) {
228 $params['status_id'] = array('IN' => CRM_Member_BAO_MembershipStatus
::getMembershipStatusCurrent());
231 $options = _civicrm_api3_get_options_from_params($params, TRUE, 'Membership', 'get');
232 if ($options['is_count']) {
233 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
235 $membershipValues = _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params, FALSE, 'Membership');
237 $return = $options['return'];
238 if (empty($membershipValues) ||
240 && !array_key_exists('related_contact_id', $return)
241 && !array_key_exists('relationship_name', $return)
244 return civicrm_api3_create_success($membershipValues, $params, 'Membership', 'get');
247 $members = _civicrm_api3_membership_relationsship_get_customv2behaviour($params, $membershipValues, $contactID);
248 return civicrm_api3_create_success($members, $params, 'Membership', 'get');
252 * Perform api v2 custom behaviour.
254 * When we copied apiv3 from api v2 we brought across some custom behaviours - in the case of
255 * membership a complicated return array is constructed. The original
256 * behaviour made contact_id a required field. We still need to keep this for v3 when contact_id
257 * is passed in as part of the reasonable expectation developers have that we will keep the api
258 * as stable as possible
260 * @param array $params
261 * Parameters passed into get function.
262 * @param int $membershipTypeId
266 * result for calling function
268 function _civicrm_api3_membership_get_customv2behaviour(&$params, $membershipTypeId, $activeOnly) {
269 // get the membership for the given contact ID
270 $membershipParams = array('contact_id' => $params['contact_id']);
271 if ($membershipTypeId) {
272 $membershipParams['membership_type_id'] = $membershipTypeId;
274 $membershipValues = array();
275 CRM_Member_BAO_Membership
::getValues($membershipParams, $membershipValues, $activeOnly);
276 return $membershipValues;
281 * Non-standard behaviour inherited from v2.
283 * @param array $params
284 * Parameters passed into get function.
285 * @param $membershipValues
286 * @param int $contactID
289 * result for calling function
291 function _civicrm_api3_membership_relationsship_get_customv2behaviour(&$params, $membershipValues, $contactID) {
292 $relationships = array();
293 foreach ($membershipValues as $membershipId => $values) {
294 // populate the membership type name for the membership type id
295 $membershipType = CRM_Member_BAO_MembershipType
::getMembershipTypeDetails($values['membership_type_id']);
297 $membershipValues[$membershipId]['membership_name'] = $membershipType['name'];
299 if (!empty($membershipType['relationship_type_id'])) {
300 $relationships[$membershipType['relationship_type_id']] = $membershipId;
303 // populating relationship type name.
304 $relationshipType = new CRM_Contact_BAO_RelationshipType();
305 $relationshipType->id
= CRM_Utils_Array
::value('relationship_type_id', $membershipType);
306 if ($relationshipType->find(TRUE)) {
307 $membershipValues[$membershipId]['relationship_name'] = $relationshipType->name_a_b
;
310 _civicrm_api3_custom_data_get($membershipValues[$membershipId], CRM_Utils_Array
::value('check_permissions', $params), 'Membership', $membershipId, NULL, $values['membership_type_id']);
313 $members = $membershipValues;
315 // Populating contacts in members array based on their relationship with direct members.
316 if (!empty($relationships)) {
317 foreach ($relationships as $relTypeId => $membershipId) {
318 // As members are not direct members, there should not be
319 // membership id in the result array.
320 unset($membershipValues[$membershipId]['id']);
321 $relationship = new CRM_Contact_BAO_Relationship();
322 $relationship->contact_id_b
= $contactID;
323 $relationship->relationship_type_id
= $relTypeId;
324 if ($relationship->find()) {
325 while ($relationship->fetch()) {
326 clone($relationship);
327 $membershipValues[$membershipId]['contact_id'] = $relationship->contact_id_a
;
328 $members[$membershipId]['related_contact_id'] = $relationship->contact_id_a
;