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
53 * @return string page title
58 if ($this->page > 1) {
59 return sprintf(_("Inbox for %s - page %d"), $this->user->nickname,
62 return sprintf(_("Inbox for %s"), $this->user->nickname);
67 * Output document relationship links
71 function showRelationshipLinks()
73 $this->sequenceRelationships($this->page > 1, $this->count > NOTICES_PER_PAGE, // FIXME
74 $this->page, 'inbox', array('nickname' => $this->user->nickname));
78 * Retrieve the messages for this user and this page
80 * Does a query for the right messages
82 * @return Message data object with stream for messages
84 * @see MailboxAction::getMessages()
87 function getMessages()
89 $message = new Message();
91 $message->to_profile = $this->user->id;
92 $message->orderBy('created DESC, id DESC');
93 $message->limit((($this->page - 1) * MESSAGES_PER_PAGE),
94 MESSAGES_PER_PAGE + 1);
96 if ($message->find()) {
104 * Returns the profile we want to show with the message
106 * For inboxes, we show the sender; for outboxes, the recipient.
108 * @param Message $message The message to get the profile for
110 * @return Profile The profile that matches the message
113 function getMessageProfile($message)
115 return $message->getFrom();
119 * Instructions for using this page
121 * @return string localised instructions for using the page
124 function getInstructions()
126 return _('This is your inbox, which lists your incoming private messages.');