3 * Laconica, the distributed open-source microblogging tool
5 * action handler for message inbox
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.
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.
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/>.
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/
30 if (!defined('LACONICA')) {
34 require_once INSTALLDIR.'/lib/mailbox.php';
37 * action handler for message inbox
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/
47 class InboxAction extends MailboxAction
50 * returns the title of the page
52 * @param User $user current user
53 * @param int $page current page
55 * @return string localised title of the page
57 * @see MailboxAction::getTitle()
60 function getTitle($user, $page)
63 $title = sprintf(_("Inbox for %s - page %d"), $user->nickname, $page);
65 $title = sprintf(_("Inbox for %s"), $user->nickname);
71 * retrieve the messages for this user and this page
73 * Does a query for the right messages
75 * @param User $user The current user
76 * @param int $page The page the user is on
78 * @return Message data object with stream for messages
80 * @see MailboxAction::getMessages()
83 function getMessages($user, $page)
85 $message = new Message();
87 $message->to_profile = $user->id;
89 $message->orderBy('created DESC, id DESC');
90 $message->limit((($page-1)*MESSAGES_PER_PAGE), MESSAGES_PER_PAGE + 1);
92 if ($message->find()) {
100 * returns the profile we want to show with the message
102 * For inboxes, we show the sender.
104 * @param Message $message The message to get the profile for
106 * @return Profile The profile of the message sender
108 * @see MailboxAction::getMessageProfile()
111 function getMessageProfile($message)
113 return $message->getFrom();
117 * instructions for using this page
119 * @return string localised instructions for using the page
122 function getInstructions()
124 return _('This is your inbox, which lists your incoming private messages.');