CRM/Member/BAO/MembershipStatus.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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-2014
  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 (empty($params['label']) && !empty($params['name'])) {
 138       $params['label'] = $params['name'];
 139     }
 140
 141     //for add mode, copy label to name.
 142     $statusId = CRM_Utils_Array::value('membershipStatus', $ids);
 143     if (!$statusId && !empty($params['label']) && empty($params['name'])) {
 144       $params['name'] = $params['label'];
 145     }
 146
 147     // action is taken depending upon the mode
 148     $membershipStatus = new CRM_Member_DAO_MembershipStatus();
 149     $membershipStatus->copyValues($params);
 150
 151     $membershipStatus->id = $statusId;
 152
 153     $membershipStatus->save();
 154     return $membershipStatus;
 155   }
 156
 157   /**
 158    * Function to get  membership status
 159    *
 160    * @param int $membershipStatusId
 161    * @static
 162    */
 163   public static function getMembershipStatus($membershipStatusId) {
 164     $statusDetails = array();
 165     $membershipStatus = new CRM_Member_DAO_MembershipStatus();
 166     $membershipStatus->id = $membershipStatusId;
 167     if ($membershipStatus->find(TRUE)) {
 168       CRM_Core_DAO::storeValues($membershipStatus, $statusDetails);
 169     }
 170     return $statusDetails;
 171   }
 172
 173   /**
 174    * Function to delete membership Types
 175    *
 176    * @param int $membershipStatusId
 177    * @param
 178    * @static
 179    */
 180   static function del($membershipStatusId) {
 181     //check dependencies
 182     //checking if membership status is present in some other table
 183     $check = FALSE;
 184
 185     $dependancy = array('Membership', 'MembershipLog');
 186     foreach ($dependancy as $name) {
 187       $baoString = 'CRM_Member_BAO_' . $name;
 188       $dao = new $baoString();
 189       $dao->status_id = $membershipStatusId;
 190       if ($dao->find(TRUE)) {
 191         throw new CRM_Core_Exception(ts('This membership status cannot be deleted as memberships exist with this status'));
 192       }
 193     }
 194     CRM_Utils_Weight::delWeight('CRM_Member_DAO_MembershipStatus', $membershipStatusId);
 195     //delete from membership Type table
 196     $membershipStatus = new CRM_Member_DAO_MembershipStatus();
 197     $membershipStatus->id = $membershipStatusId;
 198     $membershipStatus->delete();
 199     $membershipStatus->free();
 200   }
 201
 202   /**
 203    * Function to find the membership status based on start date, end date, join date & status date.
 204    *
 205    * @param  date    $startDate      start date of the member whose membership status is to be calculated.
 206    * @param  date    $endDate        end date of the member whose membership status is to be calculated.
 207    * @param  date    $joinDate       join date of the member whose membership status is to be calculated.
 208    * @param  date    $statusDate     status date of the member whose membership status is to be calculated.
 209    * @param  boolean $excludeIsAdmin exclude the statuses those having is_admin = 1
 210    *
 211    * @return
 212    * @static
 213    */
 214   static function getMembershipStatusByDate($startDate, $endDate, $joinDate,
 215     $statusDate = 'today', $excludeIsAdmin = FALSE
 216   ) {
 217     $membershipDetails = array();
 218     if (!$statusDate || $statusDate == 'today') {
 219       $statusDate = getDate();
 220       $statusDate = date('Ymd',
 221         mktime($statusDate['hours'],
 222           $statusDate['minutes'],
 223           $statusDate['seconds'],
 224           $statusDate['mon'],
 225           $statusDate['mday'],
 226           $statusDate['year']
 227         )
 228       );
 229     }
 230     else {
 231       $statusDate = CRM_Utils_Date::customFormat($statusDate, '%Y%m%d');
 232     }
 233
 234     $dates = array('start', 'end', 'join');
 235     $events = array('start', 'end');
 236
 237     foreach ($dates as $dat) {
 238       if (${$dat . 'Date'} && ${$dat . 'Date'} != "null") {
 239         ${$dat . 'Date'} = CRM_Utils_Date::customFormat(${$dat . 'Date'}, '%Y%m%d');
 240
 241         ${$dat . 'Year'} = substr(${$dat . 'Date'}, 0, 4);
 242
 243         ${$dat . 'Month'} = substr(${$dat . 'Date'}, 4, 2);
 244
 245         ${$dat . 'Day'} = substr(${$dat . 'Date'}, 6, 2);
 246       }
 247       else {
 248         ${$dat . 'Date'} = '';
 249       }
 250     }
 251
 252     //fix for CRM-3570, if we have statuses with is_admin=1,
 253     //exclude these statuses from calculatation during import.
 254     $where = "is_active = 1";
 255     if ($excludeIsAdmin) {
 256       $where .= " AND is_admin != 1";
 257     }
 258
 259     $query = "
 260  SELECT   *
 261  FROM     civicrm_membership_status
 262  WHERE    {$where}
 263  ORDER BY weight ASC";
 264
 265     $membershipStatus = CRM_Core_DAO::executeQuery($query, CRM_Core_DAO::$_nullArray);
 266     $hour = $minute = $second = 0;
 267
 268     while ($membershipStatus->fetch()) {
 269       $startEvent = NULL;
 270       $endEvent = NULL;
 271       foreach ($events as $eve) {
 272         foreach ($dates as $dat) {
 273           // calculate start-event/date and end-event/date
 274           if (($membershipStatus->{$eve . '_event'} == $dat . '_date') &&
 275             ${$dat . 'Date'}
 276           ) {
 277             if ($membershipStatus->{$eve . '_event_adjust_unit'} &&
 278               $membershipStatus->{$eve . '_event_adjust_interval'}
 279             ) {
 280               // add in months
 281               if ($membershipStatus->{$eve . '_event_adjust_unit'} == 'month') {
 282                 ${$eve . 'Event'} = date('Ymd', mktime($hour, $minute, $second,
 283                     ${$dat . 'Month'} + $membershipStatus->{$eve . '_event_adjust_interval'},
 284                     ${$dat . 'Day'},
 285                     ${$dat . 'Year'}
 286                   ));
 287               }
 288               // add in days
 289               if ($membershipStatus->{$eve . '_event_adjust_unit'} == 'day') {
 290                 ${$eve . 'Event'} = date('Ymd', mktime($hour, $minute, $second,
 291                     ${$dat . 'Month'},
 292                     ${$dat . 'Day'} + $membershipStatus->{$eve . '_event_adjust_interval'},
 293                     ${$dat . 'Year'}
 294                   ));
 295               }
 296               // add in years
 297               if ($membershipStatus->{$eve . '_event_adjust_unit'} == 'year') {
 298                 ${$eve . 'Event'} = date('Ymd', mktime($hour, $minute, $second,
 299                     ${$dat . 'Month'},
 300                     ${$dat . 'Day'},
 301                     ${$dat . 'Year'} + $membershipStatus->{$eve . '_event_adjust_interval'}
 302                   ));
 303               }
 304               // if no interval and unit, present
 305             }
 306             else {
 307               ${$eve . 'Event'} = ${$dat . 'Date'};
 308             }
 309           }
 310         }
 311       }
 312
 313       // check if statusDate is in the range of start & end events.
 314       if ($startEvent && $endEvent) {
 315         if (($statusDate >= $startEvent) && ($statusDate <= $endEvent)) {
 316           $membershipDetails['id'] = $membershipStatus->id;
 317           $membershipDetails['name'] = $membershipStatus->name;
 318         }
 319       }
 320       elseif ($startEvent) {
 321         if ($statusDate >= $startEvent) {
 322           $membershipDetails['id'] = $membershipStatus->id;
 323           $membershipDetails['name'] = $membershipStatus->name;
 324         }
 325       }
 326       elseif ($endEvent) {
 327         if ($statusDate <= $endEvent) {
 328           $membershipDetails['id'] = $membershipStatus->id;
 329           $membershipDetails['name'] = $membershipStatus->name;
 330         }
 331       }
 332
 333       // returns FIRST status record for which status_date is in range.
 334       if ($membershipDetails) {
 335         $membershipStatus->free();
 336         return $membershipDetails;
 337       }
 338     }
 339     //end fetch
 340
 341     $membershipStatus->free();
 342     return $membershipDetails;
 343   }
 344
 345   /**
 346    * Function that return the status ids whose is_current_member is set
 347    *
 348    * @return
 349    * @static
 350    */
 351   public static function getMembershipStatusCurrent() {
 352     $statusIds = array();
 353     $membershipStatus = new CRM_Member_DAO_MembershipStatus();
 354     $membershipStatus->is_current_member = 1;
 355     $membershipStatus->find();
 356     $membershipStatus->selectAdd();
 357     $membershipStatus->selectAdd('id');
 358     while ($membershipStatus->fetch()) {
 359       $statusIds[] = $membershipStatus->id;
 360     }
 361     $membershipStatus->free();
 362     return $statusIds;
 363   }
 364 }
 365