actions/outbox.php

   1 <?php
   2 /**
   3  * Laconica, 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   Laconica
  24  * @author    Evan Prodromou <evan@controlyourself.ca>
  25  * @copyright 2008 Control Yourself, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://laconi.ca/
  28  */
  29
  30 if (!defined('LACONICA')) {
  31     exit(1);
  32 }
  33
  34 require_once INSTALLDIR.'/lib/mailbox.php';
  35
  36 /**
  37  * action handler for message outbox
  38  *
  39  * @category Message
  40  * @package  Laconica
  41  * @author   Evan Prodromou <evan@controlyourself.ca>
  42  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  43  * @link     http://laconi.ca/
  44  * @see      MailboxAction
  45  */
  46
  47 class OutboxAction extends MailboxAction
  48 {
  49     /**
  50      * Title of the page
  51      *
  52      * @return string page title
  53      */
  54
  55     function title()
  56     {
  57         if ($this->page > 1) {
  58             return sprintf(_("Outbox for %s - page %d"),
  59                 $this->user->nickname, $page);
  60         } else {
  61             return sprintf(_("Outbox for %s"), $this->user->nickname);
  62         }
  63     }
  64
  65     /**
  66      * Output document relationship links
  67      *
  68      * @return void
  69      */
  70     function showRelationshipLinks()
  71     {
  72         $this->sequenceRelationships($this->page > 1, $this->count > NOTICES_PER_PAGE, // FIXME
  73                                      $this->page, 'outbox', array('nickname' => $this->user->nickname));
  74     }
  75
  76     /**
  77      * retrieve the messages for this user and this page
  78      *
  79      * Does a query for the right messages
  80      *
  81      * @return Message data object with stream for messages
  82      *
  83      * @see MailboxAction::getMessages()
  84      */
  85
  86     function getMessages()
  87     {
  88         $message = new Message();
  89
  90         $message->from_profile = $this->user->id;
  91         $message->orderBy('created DESC, id DESC');
  92         $message->limit((($this->page - 1) * MESSAGES_PER_PAGE),
  93             MESSAGES_PER_PAGE + 1);
  94
  95         if ($message->find()) {
  96             return $message;
  97         } else {
  98             return null;
  99         }
 100     }
 101
 102     /**
 103      * returns the profile we want to show with the message
 104      *
 105      * For outboxes, we show the recipient.
 106      *
 107      * @param Message $message The message to get the profile for
 108      *
 109      * @return Profile The profile of the message recipient
 110      *
 111      * @see MailboxAction::getMessageProfile()
 112      */
 113
 114     function getMessageProfile($message)
 115     {
 116         return $message->getTo();
 117     }
 118
 119     /**
 120      * instructions for using this page
 121      *
 122      * @return string localised instructions for using the page
 123      */
 124
 125     function getInstructions()
 126     {
 127         return _('This is your outbox, which lists private messages you have sent.');
 128     }
 129 }