Page MenuHomeWickedGov Phorge
Files F4109697

ApiEchoMarkRead.php
No OneTemporary
Actions

Size
3 KB
Referenced Files
None
Subscribers
None

ApiEchoMarkRead.php
View Options

<?php
namespace MediaWiki\Extension\Notifications\Api;
use MediaWiki\Api\ApiBase;
use MediaWiki\Extension\Notifications\AttributeManager;
use MediaWiki\Extension\Notifications\Controller\NotificationController;
use MediaWiki\Extension\Notifications\DbFactory;
use MediaWiki\Extension\Notifications\NotifUser;
use MediaWiki\WikiMap\WikiMap;
use Wikimedia\ParamValidator\ParamValidator;
class ApiEchoMarkRead extends ApiBase {
use ApiCrossWiki;
public function execute() {
// To avoid API warning, register the parameter used to bust browser cache
$this->getMain()->getVal( '_' );
$user = $this->getUser();
if ( !$user->isRegistered() ) {
$this->dieWithError( 'apierror-mustbeloggedin-generic', 'login-required' );
} elseif ( DbFactory::newFromDefault()->isReadOnly() ) {
$this->dieReadOnly();
}
$notifUser = NotifUser::newFromUser( $user );
$params = $this->extractRequestParams();
// Mark as read/unread locally, if requested
if ( in_array( WikiMap::getCurrentWikiId(), $this->getRequestedWikis() ) ) {
// There is no need to trigger markRead if all notifications are read
if ( $notifUser->getLocalNotificationCount() > 0 ) {
if ( $params['list'] ) {
// Make sure there is a limit to the update
$notifUser->markRead( array_slice( $params['list'], 0, ApiBase::LIMIT_SML2 ) );
// Mark all as read
} elseif ( $params['all'] ) {
$notifUser->markAllRead();
// Mark all as read for sections
} elseif ( $params['sections'] ) {
$notifUser->markAllRead( $params['sections'] );
}
}
// Mark as unread
if ( $params['unreadlist'] !== null && $params['unreadlist'] !== [] ) {
// Make sure there is a limit to the update
$notifUser->markUnRead( array_slice( $params['unreadlist'], 0, ApiBase::LIMIT_SML2 ) );
}
}
$foreignResults = $this->getFromForeign();
$result = [
'result' => 'success'
];
foreach ( $foreignResults as $wiki => $foreignResult ) {
if ( isset( $foreignResult['error'] ) ) {
$result['errors'][$wiki] = $foreignResult['error'];
}
}
$rawCount = 0;
foreach ( AttributeManager::$sections as $section ) {
$rawSectionCount = $notifUser->getNotificationCount( $section );
$result[$section]['rawcount'] = $rawSectionCount;
$result[$section]['count'] = NotificationController::formatNotificationCount( $rawSectionCount );
$rawCount += $rawSectionCount;
}
$result += [
'rawcount' => $rawCount,
'count' => NotificationController::formatNotificationCount( $rawCount ),
];
$this->getResult()->addValue( 'query', $this->getModuleName(), $result );
}
public function getAllowedParams() {
return $this->getCrossWikiParams() + [
'list' => [
ParamValidator::PARAM_ISMULTI => true,
],
'unreadlist' => [
ParamValidator::PARAM_ISMULTI => true,
],
'all' => [
ParamValidator::PARAM_REQUIRED => false,
ParamValidator::PARAM_TYPE => 'boolean'
],
'sections' => [
ParamValidator::PARAM_TYPE => AttributeManager::$sections,
ParamValidator::PARAM_ISMULTI => true,
],
'token' => [
ParamValidator::PARAM_REQUIRED => true,
]
];
}
public function needsToken() {
return 'csrf';
}
public function mustBePosted() {
return true;
}
public function isWriteMode() {
return true;
}
/**
* @see ApiBase::getExamplesMessages()
* @return string[]
*/
protected function getExamplesMessages() {
return [
'action=echomarkread&list=8'
=> 'apihelp-echomarkread-example-1',
'action=echomarkread&all=true'
=> 'apihelp-echomarkread-example-2',
'action=echomarkread&unreadlist=1'
=> 'apihelp-echomarkread-example-3',
];
}
public function getHelpUrls() {
return 'https://www.mediawiki.org/wiki/Special:MyLanguage/Echo_(Notifications)/API';
}
}

File Metadata

Mime Type
text/x-php
Expires
Tue, Aug 18, 21:12 (5 d, 16 h ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
2f/8a/7452d227ffec1d9a0a74c4d0e100
Default Alt Text
ApiEchoMarkRead.php (3 KB)

Event Timeline