]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - actions/outbox.php
Give NoticeListItem its own class
[quix0rs-gnu-social.git] / actions / outbox.php
1 <?php
2 /**
3  * StatusNet, the distributed open-source microblogging tool
4  *
5  * action handler for message inbox
6  *
7  * PHP version 5
8  *
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.
13  *
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.
18  *
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/>.
21  *
22  * @category  Message
23  * @package   StatusNet
24  * @author    Evan Prodromou <evan@status.net>
25  * @copyright 2008 StatusNet, Inc.
26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
27  * @link      http://status.net/
28  */
29 if (!defined('STATUSNET') && !defined('LACONICA')) {
30     exit(1);
31 }
32
33 require_once INSTALLDIR.'/lib/mailbox.php';
34
35 /**
36  * action handler for message outbox
37  *
38  * @category Message
39  * @package  StatusNet
40  * @author   Evan Prodromou <evan@status.net>
41  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
42  * @link     http://status.net/
43  * @see      MailboxAction
44  */
45 class OutboxAction extends MailboxAction
46 {
47     /**
48      * Title of the page
49      *
50      * @return string page title
51      */
52     function title()
53     {
54         if ($this->page > 1) {
55             // TRANS: Title for outbox for any but the fist page.
56             // TRANS: %1$s is the user nickname, %2$d is the page number.
57             return sprintf(_('Outbox for %1$s - page %2$d'),
58                 $this->user->nickname, $page);
59         } else {
60             // TRANS: Title for first page of outbox.
61             return sprintf(_('Outbox for %s'), $this->user->nickname);
62         }
63     }
64
65     /**
66      * retrieve the messages for this user and this page
67      *
68      * Does a query for the right messages
69      *
70      * @return Message data object with stream for messages
71      *
72      * @see MailboxAction::getMessages()
73      */
74     function getMessages()
75     {
76         $message = new Message();
77
78         $message->from_profile = $this->user->id;
79         $message->orderBy('created DESC, id DESC');
80         $message->limit((($this->page - 1) * MESSAGES_PER_PAGE),
81             MESSAGES_PER_PAGE + 1);
82
83         if ($message->find()) {
84             return $message;
85         } else {
86             return null;
87         }
88     }
89
90     function getMessageList($message)
91     {
92         return new OutboxMessageList($this, $message);
93     }
94
95     /**
96      * instructions for using this page
97      *
98      * @return string localised instructions for using the page
99      */
100     function getInstructions()
101     {
102         // TRANS: Instructions for outbox.
103         return _('This is your outbox, which lists private messages you have sent.');
104     }
105 }
106
107 class OutboxMessageList extends MessageList
108 {
109     function newItem($message)
110     {
111         return new OutboxMessageListItem($this->out, $message);
112     }
113 }
114
115 class OutboxMessageListItem extends MessageListItem
116 {
117     /**
118      * Returns the profile we want to show with the message
119      *
120      * @return Profile The profile that matches the message
121      */
122     function getMessageProfile()
123     {
124         return $this->message->getTo();
125     }
126 }