2008-09-16 20:53:46 +01:00
|
|
|
<?php
|
2019-08-19 22:51:51 +01:00
|
|
|
// This file is part of GNU social - https://www.gnu.org/software/social
|
|
|
|
//
|
|
|
|
// GNU social 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.
|
|
|
|
//
|
|
|
|
// GNU social is distributed in the hope that it will be useful,
|
|
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
// GNU Affero General Public License for more details.
|
|
|
|
//
|
|
|
|
// You should have received a copy of the GNU Affero General Public License
|
|
|
|
// along with GNU social. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
|
2008-12-22 20:13:04 +00:00
|
|
|
/**
|
2019-08-19 22:51:51 +01:00
|
|
|
* GNUsocial implementation of Direct Messages
|
2008-09-16 20:53:46 +01:00
|
|
|
*
|
2019-08-19 22:51:51 +01:00
|
|
|
* @package GNUsocial
|
|
|
|
* @author Mikael Nordfeldth <mmn@hethane.se>
|
|
|
|
* @author Bruno Casteleiro <brunoccast@fc.up.pt>
|
|
|
|
* @copyright 2019 Free Software Foundation, Inc http://www.fsf.org
|
|
|
|
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
|
2008-12-22 20:13:04 +00:00
|
|
|
*/
|
|
|
|
|
2019-08-19 22:51:51 +01:00
|
|
|
defined('GNUSOCIAL') || die();
|
2008-12-22 20:13:04 +00:00
|
|
|
|
|
|
|
/**
|
2019-08-19 22:51:51 +01:00
|
|
|
* Action handler for the inbox
|
2008-12-22 20:13:04 +00:00
|
|
|
*
|
2019-08-19 22:51:51 +01:00
|
|
|
* @category Plugin
|
|
|
|
* @package GNUsocial
|
|
|
|
* @author Mikael Nordfeldth <mmn@hethane.se>
|
|
|
|
* @author Bruno Casteleiro <brunoccast@fc.up.pt>
|
|
|
|
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
|
2008-09-16 20:53:46 +01:00
|
|
|
*/
|
2008-12-22 20:13:04 +00:00
|
|
|
class InboxAction extends MailboxAction
|
|
|
|
{
|
|
|
|
/**
|
2019-08-19 22:51:51 +01:00
|
|
|
* Title of the page.
|
2008-12-22 20:13:04 +00:00
|
|
|
*
|
2009-01-21 01:49:47 +00:00
|
|
|
* @return string page title
|
2008-12-22 20:13:04 +00:00
|
|
|
*/
|
2019-08-19 22:51:51 +01:00
|
|
|
function title() : string
|
2009-06-10 16:47:46 +01:00
|
|
|
{
|
2009-01-21 01:49:47 +00:00
|
|
|
if ($this->page > 1) {
|
2011-01-31 17:16:55 +00:00
|
|
|
// TRANS: Title for all but the first page of the inbox page.
|
|
|
|
// TRANS: %1$s is the user's nickname, %2$s is the page number.
|
2019-08-19 22:51:51 +01:00
|
|
|
return sprintf(_m('Inbox for %1$s - page %2$d'), $this->user->getNickname(),
|
2009-01-21 01:49:47 +00:00
|
|
|
$this->page);
|
2008-12-22 20:13:04 +00:00
|
|
|
} else {
|
2011-01-31 17:16:55 +00:00
|
|
|
// TRANS: Title for the first page of the inbox page.
|
|
|
|
// TRANS: %s is the user's nickname.
|
2019-08-19 22:51:51 +01:00
|
|
|
return sprintf(_m('Inbox for %s'), $this->user->getNickname());
|
2008-12-22 20:13:04 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2019-08-19 22:51:51 +01:00
|
|
|
* Retrieve the messages for this user and this page.
|
2009-06-10 16:47:46 +01:00
|
|
|
*
|
2019-08-19 22:51:51 +01:00
|
|
|
* @return Notice data object with stream for messages
|
2008-12-22 20:13:04 +00:00
|
|
|
*/
|
2009-01-21 01:49:47 +00:00
|
|
|
function getMessages()
|
2008-12-22 20:13:04 +00:00
|
|
|
{
|
2019-08-19 22:51:51 +01:00
|
|
|
return MessageModel::inboxMessages($this->user, $this->page);
|
2008-12-22 20:13:04 +00:00
|
|
|
}
|
|
|
|
|
2019-08-19 22:51:51 +01:00
|
|
|
/**
|
|
|
|
* Retrieve inbox MessageList widget
|
|
|
|
*/
|
2011-02-08 16:11:21 +00:00
|
|
|
function getMessageList($message)
|
2008-12-22 20:13:04 +00:00
|
|
|
{
|
2011-02-08 16:11:21 +00:00
|
|
|
return new InboxMessageList($this, $message);
|
2008-12-22 20:13:04 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2019-08-19 22:51:51 +01:00
|
|
|
* Instructions for using this page.
|
2008-12-22 20:13:04 +00:00
|
|
|
*
|
|
|
|
* @return string localised instructions for using the page
|
|
|
|
*/
|
2019-08-19 22:51:51 +01:00
|
|
|
function getInstructions() : string
|
2008-12-22 20:13:04 +00:00
|
|
|
{
|
2011-01-31 17:16:55 +00:00
|
|
|
// TRANS: Instructions for user inbox page.
|
2019-08-19 22:51:51 +01:00
|
|
|
return _m('This is your inbox, which lists your incoming private messages.');
|
2008-12-22 20:13:04 +00:00
|
|
|
}
|
2008-09-16 20:53:46 +01:00
|
|
|
}
|