3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2019
35 class CRM_Member_BAO_MembershipStatus
extends CRM_Member_DAO_MembershipStatus
{
38 * Static holder for the default LT.
40 static $_defaultMembershipStatus = NULL;
45 public function __construct() {
46 parent
::__construct();
50 * Fetch object based on array of properties.
52 * @param array $params
53 * (reference ) an assoc array of name/value pairs.
54 * @param array $defaults
55 * (reference ) an assoc array to hold the flattened values.
57 * @return CRM_Member_BAO_MembershipStatus
59 public static function retrieve(&$params, &$defaults) {
60 $membershipStatus = new CRM_Member_DAO_MembershipStatus();
61 $membershipStatus->copyValues($params);
62 if ($membershipStatus->find(TRUE)) {
63 CRM_Core_DAO
::storeValues($membershipStatus, $defaults);
64 return $membershipStatus;
70 * Update the is_active flag in the db.
73 * Id of the database record.
74 * @param bool $is_active
75 * Value we want to set the is_active field.
78 * true if we found and updated the object, else false
80 public static function setIsActive($id, $is_active) {
81 return CRM_Core_DAO
::setFieldValue('CRM_Member_DAO_MembershipStatus', $id, 'is_active', $is_active);
85 * Takes an associative array and creates a membership Status object.
86 * See http://wiki.civicrm.org/confluence/display/CRM/Database+layer
88 * @param array $params
89 * (reference ) an assoc array of name/value pairs.
92 * @return CRM_Member_BAO_MembershipStatus
94 public static function create($params) {
96 if (!empty($params['id'])) {
97 $ids['membershipStatus'] = $params['id'];
100 //don't allow duplicate names - if id not set
101 $status = new CRM_Member_DAO_MembershipStatus();
102 $status->name
= $params['name'];
103 if ($status->find(TRUE)) {
104 throw new Exception('A membership status with this name already exists.');
107 $membershipStatusBAO = CRM_Member_BAO_MembershipStatus
::add($params, $ids);
108 return $membershipStatusBAO;
112 * Add the membership types.
114 * @param array $params
115 * Reference array contains the values submitted by the form.
117 * Array contains the id - this param is deprecated.
122 public static function add(&$params, $ids = array()) {
123 $id = CRM_Utils_Array
::value('id', $params, CRM_Utils_Array
::value('membershipStatus', $ids));
125 CRM_Core_DAO
::setCreateDefaults($params, self
::getDefaults());
126 //copy name to label when not passed.
127 if (empty($params['label']) && !empty($params['name'])) {
128 $params['label'] = $params['name'];
131 if (empty($params['name']) && !empty($params['label'])) {
132 $params['name'] = $params['label'];
136 // set all other defaults to false.
137 if (!empty($params['is_default'])) {
138 $query = "UPDATE civicrm_membership_status SET is_default = 0";
139 CRM_Core_DAO
::executeQuery($query,
140 CRM_Core_DAO
::$_nullArray
144 // action is taken depending upon the mode
145 $membershipStatus = new CRM_Member_DAO_MembershipStatus();
146 $membershipStatus->copyValues($params);
148 $membershipStatus->id
= $id;
150 $membershipStatus->save();
151 CRM_Member_PseudoConstant
::flush('membershipStatus');
152 return $membershipStatus;
156 * Get defaults for new entity.
159 public static function getDefaults() {
161 'is_active' => FALSE,
162 'is_current_member' => FALSE,
164 'is_default' => FALSE,
169 * Get membership status.
171 * @param int $membershipStatusId
175 public static function getMembershipStatus($membershipStatusId) {
176 $statusDetails = array();
177 $membershipStatus = new CRM_Member_DAO_MembershipStatus();
178 $membershipStatus->id
= $membershipStatusId;
179 if ($membershipStatus->find(TRUE)) {
180 CRM_Core_DAO
::storeValues($membershipStatus, $statusDetails);
182 return $statusDetails;
186 * Delete membership Types.
188 * @param int $membershipStatusId
190 * @throws CRM_Core_Exception
192 public static function del($membershipStatusId) {
194 //checking if membership status is present in some other table
197 $dependency = array('Membership', 'MembershipLog');
198 foreach ($dependency as $name) {
199 $baoString = 'CRM_Member_BAO_' . $name;
200 $dao = new $baoString();
201 $dao->status_id
= $membershipStatusId;
202 if ($dao->find(TRUE)) {
203 throw new CRM_Core_Exception(ts('This membership status cannot be deleted as memberships exist with this status'));
206 CRM_Utils_Weight
::delWeight('CRM_Member_DAO_MembershipStatus', $membershipStatusId);
207 //delete from membership Type table
208 $membershipStatus = new CRM_Member_DAO_MembershipStatus();
209 $membershipStatus->id
= $membershipStatusId;
210 if (!$membershipStatus->find()) {
211 throw new CRM_Core_Exception(ts('Cannot delete membership status ' . $membershipStatusId));
213 $membershipStatus->delete();
214 CRM_Member_PseudoConstant
::flush('membershipStatus');
218 * Find the membership status based on start date, end date, join date & status date.
220 * @param string $startDate
221 * Start date of the member whose membership status is to be calculated.
222 * @param string $endDate
223 * End date of the member whose membership status is to be calculated.
224 * @param string $joinDate
225 * Join date of the member whose membership status is to be calculated.
226 * @param \date|string $statusDate status date of the member whose membership status is to be calculated.
227 * @param bool $excludeIsAdmin the statuses those having is_admin = 1.
228 * Exclude the statuses those having is_admin = 1.
229 * @param int $membershipTypeID
230 * @param array $membership
231 * Membership params as available to calling function - passed to the hook.
235 public static function getMembershipStatusByDate(
236 $startDate, $endDate, $joinDate,
237 $statusDate = 'today', $excludeIsAdmin = FALSE, $membershipTypeID, $membership = array()
239 $membershipDetails = array();
241 if (!$statusDate ||
$statusDate == 'today') {
242 $statusDate = getdate();
243 $statusDate = date('Ymd',
244 mktime($statusDate['hours'],
245 $statusDate['minutes'],
246 $statusDate['seconds'],
254 $statusDate = CRM_Utils_Date
::customFormat($statusDate, '%Y%m%d');
257 $dates = array('start', 'end', 'join');
258 $events = array('start', 'end');
260 foreach ($dates as $dat) {
261 if ($
{$dat . 'Date'} && $
{$dat . 'Date'} != "null") {
262 $
{$dat . 'Date'} = CRM_Utils_Date
::customFormat($
{$dat . 'Date'}, '%Y%m%d');
264 $
{$dat . 'Year'} = substr($
{$dat . 'Date'}, 0, 4);
266 $
{$dat . 'Month'} = substr($
{$dat . 'Date'}, 4, 2);
268 $
{$dat . 'Day'} = substr($
{$dat . 'Date'}, 6, 2);
271 $
{$dat . 'Date'} = '';
275 //fix for CRM-3570, if we have statuses with is_admin=1,
276 //exclude these statuses from calculatation during import.
277 $where = "is_active = 1";
278 if ($excludeIsAdmin) {
279 $where .= " AND is_admin != 1";
284 FROM civicrm_membership_status
286 ORDER BY weight ASC";
288 $membershipStatus = CRM_Core_DAO
::executeQuery($query);
289 $hour = $minute = $second = 0;
291 while ($membershipStatus->fetch()) {
294 foreach ($events as $eve) {
295 foreach ($dates as $dat) {
296 // calculate start-event/date and end-event/date
297 if (($membershipStatus->{$eve . '_event'} == $dat . '_date') &&
300 if ($membershipStatus->{$eve . '_event_adjust_unit'} &&
301 $membershipStatus->{$eve . '_event_adjust_interval'}
304 if ($membershipStatus->{$eve . '_event_adjust_unit'} == 'month') {
305 $
{$eve . 'Event'} = date('Ymd', mktime($hour, $minute, $second,
306 $
{$dat . 'Month'} +
$membershipStatus->{$eve . '_event_adjust_interval'},
312 if ($membershipStatus->{$eve . '_event_adjust_unit'} == 'day') {
313 $
{$eve . 'Event'} = date('Ymd', mktime($hour, $minute, $second,
315 $
{$dat . 'Day'} +
$membershipStatus->{$eve . '_event_adjust_interval'},
320 if ($membershipStatus->{$eve . '_event_adjust_unit'} == 'year') {
321 $
{$eve . 'Event'} = date('Ymd', mktime($hour, $minute, $second,
324 $
{$dat . 'Year'} +
$membershipStatus->{$eve . '_event_adjust_interval'}
327 // if no interval and unit, present
330 $
{$eve . 'Event'} = $
{$dat . 'Date'};
336 // check if statusDate is in the range of start & end events.
337 if ($startEvent && $endEvent) {
338 if (($statusDate >= $startEvent) && ($statusDate <= $endEvent)) {
339 $membershipDetails['id'] = $membershipStatus->id
;
340 $membershipDetails['name'] = $membershipStatus->name
;
343 elseif ($startEvent) {
344 if ($statusDate >= $startEvent) {
345 $membershipDetails['id'] = $membershipStatus->id
;
346 $membershipDetails['name'] = $membershipStatus->name
;
350 if ($statusDate <= $endEvent) {
351 $membershipDetails['id'] = $membershipStatus->id
;
352 $membershipDetails['name'] = $membershipStatus->name
;
356 // returns FIRST status record for which status_date is in range.
357 if ($membershipDetails) {
363 //we bundle the arguments into an array as we can't pass 8 variables to the hook otherwise
364 // the membership array might contain the pre-altered settings so we don't want to merge this
366 'start_date' => $startDate,
367 'end_date' => $endDate,
368 'join_date' => $joinDate,
369 'status_date' => $statusDate,
370 'exclude_is_admin' => $endDate,
371 'membership_type_id' => $membershipTypeID,
372 'start_event' => $startEvent,
373 'end_event' => $endEvent,
375 CRM_Utils_Hook
::alterCalculatedMembershipStatus($membershipDetails, $arguments, $membership);
376 return $membershipDetails;
380 * Function that return the status ids whose is_current_member is set.
384 public static function getMembershipStatusCurrent() {
385 $statusIds = array();
386 $membershipStatus = new CRM_Member_DAO_MembershipStatus();
387 $membershipStatus->is_current_member
= 1;
388 $membershipStatus->find();
389 $membershipStatus->selectAdd();
390 $membershipStatus->selectAdd('id');
391 while ($membershipStatus->fetch()) {
392 $statusIds[] = $membershipStatus->id
;