plugins/EmailReminder/lib/userreminderhandler.php

   1 <?php
   2
   3 /**
   4  * StatusNet - the distributed open-source microblogging tool
   5  *
   6  * Base handler for email reminders
   7  *
   8  * This program is free software: you can redistribute it and/or modify
   9  * it under the terms of the GNU Affero General Public License as published by
  10  * the Free Software Foundation, either version 3 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU Affero General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Affero General Public License
  19  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20  *
  21  * @category  Email
  22  * @package   StatusNet
  23  * @author    Zach Copley <zach@status.net>
  24  * @copyright 2011 StatusNet, Inc.
  25  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  26  * @link      http://status.net/
  27  */
  28 if (!defined('STATUSNET')) {
  29     exit(1);
  30 }
  31
  32 /**
  33  * Handler for email reminder queue items
  34  *
  35  * @category  Email
  36  * @package   StatusNet
  37  * @author    Zach Copley <zach@status.net>
  38  * @copyright 2011 StatusNet, Inc.
  39  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  40  * @link      http://status.net/
  41  */
  42 class UserReminderHandler extends QueueHandler {
  43
  44     /**
  45      * Send the next email reminder to the confirm address
  46      *
  47      * @param Confirm_address $confirm the confirmation email/code
  48      * @return boolean true on success, false on failure
  49      */
  50     function handle($confirm) {
  51         return $this->sendNextReminder($confirm);
  52     }
  53
  54     /**
  55      * Send the next reminder if one needs sending.
  56      * Subclasses must override
  57      *
  58      * @param Confirm_address $confirm the confirmation email/code
  59      */
  60     function sendNextReminder($confirm)
  61     {
  62     }
  63 }