CRM/Member/BAO/MembershipStatus.php

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