<?php
/**
- * Laconica, the distributed open-source microblogging tool
+ * StatusNet, the distributed open-source microblogging tool
*
* action handler for message inbox
*
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* @category Message
- * @package Laconica
- * @author Evan Prodromou <evan@controlyourself.ca>
- * @copyright 2008 Control Yourself, Inc.
+ * @package StatusNet
+ * @author Evan Prodromou <evan@status.net>
+ * @copyright 2008 StatusNet, Inc.
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
- * @link http://laconi.ca/
+ * @link http://status.net/
*/
-if (!defined('LACONICA')) {
+if (!defined('STATUSNET') && !defined('LACONICA')) {
exit(1);
}
* action handler for message inbox
*
* @category Message
- * @package Laconica
- * @author Evan Prodromou <evan@controlyourself.ca>
+ * @package StatusNet
+ * @author Evan Prodromou <evan@status.net>
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
- * @link http://laconi.ca/
+ * @link http://status.net/
* @see MailboxAction
*/
class InboxAction extends MailboxAction
{
+
/**
- * returns the title of the page
- *
- * @param User $user current user
- * @param int $page current page
- *
- * @return string localised title of the page
+ * Title of the page
*
- * @see MailboxAction::getTitle()
+ * @return string page title
*/
- function getTitle($user, $page)
+ function title()
{
- if ($page > 1) {
- $title = sprintf(_("Inbox for %s - page %d"), $user->nickname, $page);
+ if ($this->page > 1) {
+ return sprintf(_('Inbox for %1$s - page %2$d'), $this->user->nickname,
+ $this->page);
} else {
- $title = sprintf(_("Inbox for %s"), $user->nickname);
+ return sprintf(_('Inbox for %s'), $this->user->nickname);
}
- return $title;
}
/**
- * retrieve the messages for this user and this page
+ * Retrieve the messages for this user and this page
*
* Does a query for the right messages
*
- * @param User $user The current user
- * @param int $page The page the user is on
- *
* @return Message data object with stream for messages
*
* @see MailboxAction::getMessages()
*/
- function getMessages($user, $page)
+ function getMessages()
{
$message = new Message();
- $message->to_profile = $user->id;
-
+ $message->to_profile = $this->user->id;
$message->orderBy('created DESC, id DESC');
- $message->limit((($page-1)*MESSAGES_PER_PAGE), MESSAGES_PER_PAGE + 1);
+ $message->limit((($this->page - 1) * MESSAGES_PER_PAGE),
+ MESSAGES_PER_PAGE + 1);
if ($message->find()) {
return $message;
}
/**
- * returns the profile we want to show with the message
+ * Returns the profile we want to show with the message
*
- * For inboxes, we show the sender.
+ * For inboxes, we show the sender; for outboxes, the recipient.
*
* @param Message $message The message to get the profile for
*
- * @return Profile The profile of the message sender
- *
- * @see MailboxAction::getMessageProfile()
+ * @return Profile The profile that matches the message
*/
function getMessageProfile($message)
}
/**
- * instructions for using this page
+ * Instructions for using this page
*
* @return string localised instructions for using the page
*/