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('STATUSNET') && !defined('LACONICA')) {
  31     exit(1);
  32 }
  33
  34 require_once INSTALLDIR.'/lib/mailbox.php';
  35
  36 /**
  37  * action handler for message inbox
  38  *
  39  * @category Message
  40  * @package  StatusNet
  41  * @author   Evan Prodromou <evan@status.net>
  42  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  43  * @link     http://status.net/
  44  * @see      MailboxAction
  45  */
  46
  47 class InboxAction extends MailboxAction
  48 {
  49
  50     /**
  51      * Title of the page
  52      *
  53      * @return string page title
  54      */
  55
  56     function title()
  57     {
  58         if ($this->page > 1) {
  59             return sprintf(_('Inbox for %1$s - page %2$d'), $this->user->nickname,
  60                 $this->page);
  61         } else {
  62             return sprintf(_('Inbox for %s'), $this->user->nickname);
  63         }
  64     }
  65
  66     /**
  67      * Retrieve the messages for this user and this page
  68      *
  69      * Does a query for the right messages
  70      *
  71      * @return Message data object with stream for messages
  72      *
  73      * @see MailboxAction::getMessages()
  74      */
  75
  76     function getMessages()
  77     {
  78         $message = new Message();
  79
  80         $message->to_profile = $this->user->id;
  81         $message->orderBy('created DESC, id DESC');
  82         $message->limit((($this->page - 1) * MESSAGES_PER_PAGE),
  83             MESSAGES_PER_PAGE + 1);
  84
  85         if ($message->find()) {
  86             return $message;
  87         } else {
  88             return null;
  89         }
  90     }
  91
  92     /**
  93      * Returns the profile we want to show with the message
  94      *
  95      * For inboxes, we show the sender; for outboxes, the recipient.
  96      *
  97      * @param Message $message The message to get the profile for
  98      *
  99      * @return Profile The profile that matches the message
 100      */
 101
 102     function getMessageProfile($message)
 103     {
 104         return $message->getFrom();
 105     }
 106
 107     /**
 108      * Instructions for using this page
 109      *
 110      * @return string localised instructions for using the page
 111      */
 112
 113     function getInstructions()
 114     {
 115         return _('This is your inbox, which lists your incoming private messages.');
 116     }
 117 }