]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - actions/outbox.php
fix notices in dumpschema
[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
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 outbox
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
47 class OutboxAction extends MailboxAction
48 {
49     /**
50      * Title of the page
51      *
52      * @return string page title
53      */
54
55     function title()
56     {
57         if ($this->page > 1) {
58             return sprintf(_('Outbox for %1$s - page %2$d'),
59                 $this->user->nickname, $page);
60         } else {
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
75     function getMessages()
76     {
77         $message = new Message();
78
79         $message->from_profile = $this->user->id;
80         $message->orderBy('created DESC, id DESC');
81         $message->limit((($this->page - 1) * MESSAGES_PER_PAGE),
82             MESSAGES_PER_PAGE + 1);
83
84         if ($message->find()) {
85             return $message;
86         } else {
87             return null;
88         }
89     }
90
91     /**
92      * returns the profile we want to show with the message
93      *
94      * For outboxes, we show the recipient.
95      *
96      * @param Message $message The message to get the profile for
97      *
98      * @return Profile The profile of the message recipient
99      *
100      * @see MailboxAction::getMessageProfile()
101      */
102
103     function getMessageProfile($message)
104     {
105         return $message->getTo();
106     }
107
108     /**
109      * instructions for using this page
110      *
111      * @return string localised instructions for using the page
112      */
113
114     function getInstructions()
115     {
116         return _('This is your outbox, which lists private messages you have sent.');
117     }
118 }