CRM/Member/BAO/MembershipStatus.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  * @package CRM
  15  * @copyright CiviCRM LLC https://civicrm.org/licensing
  16  * $Id$
  17  *
  18  */
  19 class CRM_Member_BAO_MembershipStatus extends CRM_Member_DAO_MembershipStatus {
  20
  21   /**
  22    * Static holder for the default LT.
  23    * @var int
  24    */
  25   public static $_defaultMembershipStatus = NULL;
  26
  27   /**
  28    * Class constructor.
  29    */
  30   public function __construct() {
  31     parent::__construct();
  32   }
  33
  34   /**
  35    * Fetch object based on array of properties.
  36    *
  37    * @param array $params
  38    *   (reference ) an assoc array of name/value pairs.
  39    * @param array $defaults
  40    *   (reference ) an assoc array to hold the flattened values.
  41    *
  42    * @return CRM_Member_BAO_MembershipStatus
  43    */
  44   public static function retrieve(&$params, &$defaults) {
  45     $membershipStatus = new CRM_Member_DAO_MembershipStatus();
  46     $membershipStatus->copyValues($params);
  47     if ($membershipStatus->find(TRUE)) {
  48       CRM_Core_DAO::storeValues($membershipStatus, $defaults);
  49       return $membershipStatus;
  50     }
  51     return NULL;
  52   }
  53
  54   /**
  55    * Update the is_active flag in the db.
  56    *
  57    * @param int $id
  58    *   Id of the database record.
  59    * @param bool $is_active
  60    *   Value we want to set the is_active field.
  61    *
  62    * @return bool
  63    *   true if we found and updated the object, else false
  64    */
  65   public static function setIsActive($id, $is_active) {
  66     return CRM_Core_DAO::setFieldValue('CRM_Member_DAO_MembershipStatus', $id, 'is_active', $is_active);
  67   }
  68
  69   /**
  70    * Takes an associative array and creates a membership Status object.
  71    * See http://wiki.civicrm.org/confluence/display/CRM/Database+layer
  72    *
  73    * @param array $params
  74    *   (reference ) an assoc array of name/value pairs.
  75    *
  76    * @throws Exception
  77    * @return CRM_Member_BAO_MembershipStatus
  78    */
  79   public static function create($params) {
  80     $ids = [];
  81     if (!empty($params['id'])) {
  82       $ids['membershipStatus'] = $params['id'];
  83     }
  84     else {
  85       //don't allow duplicate names - if id not set
  86       $status = new CRM_Member_DAO_MembershipStatus();
  87       $status->name = $params['name'];
  88       if ($status->find(TRUE)) {
  89         throw new Exception('A membership status with this name already exists.');
  90       }
  91     }
  92     $membershipStatusBAO = CRM_Member_BAO_MembershipStatus::add($params, $ids);
  93     return $membershipStatusBAO;
  94   }
  95
  96   /**
  97    * Add the membership types.
  98    *
  99    * @param array $params
 100    *   Reference array contains the values submitted by the form.
 101    * @param array $ids
 102    *   Array contains the id - this param is deprecated.
 103    *
 104    *
 105    * @return object
 106    */
 107   public static function add(&$params, $ids = []) {
 108     $id = $params['id'] ?? $ids['membershipStatus'] ?? NULL;
 109     if (!$id) {
 110       CRM_Core_DAO::setCreateDefaults($params, self::getDefaults());
 111       //copy name to label when not passed.
 112       if (empty($params['label']) && !empty($params['name'])) {
 113         $params['label'] = $params['name'];
 114       }
 115
 116       if (empty($params['name']) && !empty($params['label'])) {
 117         $params['name'] = $params['label'];
 118       }
 119     }
 120
 121     // set all other defaults to false.
 122     if (!empty($params['is_default'])) {
 123       $query = "UPDATE civicrm_membership_status SET is_default = 0";
 124       CRM_Core_DAO::executeQuery($query);
 125     }
 126
 127     // action is taken depending upon the mode
 128     $membershipStatus = new CRM_Member_DAO_MembershipStatus();
 129     $membershipStatus->copyValues($params);
 130
 131     $membershipStatus->id = $id;
 132
 133     $membershipStatus->save();
 134     CRM_Member_PseudoConstant::flush('membershipStatus');
 135     return $membershipStatus;
 136   }
 137
 138   /**
 139    * Get defaults for new entity.
 140    * @return array
 141    */
 142   public static function getDefaults() {
 143     return [
 144       'is_active' => FALSE,
 145       'is_current_member' => FALSE,
 146       'is_admin' => FALSE,
 147       'is_default' => FALSE,
 148     ];
 149   }
 150
 151   /**
 152    * Get  membership status.
 153    *
 154    * @param int $membershipStatusId
 155    *
 156    * @return array
 157    */
 158   public static function getMembershipStatus($membershipStatusId) {
 159     $statusDetails = [];
 160     $membershipStatus = new CRM_Member_DAO_MembershipStatus();
 161     $membershipStatus->id = $membershipStatusId;
 162     if ($membershipStatus->find(TRUE)) {
 163       CRM_Core_DAO::storeValues($membershipStatus, $statusDetails);
 164     }
 165     return $statusDetails;
 166   }
 167
 168   /**
 169    * Delete membership Types.
 170    *
 171    * @param int $membershipStatusId
 172    *
 173    * @throws CRM_Core_Exception
 174    */
 175   public static function del($membershipStatusId) {
 176     //check dependencies
 177     //checking if membership status is present in some other table
 178     $check = FALSE;
 179
 180     $dependency = ['Membership', 'MembershipLog'];
 181     foreach ($dependency as $name) {
 182       $baoString = 'CRM_Member_BAO_' . $name;
 183       $dao = new $baoString();
 184       $dao->status_id = $membershipStatusId;
 185       if ($dao->find(TRUE)) {
 186         throw new CRM_Core_Exception(ts('This membership status cannot be deleted as memberships exist with this status'));
 187       }
 188     }
 189     CRM_Utils_Weight::delWeight('CRM_Member_DAO_MembershipStatus', $membershipStatusId);
 190     //delete from membership Type table
 191     $membershipStatus = new CRM_Member_DAO_MembershipStatus();
 192     $membershipStatus->id = $membershipStatusId;
 193     if (!$membershipStatus->find()) {
 194       throw new CRM_Core_Exception(ts('Cannot delete membership status ' . $membershipStatusId));
 195     }
 196     $membershipStatus->delete();
 197     CRM_Member_PseudoConstant::flush('membershipStatus');
 198   }
 199
 200   /**
 201    * Find the membership status based on start date, end date, join date & status date.
 202    *
 203    * @param string $startDate
 204    *   Start date of the member whose membership status is to be calculated.
 205    * @param string $endDate
 206    *   End date of the member whose membership status is to be calculated.
 207    * @param string $joinDate
 208    *   Join date of the member whose membership status is to be calculated.
 209    * @param \date|string $statusDate status date of the member whose membership status is to be calculated.
 210    * @param bool $excludeIsAdmin the statuses those having is_admin = 1.
 211    *   Exclude the statuses those having is_admin = 1.
 212    * @param int $membershipTypeID
 213    * @param array $membership
 214    *   Membership params as available to calling function - passed to the hook.
 215    *
 216    * @return array
 217    */
 218   public static function getMembershipStatusByDate(
 219     $startDate, $endDate, $joinDate,
 220     $statusDate = 'today', $excludeIsAdmin = FALSE, $membershipTypeID, $membership = []
 221   ) {
 222     $membershipDetails = [];
 223
 224     if (!$statusDate || $statusDate == 'today') {
 225       $statusDate = getdate();
 226       $statusDate = date('Ymd',
 227         mktime($statusDate['hours'],
 228           $statusDate['minutes'],
 229           $statusDate['seconds'],
 230           $statusDate['mon'],
 231           $statusDate['mday'],
 232           $statusDate['year']
 233         )
 234       );
 235     }
 236     else {
 237       $statusDate = CRM_Utils_Date::customFormat($statusDate, '%Y%m%d');
 238     }
 239
 240     $dates = ['start', 'end', 'join'];
 241     $events = ['start', 'end'];
 242
 243     foreach ($dates as $dat) {
 244       if (${$dat . 'Date'} && ${$dat . 'Date'} != "null") {
 245         ${$dat . 'Date'} = CRM_Utils_Date::customFormat(${$dat . 'Date'}, '%Y%m%d');
 246
 247         ${$dat . 'Year'} = substr(${$dat . 'Date'}, 0, 4);
 248
 249         ${$dat . 'Month'} = substr(${$dat . 'Date'}, 4, 2);
 250
 251         ${$dat . 'Day'} = substr(${$dat . 'Date'}, 6, 2);
 252       }
 253       else {
 254         ${$dat . 'Date'} = '';
 255       }
 256     }
 257
 258     //fix for CRM-3570, if we have statuses with is_admin=1,
 259     //exclude these statuses from calculatation during import.
 260     $where = "is_active = 1";
 261     if ($excludeIsAdmin) {
 262       $where .= " AND is_admin != 1";
 263     }
 264
 265     $query = "
 266  SELECT   *
 267  FROM     civicrm_membership_status
 268  WHERE    {$where}
 269  ORDER BY weight ASC";
 270
 271     $membershipStatus = CRM_Core_DAO::executeQuery($query);
 272     $hour = $minute = $second = 0;
 273
 274     while ($membershipStatus->fetch()) {
 275       $startEvent = NULL;
 276       $endEvent = NULL;
 277       foreach ($events as $eve) {
 278         foreach ($dates as $dat) {
 279           // calculate start-event/date and end-event/date
 280           if (($membershipStatus->{$eve . '_event'} == $dat . '_date') &&
 281             ${$dat . 'Date'}
 282           ) {
 283             if ($membershipStatus->{$eve . '_event_adjust_unit'} &&
 284               $membershipStatus->{$eve . '_event_adjust_interval'}
 285             ) {
 286               // add in months
 287               if ($membershipStatus->{$eve . '_event_adjust_unit'} == 'month') {
 288                 ${$eve . 'Event'} = date('Ymd', mktime($hour, $minute, $second,
 289                   ${$dat . 'Month'} + $membershipStatus->{$eve . '_event_adjust_interval'},
 290                   ${$dat . 'Day'},
 291                   ${$dat . 'Year'}
 292                 ));
 293               }
 294               // add in days
 295               if ($membershipStatus->{$eve . '_event_adjust_unit'} == 'day') {
 296                 ${$eve . 'Event'} = date('Ymd', mktime($hour, $minute, $second,
 297                   ${$dat . 'Month'},
 298                   ${$dat . 'Day'} + $membershipStatus->{$eve . '_event_adjust_interval'},
 299                   ${$dat . 'Year'}
 300                 ));
 301               }
 302               // add in years
 303               if ($membershipStatus->{$eve . '_event_adjust_unit'} == 'year') {
 304                 ${$eve . 'Event'} = date('Ymd', mktime($hour, $minute, $second,
 305                   ${$dat . 'Month'},
 306                   ${$dat . 'Day'},
 307                   ${$dat . 'Year'} + $membershipStatus->{$eve . '_event_adjust_interval'}
 308                 ));
 309               }
 310               // if no interval and unit, present
 311             }
 312             else {
 313               ${$eve . 'Event'} = ${$dat . 'Date'};
 314             }
 315           }
 316         }
 317       }
 318
 319       // check if statusDate is in the range of start & end events.
 320       if ($startEvent && $endEvent) {
 321         if (($statusDate >= $startEvent) && ($statusDate <= $endEvent)) {
 322           $membershipDetails['id'] = $membershipStatus->id;
 323           $membershipDetails['name'] = $membershipStatus->name;
 324         }
 325       }
 326       elseif ($startEvent) {
 327         if ($statusDate >= $startEvent) {
 328           $membershipDetails['id'] = $membershipStatus->id;
 329           $membershipDetails['name'] = $membershipStatus->name;
 330         }
 331       }
 332       elseif ($endEvent) {
 333         if ($statusDate <= $endEvent) {
 334           $membershipDetails['id'] = $membershipStatus->id;
 335           $membershipDetails['name'] = $membershipStatus->name;
 336         }
 337       }
 338
 339       // returns FIRST status record for which status_date is in range.
 340       if ($membershipDetails) {
 341         break;
 342       }
 343     }
 344     //end fetch
 345
 346     //we bundle the arguments into an array as we can't pass 8 variables to the hook otherwise
 347     // the membership array might contain the pre-altered settings so we don't want to merge this
 348     $arguments = [
 349       'start_date' => $startDate,
 350       'end_date' => $endDate,
 351       'join_date' => $joinDate,
 352       'status_date' => $statusDate,
 353       'exclude_is_admin' => $endDate,
 354       'membership_type_id' => $membershipTypeID,
 355       'start_event' => $startEvent,
 356       'end_event' => $endEvent,
 357     ];
 358     CRM_Utils_Hook::alterCalculatedMembershipStatus($membershipDetails, $arguments, $membership);
 359     return $membershipDetails;
 360   }
 361
 362   /**
 363    * Function that return the status ids whose is_current_member is set.
 364    *
 365    * @return array
 366    */
 367   public static function getMembershipStatusCurrent() {
 368     $statusIds = [];
 369     $membershipStatus = new CRM_Member_DAO_MembershipStatus();
 370     $membershipStatus->is_current_member = 1;
 371     $membershipStatus->find();
 372     $membershipStatus->selectAdd();
 373     $membershipStatus->selectAdd('id');
 374     while ($membershipStatus->fetch()) {
 375       $statusIds[] = $membershipStatus->id;
 376     }
 377     return $statusIds;
 378   }
 379
 380 }