api/v3/Membership.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  *
  14  * This api exposes CiviCRM membership contact records.
  15  *
  16  * @package CiviCRM_APIv3
  17  */
  18
  19 /**
  20  * Adjust Metadata for Delete action.
  21  *
  22  * The metadata is used for setting defaults, documentation & validation.
  23  *
  24  * @param array $params
  25  *   Array of parameters determined by getfields.
  26  */
  27 function _civicrm_api3_membership_delete_spec(&$params) {
  28   $params['preserve_contribution'] = [
  29     'api.required' => 0,
  30     'title' => 'Preserve Contribution',
  31     'description' => 'By default this is 0, or 0 if not set. Set to 1 to preserve the associated contribution record when membership is deleted.',
  32     'type' => CRM_Utils_Type::T_BOOLEAN,
  33   ];
  34 }
  35
  36 /**
  37  * Deletes an existing contact Membership.
  38  *
  39  * @param array $params
  40  *   Array array holding id - Id of the contact membership to be deleted.
  41  * @return array API result array.
  42  * @throws API_Exception
  43  */
  44 function civicrm_api3_membership_delete($params) {
  45   if (isset($params['preserve_contribution'])) {
  46     if (CRM_Member_BAO_Membership::del($params['id'], $params['preserve_contribution'])) {
  47       return civicrm_api3_create_success(TRUE, $params);
  48     }
  49     else {
  50       throw new API_Exception(ts('Could not delete membership'));
  51     }
  52   }
  53   else {
  54     return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  55   }
  56 }
  57
  58 /**
  59  * Create a Contact Membership.
  60  *
  61  * This API is used for creating a Membership for a contact.
  62  * Required parameters : membership_type_id and status_id.
  63  *
  64  * @param array $params
  65  *   Array of name/value property values of civicrm_membership.
  66  *
  67  * @return array
  68  *   API result array.
  69  *
  70  * @throws \CRM_Core_Exception
  71  * @throws \CiviCRM_API3_Exception
  72  */
  73 function civicrm_api3_membership_create($params) {
  74   // check params for membership id during update
  75   if (!empty($params['id']) && !isset($params['skipStatusCal'])) {
  76     // Don't calculate status on existing membership - expect API use to pass them in
  77     // or leave unchanged.
  78     $params['skipStatusCal'] = 1;
  79   }
  80   else {
  81     // also check for status id if override is set (during add/update)
  82     if (!empty($params['is_override']) && empty($params['status_id'])) {
  83       return civicrm_api3_create_error('Status ID required');
  84     }
  85   }
  86
  87   $values = [];
  88   _civicrm_api3_custom_format_params($params, $values, 'Membership');
  89   $params = array_merge($params, $values);
  90
  91   // Calculate membership dates
  92   // Fixme: This code belongs in the BAO
  93   if (empty($params['id']) || !empty($params['num_terms'])) {
  94     // If this is a new membership or we have a specified number of terms calculate membership dates.
  95     if (empty($params['id'])) {
  96       // This is a new membership, calculate the membership dates.
  97       $calcDates = CRM_Member_BAO_MembershipType::getDatesForMembershipType(
  98         $params['membership_type_id'],
  99         CRM_Utils_Array::value('join_date', $params),
 100         CRM_Utils_Array::value('start_date', $params),
 101         CRM_Utils_Array::value('end_date', $params),
 102         CRM_Utils_Array::value('num_terms', $params, 1)
 103       );
 104     }
 105     else {
 106       // This is an existing membership, calculate the membership dates after renewal
 107       // num_terms is treated as a 'special sauce' for is_renewal but this
 108       // isn't really helpful for completing pendings.
 109       $calcDates = CRM_Member_BAO_MembershipType::getRenewalDatesForMembershipType(
 110         $params['id'],
 111         NULL,
 112         CRM_Utils_Array::value('membership_type_id', $params),
 113         $params['num_terms']
 114       );
 115     }
 116     foreach (['join_date', 'start_date', 'end_date'] as $date) {
 117       if (empty($params[$date]) && isset($calcDates[$date])) {
 118         $params[$date] = $calcDates[$date];
 119       }
 120     }
 121   }
 122
 123   // Fixme: This code belongs in the BAO
 124   $ids = [];
 125   if (empty($params['id'])) {
 126     $params['action'] = CRM_Core_Action::ADD;
 127   }
 128   else {
 129     // edit mode
 130     $params['action'] = CRM_Core_Action::UPDATE;
 131     // @todo remove $ids['membership'] is required in CRM_Price_BAO_LineItem::processPriceSet
 132     $ids['membership'] = $params['id'];
 133   }
 134
 135   // @todo stop passing $ids (membership and userId may be set above)
 136   $membershipBAO = CRM_Member_BAO_Membership::create($params, $ids);
 137
 138   if (property_exists($membershipBAO, 'is_error')) {
 139     // In case of no valid status for given dates, $membershipBAO
 140     // is going to contain 'is_error' => "Error Message"
 141     return civicrm_api3_create_error(ts('The membership can not be saved, no valid membership status for given dates'));
 142   }
 143
 144   $membership = [];
 145   _civicrm_api3_object_to_array($membershipBAO, $membership[$membershipBAO->id]);
 146
 147   return civicrm_api3_create_success($membership, $params, 'Membership', 'create', $membershipBAO);
 148
 149 }
 150
 151 /**
 152  * Adjust Metadata for Create action.
 153  *
 154  * The metadata is used for setting defaults, documentation & validation.
 155  *
 156  * @param array $params
 157  *   Array of parameters determined by getfields.
 158  */
 159 function _civicrm_api3_membership_create_spec(&$params) {
 160   $params['contact_id']['api.required'] = 1;
 161   $params['membership_type_id']['api.required'] = 1;
 162   $params['is_test']['api.default'] = 0;
 163   $params['membership_type_id']['api.aliases'] = ['membership_type'];
 164   $params['status_id']['api.aliases'] = ['membership_status'];
 165   $params['skipStatusCal'] = [
 166     'title' => 'Skip status calculation',
 167     'description' => 'By default this is 0 if id is not set and 1 if it is set.',
 168     'type' => CRM_Utils_Type::T_BOOLEAN,
 169   ];
 170   $params['num_terms'] = [
 171     'title' => 'Number of terms',
 172     '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.',
 173     'type' => CRM_Utils_Type::T_INT,
 174   ];
 175 }
 176
 177 /**
 178  * Adjust Metadata for Get action.
 179  *
 180  * The metadata is used for setting defaults, documentation & validation.
 181  *
 182  * @param array $params
 183  *   Array of parameters determined by getfields.
 184  */
 185 function _civicrm_api3_membership_get_spec(&$params) {
 186   $params['membership_type_id']['api.aliases'] = ['membership_type'];
 187   $params['active_only'] = [
 188     'title' => 'Active Only',
 189     'description' => 'Only retrieve active memberships',
 190     'type' => CRM_Utils_Type::T_BOOLEAN,
 191   ];
 192 }
 193
 194 /**
 195  * Get contact Membership record.
 196  *
 197  * This api will return the membership records for the contacts
 198  * having membership based on the relationship with the direct members.
 199  *
 200  * @param array $params
 201  *   Key/value pairs for contact_id and some.
 202  *          options affecting the desired results; has legacy support
 203  *          for just passing the contact_id itself as the argument
 204  *
 205  * @return array
 206  *   Array of all found membership property values.
 207  */
 208 function civicrm_api3_membership_get($params) {
 209   $activeOnly = $membershipTypeId = $membershipType = NULL;
 210
 211   $contactID = $params['contact_id'] ?? NULL;
 212   if (!empty($params['filters']) && is_array($params['filters']) && isset($params['filters']['is_current'])) {
 213     $activeOnly = $params['filters']['is_current'];
 214     unset($params['filters']['is_current']);
 215   }
 216   $activeOnly = CRM_Utils_Array::value('active_only', $params, $activeOnly);
 217   if ($activeOnly && empty($params['status_id'])) {
 218     $params['status_id'] = ['IN' => CRM_Member_BAO_MembershipStatus::getMembershipStatusCurrent()];
 219   }
 220
 221   $options = _civicrm_api3_get_options_from_params($params, TRUE, 'Membership', 'get');
 222   if ($options['is_count']) {
 223     return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 224   }
 225   $membershipValues = _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, FALSE, 'Membership');
 226
 227   $return = $options['return'];
 228   if (empty($membershipValues) ||
 229     (!empty($return)
 230       && !array_key_exists('related_contact_id', $return)
 231       && !array_key_exists('relationship_name', $return)
 232     )
 233     ) {
 234     return civicrm_api3_create_success($membershipValues, $params, 'Membership', 'get');
 235   }
 236
 237   $members = _civicrm_api3_membership_relationsship_get_customv2behaviour($params, $membershipValues, $contactID);
 238   return civicrm_api3_create_success($members, $params, 'Membership', 'get');
 239 }
 240
 241 /**
 242  * Non-standard behaviour inherited from v2.
 243  *
 244  * @param array $params
 245  *   Parameters passed into get function.
 246  * @param array $membershipValues
 247  * @param int $contactID
 248  *
 249  * @return array
 250  *   result for calling function
 251  */
 252 function _civicrm_api3_membership_relationsship_get_customv2behaviour(&$params, $membershipValues, $contactID) {
 253   $relationships = [];
 254   foreach ($membershipValues as $membershipId => $values) {
 255     // populate the membership type name for the membership type id
 256     $membershipType = CRM_Member_BAO_MembershipType::getMembershipTypeDetails($values['membership_type_id']) ?? [];
 257
 258     if (!empty($membershipType)) {
 259       $membershipValues[$membershipId]['membership_name'] = $membershipType['name'];
 260
 261       if (!empty($membershipType['relationship_type_id'])) {
 262         $relationships[$membershipType['relationship_type_id']] = $membershipId;
 263       }
 264     }
 265
 266     // populating relationship type name.
 267     $relationshipType = new CRM_Contact_BAO_RelationshipType();
 268     $relationshipType->id = $membershipType['relationship_type_id'] ?? NULL;
 269     if ($relationshipType->find(TRUE)) {
 270       $membershipValues[$membershipId]['relationship_name'] = $relationshipType->name_a_b;
 271     }
 272
 273     _civicrm_api3_custom_data_get($membershipValues[$membershipId], CRM_Utils_Array::value('check_permissions', $params), 'Membership', $membershipId, NULL, $values['membership_type_id']);
 274   }
 275
 276   $members = $membershipValues;
 277
 278   // Populating contacts in members array based on their relationship with direct members.
 279   if (!empty($relationships)) {
 280     foreach ($relationships as $relTypeId => $membershipId) {
 281       // As members are not direct members, there should not be
 282       // membership id in the result array.
 283       unset($membershipValues[$membershipId]['id']);
 284       $relationship = new CRM_Contact_BAO_Relationship();
 285       $relationship->contact_id_b = $contactID;
 286       $relationship->relationship_type_id = $relTypeId;
 287       if ($relationship->find()) {
 288         while ($relationship->fetch()) {
 289           clone($relationship);
 290           $membershipValues[$membershipId]['contact_id'] = $relationship->contact_id_a;
 291           $members[$membershipId]['related_contact_id'] = $relationship->contact_id_a;
 292         }
 293       }
 294
 295     }
 296   }
 297   return $members;
 298 }