plugins/EmailReminder/lib/userreminderhandler.php

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