galette/lib/Galette/Repository/Reminders.php

   1 <?php
   2
   3 /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
   4
   5 /**
   6  * Reminders
   7  *
   8  * PHP version 5
   9  *
  10  * Copyright © 2013-2014 The Galette Team
  11  *
  12  * This file is part of Galette (http://galette.tuxfamily.org).
  13  *
  14  * Galette is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU General Public License as published by
  16  * the Free Software Foundation, either version 3 of the License, or
  17  * (at your option) any later version.
  18  *
  19  * Galette is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  *  GNU General Public License for more details.
  23  *
  24  * You should have received a copy of the GNU General Public License
  25  * along with Galette. If not, see <http://www.gnu.org/licenses/>.
  26  *
  27  * @category  Entity
  28  * @package   Galette
  29  *
  30  * @author    Johan Cwiklinski <johan@x-tnd.be>
  31  * @copyright 2013-2014 The Galette Team
  32  * @license   http://www.gnu.org/licenses/gpl-3.0.html GPL License 3.0 or (at your option) any later version
  33  * @link      http://galette.tuxfamily.org
  34  * @since     Available since 0.7.5dev - 2013-02-13
  35  */
  36
  37 namespace Galette\Repository;
  38
  39 use Galette\Entity\Reminder;
  40 use Galette\Filters\MembersList;
  41 use Analog\Analog;
  42 use Laminas\Db\Sql\Expression;
  43
  44 /**
  45  * Reminders
  46  *
  47  * @category  Entity
  48  * @name      Reminders
  49  * @package   Galette
  50  * @author    Johan Cwiklinski <johan@x-tnd.be>
  51  * @copyright 2013-2014 The Galette Team
  52  * @license   http://www.gnu.org/licenses/gpl-3.0.html GPL License 3.0 or (at your option) any later version
  53  * @link      http://galette.tuxfamily.org
  54  * @since     Available since 0.7.5dev - 2013-02-13
  55  */
  56
  57 class Reminders
  58 {
  59     public const TABLE = 'reminders';
  60     public const PK = 'reminder_id';
  61
  62     private $selected;
  63     private $types;
  64     private $reminders;
  65     private $toremind;
  66
  67     /**
  68      * Main constructor
  69      *
  70      * @param array $selected Selected types for sending
  71      */
  72     public function __construct($selected = null)
  73     {
  74         if (isset($selected) && is_array($selected)) {
  75             $this->selected = array_map('intval', $selected);
  76         } else {
  77             $this->selected = array(Reminder::IMPENDING, Reminder::LATE);
  78         }
  79     }
  80
  81     /**
  82      * Load reminders
  83      *
  84      * @param Db     $zdb  Database instance
  85      * @param string $type Reminder type
  86      *
  87      * @return void
  88      */
  89     private function loadToRemind($zdb, $type)
  90     {
  91         $this->toremind = array();
  92         $select = $zdb->select(Members::TABLE, 'a');
  93         $select->join(
  94             array('r' => PREFIX_DB . self::TABLE),
  95             'a.' . Members::PK . '=r.reminder_dest',
  96             array(
  97                 'last_reminder' => new Expression('MAX(reminder_date)'),
  98                 'reminder_type'
  99             ),
 100             $select::JOIN_LEFT
 101         )->join(
 102             array('p' => PREFIX_DB . Members::TABLE),
 103             'a.parent_id=p.' . Members::PK,
 104             array('email_adh'),
 105             $select::JOIN_LEFT
 106         )->where('(a.email_adh != \'\' OR p.email_adh != \'\')')
 107             ->where('a.activite_adh=true')
 108             ->where('a.bool_exempt_adh=false');
 109
 110         if ($type === Reminder::LATE) {
 111             $select->where->LessThan(
 112                 'a.date_echeance',
 113                 date('Y-m-d', time())
 114             );
 115         } else {
 116             $now = new \DateTime();
 117             $duedate = new \DateTime();
 118             $duedate->modify('+1 month');
 119             $select->where->greaterThanOrEqualTo(
 120                 'a.date_echeance',
 121                 $now->format('Y-m-d')
 122             )->lessThan(
 123                 'a.date_echeance',
 124                 $duedate->format('Y-m-d')
 125             );
 126         }
 127
 128         $select->group('a.id_adh')->group('r.reminder_type')->group('p.email_adh');
 129
 130         $results = $zdb->execute($select);
 131
 132         foreach ($results as $r) {
 133             if ($r->reminder_type === null || (int)$r->reminder_type === $type) {
 134                 $date_checked = false;
 135
 136                 $due_date = new \DateTime($r->date_echeance);
 137                 $now = new \DateTime();
 138
 139                 switch ($type) {
 140                     case Reminder::IMPENDING:
 141                         //reminders 30 days and 7 days before
 142                         $first = clone $due_date;
 143                         $second = clone $due_date;
 144                         $first->modify('-1 month');
 145                         $second->modify('-7 day');
 146                         if ($now >= $first || $now >= $second) {
 147                             if ($r->last_reminder == '') {
 148                                 $date_checked = true;
 149                             } else {
 150                                 $last_reminder = new \DateTime($r->last_reminder);
 151                                 if ($now >= $second && $second > $last_reminder) {
 152                                     $date_checked = true;
 153                                 }
 154                             }
 155                         }
 156                         break;
 157                     case Reminder::LATE:
 158                         //reminders 30 days and 60 days after
 159                         $first = clone $due_date;
 160                         $second = clone $due_date;
 161                         $first->modify('1 month');
 162                         $second->modify('2 month');
 163                         if ($r->last_reminder == null || $now >= $second || $now >= $first) {
 164                             if ($r->last_reminder == '') {
 165                                 $date_checked = true;
 166                             } else {
 167                                 $last_reminder = new \DateTime($r->last_reminder);
 168                                 if ($now >= $second && $second > $last_reminder) {
 169                                     $date_checked = true;
 170                                 }
 171                             }
 172                         }
 173                         break;
 174                 }
 175
 176                 if ($date_checked) {
 177                     $pk = Members::PK;
 178                     $this->toremind[] = $r->$pk;
 179                 }
 180             } else {
 181                 Analog::log(
 182                     'Reminder does not suits current requested type ' .
 183                     print_r($r, true),
 184                     Analog::DEBUG
 185                 );
 186             }
 187         }
 188     }
 189
 190     /**
 191      * Get the list of reminders
 192      *
 193      * @param Db      $zdb    Database instance
 194      * @param boolean $nomail Get reminders for members who do not have email address
 195      *
 196      * @return array
 197      */
 198     public function getList($zdb, $nomail = false)
 199     {
 200         $this->types = array();
 201         $this->reminders = array();
 202
 203         $types = array();
 204         foreach ($this->selected as $s) {
 205             $this->loadToRemind($zdb, $s);
 206
 207             if (count($this->toremind) > 0) {
 208                 //and then get list
 209                 $m = new Members();
 210                 $members = $m->getArrayList(
 211                     $this->toremind,
 212                     null,
 213                     false,
 214                     true,
 215                     null,
 216                     false,
 217                     true
 218                 );
 219                 $this->types[$s] = $members;
 220             }
 221         }
 222
 223         if (is_array($this->types)) {
 224             foreach ($this->types as $type => $members) {
 225                 //load message
 226                 if (is_array($members)) {
 227                     foreach ($members as $member) {
 228                         $reminder = new Reminder();
 229                         $reminder->type = $type;
 230                         $reminder->dest = $member;
 231
 232                         $this->reminders[] = $reminder;
 233                     }
 234                 }
 235             }
 236         }
 237         return $this->reminders;
 238     }
 239 }