plugins/DirectMessage/actions/outbox.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 outbox
  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 OutboxAction extends MailboxAction
  43 {
  44     /**
  45      * Title of the page
  46      *
  47      * @return string page title
  48      */
  49     function title()
  50     {
  51         if ($this->page > 1) {
  52             // TRANS: Title for outbox for any but the fist page.
  53             // TRANS: %1$s is the user nickname, %2$d is the page number.
  54             return sprintf(_('Outbox for %1$s - page %2$d'),
  55                 $this->user->nickname, $page);
  56         } else {
  57             // TRANS: Title for first page of outbox.
  58             return sprintf(_('Outbox for %s'), $this->user->nickname);
  59         }
  60     }
  61
  62     /**
  63      * retrieve the messages for this user and this page
  64      *
  65      * Does a query for the right messages
  66      *
  67      * @return Message data object with stream for messages
  68      *
  69      * @see MailboxAction::getMessages()
  70      */
  71     function getMessages()
  72     {
  73         $message = new Message();
  74
  75         $message->from_profile = $this->user->id;
  76         $message->orderBy('created DESC, id DESC');
  77         $message->limit((($this->page - 1) * MESSAGES_PER_PAGE),
  78             MESSAGES_PER_PAGE + 1);
  79
  80         if ($message->find()) {
  81             return $message;
  82         } else {
  83             return null;
  84         }
  85     }
  86
  87     function getMessageList($message)
  88     {
  89         return new OutboxMessageList($this, $message);
  90     }
  91
  92     /**
  93      * instructions for using this page
  94      *
  95      * @return string localised instructions for using the page
  96      */
  97     function getInstructions()
  98     {
  99         // TRANS: Instructions for outbox.
 100         return _('This is your outbox, which lists private messages you have sent.');
 101     }
 102 }
 103
 104 class OutboxMessageList extends MessageList
 105 {
 106     function newItem($message)
 107     {
 108         return new OutboxMessageListItem($this->out, $message);
 109     }
 110 }
 111
 112 class OutboxMessageListItem extends MessageListItem
 113 {
 114     /**
 115      * Returns the profile we want to show with the message
 116      *
 117      * @return Profile The profile that matches the message
 118      */
 119     function getMessageProfile()
 120     {
 121         return $this->message->getTo();
 122     }
 123 }