actions/inbox.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 inbox
  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 InboxAction extends MailboxAction
  48 {
  49     /**
  50      * returns the title of the page
  51      *
  52      * @param User $user current user
  53      * @param int  $page current page
  54      *
  55      * @return string localised title of the page
  56      *
  57      * @see MailboxAction::getTitle()
  58      */
  59
  60     function getTitle($user, $page)
  61     {
  62         if ($page > 1) {
  63             $title = sprintf(_("Inbox for %s - page %d"), $user->nickname, $page);
  64         } else {
  65             $title = sprintf(_("Inbox for %s"), $user->nickname);
  66         }
  67         return $title;
  68     }
  69
  70     /**
  71      * retrieve the messages for this user and this page
  72      *
  73      * Does a query for the right messages
  74      *
  75      * @param User $user The current user
  76      * @param int  $page The page the user is on
  77      *
  78      * @return Message data object with stream for messages
  79      *
  80      * @see MailboxAction::getMessages()
  81      */
  82
  83     function getMessages($user, $page)
  84     {
  85         $message = new Message();
  86
  87         $message->to_profile = $user->id;
  88
  89         $message->orderBy('created DESC, id DESC');
  90         $message->limit((($page-1)*MESSAGES_PER_PAGE), MESSAGES_PER_PAGE + 1);
  91
  92         if ($message->find()) {
  93             return $message;
  94         } else {
  95             return null;
  96         }
  97     }
  98
  99     /**
 100      * returns the profile we want to show with the message
 101      *
 102      * For inboxes, we show the sender.
 103      *
 104      * @param Message $message The message to get the profile for
 105      *
 106      * @return Profile The profile of the message sender
 107      *
 108      * @see MailboxAction::getMessageProfile()
 109      */
 110
 111     function getMessageProfile($message)
 112     {
 113         return $message->getFrom();
 114     }
 115
 116     /**
 117      * instructions for using this page
 118      *
 119      * @return string localised instructions for using the page
 120      */
 121
 122     function getInstructions()
 123     {
 124         return _('This is your inbox, which lists your incoming private messages.');
 125     }
 126 }