<?php
-/*
- * Laconica - a distributed open-source microblogging tool
- * Copyright (C) 2008, Controlez-Vous, Inc.
+/**
+ * StatusNet, the distributed open-source microblogging tool
*
- * This program is free software: you can redistribute it and/or modify
+ * action handler for message inbox
+ *
+ * PHP version 5
+ *
+ * LICENCE: This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ * @category Message
+ * @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://status.net/
+ */
+if (!defined('STATUSNET') && !defined('LACONICA')) {
+ exit(1);
+}
+
+require_once INSTALLDIR.'/lib/mailbox.php';
+
+/**
+ * action handler for message outbox
+ *
+ * @category Message
+ * @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://status.net/
+ * @see MailboxAction
*/
+class OutboxAction extends MailboxAction
+{
+ /**
+ * Title of the page
+ *
+ * @return string page title
+ */
+ function title()
+ {
+ if ($this->page > 1) {
+ // TRANS: Title for outbox for any but the fist page.
+ // TRANS: %1$s is the user nickname, %2$d is the page number.
+ return sprintf(_('Outbox for %1$s - page %2$d'),
+ $this->user->nickname, $page);
+ } else {
+ // TRANS: Title for first page of outbox.
+ return sprintf(_('Outbox 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->from_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;
+ }
+ }
+
+ function getMessageList($message)
+ {
+ return new OutboxMessageList($this, $message);
+ }
+
+ /**
+ * instructions for using this page
+ *
+ * @return string localised instructions for using the page
+ */
+ function getInstructions()
+ {
+ // TRANS: Instructions for outbox.
+ return _('This is your outbox, which lists private messages you have sent.');
+ }
+}
+
+class OutboxMessageList extends MessageList
+{
+ function newItem($message)
+ {
+ return new OutboxMessageListItem($this->out, $message);
+ }
+}
-if (!defined('LACONICA')) { exit(1); }
-
-require_once(INSTALLDIR.'/lib/mailbox.php');
-
-class OutboxAction extends MailboxAction {
-
- function get_title($user, $page) {
- if ($page > 1) {
- $title = sprintf(_("Outbox for %s - page %d"), $user->nickname, $page);
- } else {
- $title = sprintf(_("Outbox for %s"), $user->nickname);
- }
- }
-
- function get_messages($user, $page) {
- $message = new Message();
- $message->from_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->getTo();
- }
+class OutboxMessageListItem extends MessageListItem
+{
+ /**
+ * Returns the profile we want to show with the message
+ *
+ * @return Profile The profile that matches the message
+ */
+ function getMessageProfile()
+ {
+ return $this->message->getTo();
+ }
}