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.
41 public static $_defaultMembershipStatus = NULL;
46 public function __construct() {
47 parent
::__construct();
51 * Fetch object based on array of properties.
53 * @param array $params
54 * (reference ) an assoc array of name/value pairs.
55 * @param array $defaults
56 * (reference ) an assoc array to hold the flattened values.
58 * @return CRM_Member_BAO_MembershipStatus
60 public static function retrieve(&$params, &$defaults) {
61 $membershipStatus = new CRM_Member_DAO_MembershipStatus();
62 $membershipStatus->copyValues($params);
63 if ($membershipStatus->find(TRUE)) {
64 CRM_Core_DAO
::storeValues($membershipStatus, $defaults);
65 return $membershipStatus;
71 * Update the is_active flag in the db.
74 * Id of the database record.
75 * @param bool $is_active
76 * Value we want to set the is_active field.
79 * true if we found and updated the object, else false
81 public static function setIsActive($id, $is_active) {
82 return CRM_Core_DAO
::setFieldValue('CRM_Member_DAO_MembershipStatus', $id, 'is_active', $is_active);
86 * Takes an associative array and creates a membership Status object.
87 * See http://wiki.civicrm.org/confluence/display/CRM/Database+layer
89 * @param array $params
90 * (reference ) an assoc array of name/value pairs.
93 * @return CRM_Member_BAO_MembershipStatus
95 public static function create($params) {
97 if (!empty($params['id'])) {
98 $ids['membershipStatus'] = $params['id'];
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.');
108 $membershipStatusBAO = CRM_Member_BAO_MembershipStatus
::add($params, $ids);
109 return $membershipStatusBAO;
113 * Add the membership types.
115 * @param array $params
116 * Reference array contains the values submitted by the form.
118 * Array contains the id - this param is deprecated.
123 public static function add(&$params, $ids = []) {
124 $id = CRM_Utils_Array
::value('id', $params, CRM_Utils_Array
::value('membershipStatus', $ids));
126 CRM_Core_DAO
::setCreateDefaults($params, self
::getDefaults());
127 //copy name to label when not passed.
128 if (empty($params['label']) && !empty($params['name'])) {
129 $params['label'] = $params['name'];
132 if (empty($params['name']) && !empty($params['label'])) {
133 $params['name'] = $params['label'];
137 // set all other defaults to false.
138 if (!empty($params['is_default'])) {
139 $query = "UPDATE civicrm_membership_status SET is_default = 0";
140 CRM_Core_DAO
::executeQuery($query);
143 // action is taken depending upon the mode
144 $membershipStatus = new CRM_Member_DAO_MembershipStatus();
145 $membershipStatus->copyValues($params);
147 $membershipStatus->id
= $id;
149 $membershipStatus->save();
150 CRM_Member_PseudoConstant
::flush('membershipStatus');
151 return $membershipStatus;
155 * Get defaults for new entity.
158 public static function getDefaults() {
160 'is_active' => FALSE,
161 'is_current_member' => FALSE,
163 'is_default' => FALSE,
168 * Get membership status.
170 * @param int $membershipStatusId
174 public static function getMembershipStatus($membershipStatusId) {
176 $membershipStatus = new CRM_Member_DAO_MembershipStatus();
177 $membershipStatus->id
= $membershipStatusId;
178 if ($membershipStatus->find(TRUE)) {
179 CRM_Core_DAO
::storeValues($membershipStatus, $statusDetails);
181 return $statusDetails;
185 * Delete membership Types.
187 * @param int $membershipStatusId
189 * @throws CRM_Core_Exception
191 public static function del($membershipStatusId) {
193 //checking if membership status is present in some other table
196 $dependency = ['Membership', 'MembershipLog'];
197 foreach ($dependency as $name) {
198 $baoString = 'CRM_Member_BAO_' . $name;
199 $dao = new $baoString();
200 $dao->status_id
= $membershipStatusId;
201 if ($dao->find(TRUE)) {
202 throw new CRM_Core_Exception(ts('This membership status cannot be deleted as memberships exist with this status'));
205 CRM_Utils_Weight
::delWeight('CRM_Member_DAO_MembershipStatus', $membershipStatusId);
206 //delete from membership Type table
207 $membershipStatus = new CRM_Member_DAO_MembershipStatus();
208 $membershipStatus->id
= $membershipStatusId;
209 if (!$membershipStatus->find()) {
210 throw new CRM_Core_Exception(ts('Cannot delete membership status ' . $membershipStatusId));
212 $membershipStatus->delete();
213 CRM_Member_PseudoConstant
::flush('membershipStatus');
217 * Find the membership status based on start date, end date, join date & status date.
219 * @param string $startDate
220 * Start date of the member whose membership status is to be calculated.
221 * @param string $endDate
222 * End date of the member whose membership status is to be calculated.
223 * @param string $joinDate
224 * Join date of the member whose membership status is to be calculated.
225 * @param \date|string $statusDate status date of the member whose membership status is to be calculated.
226 * @param bool $excludeIsAdmin the statuses those having is_admin = 1.
227 * Exclude the statuses those having is_admin = 1.
228 * @param int $membershipTypeID
229 * @param array $membership
230 * Membership params as available to calling function - passed to the hook.
234 public static function getMembershipStatusByDate(
235 $startDate, $endDate, $joinDate,
236 $statusDate = 'today', $excludeIsAdmin = FALSE, $membershipTypeID, $membership = []
238 $membershipDetails = [];
240 if (!$statusDate ||
$statusDate == 'today') {
241 $statusDate = getdate();
242 $statusDate = date('Ymd',
243 mktime($statusDate['hours'],
244 $statusDate['minutes'],
245 $statusDate['seconds'],
253 $statusDate = CRM_Utils_Date
::customFormat($statusDate, '%Y%m%d');
256 $dates = ['start', 'end', 'join'];
257 $events = ['start', 'end'];
259 foreach ($dates as $dat) {
260 if ($
{$dat . 'Date'} && $
{$dat . 'Date'} != "null") {
261 $
{$dat . 'Date'} = CRM_Utils_Date
::customFormat($
{$dat . 'Date'}, '%Y%m%d');
263 $
{$dat . 'Year'} = substr($
{$dat . 'Date'}, 0, 4);
265 $
{$dat . 'Month'} = substr($
{$dat . 'Date'}, 4, 2);
267 $
{$dat . 'Day'} = substr($
{$dat . 'Date'}, 6, 2);
270 $
{$dat . 'Date'} = '';
274 //fix for CRM-3570, if we have statuses with is_admin=1,
275 //exclude these statuses from calculatation during import.
276 $where = "is_active = 1";
277 if ($excludeIsAdmin) {
278 $where .= " AND is_admin != 1";
283 FROM civicrm_membership_status
285 ORDER BY weight ASC";
287 $membershipStatus = CRM_Core_DAO
::executeQuery($query);
288 $hour = $minute = $second = 0;
290 while ($membershipStatus->fetch()) {
293 foreach ($events as $eve) {
294 foreach ($dates as $dat) {
295 // calculate start-event/date and end-event/date
296 if (($membershipStatus->{$eve . '_event'} == $dat . '_date') &&
299 if ($membershipStatus->{$eve . '_event_adjust_unit'} &&
300 $membershipStatus->{$eve . '_event_adjust_interval'}
303 if ($membershipStatus->{$eve . '_event_adjust_unit'} == 'month') {
304 $
{$eve . 'Event'} = date('Ymd', mktime($hour, $minute, $second,
305 $
{$dat . 'Month'} +
$membershipStatus->{$eve . '_event_adjust_interval'},
311 if ($membershipStatus->{$eve . '_event_adjust_unit'} == 'day') {
312 $
{$eve . 'Event'} = date('Ymd', mktime($hour, $minute, $second,
314 $
{$dat . 'Day'} +
$membershipStatus->{$eve . '_event_adjust_interval'},
319 if ($membershipStatus->{$eve . '_event_adjust_unit'} == 'year') {
320 $
{$eve . 'Event'} = date('Ymd', mktime($hour, $minute, $second,
323 $
{$dat . 'Year'} +
$membershipStatus->{$eve . '_event_adjust_interval'}
326 // if no interval and unit, present
329 $
{$eve . 'Event'} = $
{$dat . 'Date'};
335 // check if statusDate is in the range of start & end events.
336 if ($startEvent && $endEvent) {
337 if (($statusDate >= $startEvent) && ($statusDate <= $endEvent)) {
338 $membershipDetails['id'] = $membershipStatus->id
;
339 $membershipDetails['name'] = $membershipStatus->name
;
342 elseif ($startEvent) {
343 if ($statusDate >= $startEvent) {
344 $membershipDetails['id'] = $membershipStatus->id
;
345 $membershipDetails['name'] = $membershipStatus->name
;
349 if ($statusDate <= $endEvent) {
350 $membershipDetails['id'] = $membershipStatus->id
;
351 $membershipDetails['name'] = $membershipStatus->name
;
355 // returns FIRST status record for which status_date is in range.
356 if ($membershipDetails) {
362 //we bundle the arguments into an array as we can't pass 8 variables to the hook otherwise
363 // the membership array might contain the pre-altered settings so we don't want to merge this
365 'start_date' => $startDate,
366 'end_date' => $endDate,
367 'join_date' => $joinDate,
368 'status_date' => $statusDate,
369 'exclude_is_admin' => $endDate,
370 'membership_type_id' => $membershipTypeID,
371 'start_event' => $startEvent,
372 'end_event' => $endEvent,
374 CRM_Utils_Hook
::alterCalculatedMembershipStatus($membershipDetails, $arguments, $membership);
375 return $membershipDetails;
379 * Function that return the status ids whose is_current_member is set.
383 public static function getMembershipStatusCurrent() {
385 $membershipStatus = new CRM_Member_DAO_MembershipStatus();
386 $membershipStatus->is_current_member
= 1;
387 $membershipStatus->find();
388 $membershipStatus->selectAdd();
389 $membershipStatus->selectAdd('id');
390 while ($membershipStatus->fetch()) {
391 $statusIds[] = $membershipStatus->id
;