plugins/DirectMessage/actions/inbox.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * action handler for message inbox
   6  *
   7  * PHP version 5
   8  *
   9  * LICENCE: This program is free software: you can redistribute it and/or modify
  10  * it under the terms of the GNU Affero General Public License as published by
  11  * the Free Software Foundation, either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU Affero General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  *
  22  * @category  Message
  23  * @package   StatusNet
  24  * @author    Evan Prodromou <evan@status.net>
  25  * @copyright 2008 StatusNet, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://status.net/
  28  */
  29
  30 if (!defined('GNUSOCIAL')) { exit(1); }
  31
  32 /**
  33  * action handler for message inbox
  34  *
  35  * @category Message
  36  * @package  StatusNet
  37  * @author   Evan Prodromou <evan@status.net>
  38  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  39  * @link     http://status.net/
  40  * @see      MailboxAction
  41  */
  42 class InboxAction extends MailboxAction
  43 {
  44
  45     /**
  46      * Title of the page
  47      *
  48      * @return string page title
  49      */
  50     function title()
  51     {
  52         if ($this->page > 1) {
  53             // TRANS: Title for all but the first page of the inbox page.
  54             // TRANS: %1$s is the user's nickname, %2$s is the page number.
  55             return sprintf(_('Inbox for %1$s - page %2$d'), $this->user->nickname,
  56                 $this->page);
  57         } else {
  58             // TRANS: Title for the first page of the inbox page.
  59             // TRANS: %s is the user's nickname.
  60             return sprintf(_('Inbox for %s'), $this->user->nickname);
  61         }
  62     }
  63
  64     /**
  65      * Retrieve the messages for this user and this page
  66      *
  67      * Does a query for the right messages
  68      *
  69      * @return Message data object with stream for messages
  70      *
  71      * @see MailboxAction::getMessages()
  72      */
  73     function getMessages()
  74     {
  75         $message = new Message();
  76
  77         $message->to_profile = $this->user->id;
  78         $message->orderBy('created DESC, id DESC');
  79         $message->limit((($this->page - 1) * MESSAGES_PER_PAGE),
  80             MESSAGES_PER_PAGE + 1);
  81
  82         if ($message->find()) {
  83             return $message;
  84         } else {
  85             return null;
  86         }
  87     }
  88
  89     function getMessageList($message)
  90     {
  91         return new InboxMessageList($this, $message);
  92     }
  93
  94     /**
  95      * Instructions for using this page
  96      *
  97      * @return string localised instructions for using the page
  98      */
  99     function getInstructions()
 100     {
 101         // TRANS: Instructions for user inbox page.
 102         return _('This is your inbox, which lists your incoming private messages.');
 103     }
 104 }