mediawiki-extensions-Echo/includes/special/NotificationPager.php
Thiemo Mättig 2e9a27558c Minor cleanups to PHPDoc blocks
Change-Id: I5890144521b6b54c798b1590ab8d102d74ada26a
2017-12-15 15:42:38 +01:00

70 lines
1.7 KiB
PHP

<?php
/**
* This pager is used by Special:Notifications (NO-JS).
* The heavy-lifting is done by IndexPager (grand-parent to this class).
* It paginates on notification_event for a specific user, only for the enabled event types.
*/
class NotificationPager extends ReverseChronologicalPager {
public function __construct() {
$dbFactory = MWEchoDbFactory::newFromDefault();
$this->mDb = $dbFactory->getEchoDb( DB_REPLICA );
parent::__construct();
}
function formatRow( $row ) {
$msg = "This pager does not support row formatting. Use 'getNotifications()' to get a list of EchoNotification objects.";
throw new Exception( $msg );
}
function getQueryInfo() {
$attributeManager = EchoAttributeManager::newFromGlobalVars();
$eventTypes = $attributeManager->getUserEnabledEvents( $this->getUser(), 'web' );
return [
'tables' => [ 'echo_notification', 'echo_event' ],
'fields' => '*',
'conds' => [
'notification_user' => $this->getUser()->getId(),
'event_type' => $eventTypes,
'event_deleted' => 0,
],
'options' => [],
'join_conds' =>
[ 'echo_event' =>
[
'JOIN',
'notification_event=event_id',
],
],
];
}
public function getNotifications() {
if ( !$this->mQueryDone ) {
$this->doQuery();
}
$notifications = [];
foreach ( $this->mResult as $row ) {
$notifications[] = EchoNotification::newFromRow( $row );
}
// get rid of the overfetched
if ( count( $notifications ) > $this->getLimit() ) {
array_pop( $notifications );
}
if ( $this->mIsBackwards ) {
$notifications = array_reverse( $notifications );
}
return $notifications;
}
function getIndexField() {
return 'notification_event';
}
}