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