-if (!defined('LACONICA')) { exit(1); }
-
-require_once(INSTALLDIR.'/lib/mailbox.php');
-
-class InboxAction extends MailboxAction {
-
- function get_title($user, $page) {
- if ($page > 1) {
- $title = sprintf(_("Inbox for %s - page %d"), $user->nickname, $page);
- } else {
- $title = sprintf(_("Inbox for %s"), $user->nickname);
- }
- }
-
- function get_messages($user, $page) {
- $message = new Message();
- $message->to_profile = $user->id;
- $message->orderBy('created DESC, id DESC');
- $message->limit((($page-1)*MESSAGES_PER_PAGE), MESSAGES_PER_PAGE + 1);
-
- if ($message->find()) {
- return $message;
- } else {
- return NULL;
- }
- }
-
- function get_message_profile($message) {
- return $message->getFrom();
- }
-
- function get_instructions() {
- return _('This is your inbox, which lists your incoming private messages.');
- }
+class InboxAction extends MailboxAction
+{
+
+ /**
+ * Title of the page
+ *
+ * @return string page title
+ */
+
+ function title()
+ {
+ if ($this->page > 1) {
+ return sprintf(_('Inbox for %1$s - page %2$d'), $this->user->nickname,
+ $this->page);
+ } else {
+ return sprintf(_('Inbox for %s'), $this->user->nickname);
+ }
+ }
+
+ /**
+ * Retrieve the messages for this user and this page
+ *
+ * Does a query for the right messages
+ *
+ * @return Message data object with stream for messages
+ *
+ * @see MailboxAction::getMessages()
+ */
+
+ function getMessages()
+ {
+ $message = new Message();
+
+ $message->to_profile = $this->user->id;
+ $message->orderBy('created DESC, id DESC');
+ $message->limit((($this->page - 1) * MESSAGES_PER_PAGE),
+ MESSAGES_PER_PAGE + 1);
+
+ if ($message->find()) {
+ return $message;
+ } else {
+ return null;
+ }
+ }
+
+ /**
+ * Returns the profile we want to show with the message
+ *
+ * For inboxes, we show the sender; for outboxes, the recipient.
+ *
+ * @param Message $message The message to get the profile for
+ *
+ * @return Profile The profile that matches the message
+ */
+
+ function getMessageProfile($message)
+ {
+ return $message->getFrom();
+ }
+
+ /**
+ * Instructions for using this page
+ *
+ * @return string localised instructions for using the page
+ */
+
+ function getInstructions()
+ {
+ return _('This is your inbox, which lists your incoming private messages.');
+ }