WatchlistJoin.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\RecentChanges\ChangesListQuery;
 
use MediaWiki\User\UserIdentity;
 
class WatchlistJoin extends BasicJoin {
    private ?int $userId = null;
 
    public function __construct() {
        parent::__construct(
            'watchlist',
            '',
            [
                'wl_namespace=rc_namespace',
                'wl_title=rc_title'
            ]
        );
    }
 
    public function setUser( UserIdentity $user ) {
        $this->userId = $user->getId();
    }
 
    protected function getExtraConds( ?string $alias ) {
        if ( $this->userId === null ) {
            // Call ChangesListQuery::watchlistUser() before executing the query
            throw new \LogicException( 'User ID must be set for watchlist join' );
        }
        if ( $this->userId === 0 ) {
            // Don't ask for a watchlist join when the user is unregistered
            throw new \LogicException( "Can't join on watchlist with wl_user=0" );
        }
        $field = 'wl_user';
        if ( $alias !== null && $alias !== '' ) {
            $field = "$alias.$field";
        }
        return [ $field => $this->userId ];
    }
}