ChangesListBooleanFilter.php

Go to the documentation of this file.

<?php
use Wikimedia\Rdbms\IDatabase;
 
class ChangesListBooleanFilter extends ChangesListFilter {
    // This can sometimes be different on Special:RecentChanges
    // and Special:Watchlist, due to the double-legacy hooks
    // (SpecialRecentChangesFilters and SpecialWatchlistFilters)
 
    // but there will be separate sets of ChangesListFilterGroup and ChangesListFilter instances
    // for those pages (it should work even if they're both loaded
    // at once, but that can't happen).
    protected $showHide;
 
    protected $isReplacedInStructuredUi;
 
    protected $defaultValue;
 
    protected $queryCallable;
 
    protected $activeValue;
 
    public function __construct( $filterDefinition ) {
        parent::__construct( $filterDefinition );
 
        if ( isset( $filterDefinition['showHide'] ) ) {
            $this->showHide = $filterDefinition['showHide'];
        }
 
        if ( isset( $filterDefinition['isReplacedInStructuredUi'] ) ) {
            $this->isReplacedInStructuredUi = $filterDefinition['isReplacedInStructuredUi'];
        } else {
            $this->isReplacedInStructuredUi = false;
        }
 
        if ( isset( $filterDefinition['default'] ) ) {
            $this->setDefault( $filterDefinition['default'] );
        } else {
            throw new MWException( 'You must set a default' );
        }
 
        if ( isset( $filterDefinition['queryCallable'] ) ) {
            $this->queryCallable = $filterDefinition['queryCallable'];
        }
 
        if ( isset( $filterDefinition['activeValue'] ) ) {
            $this->activeValue = $filterDefinition['activeValue'];
        } else {
            $this->activeValue = true;
        }
    }
 
    public function getDefault( $structuredUI = false ) {
        return $this->isReplacedInStructuredUi && $structuredUI ?
            !$this->activeValue :
            $this->defaultValue;
    }
 
    public function setDefault( $defaultValue ) {
        $this->defaultValue = (bool)$defaultValue;
    }
 
    public function getShowHide() {
        return $this->showHide;
    }
 
    public function displaysOnUnstructuredUi() {
        return !!$this->showHide;
    }
 
    public function isFeatureAvailableOnStructuredUi() {
        return $this->isReplacedInStructuredUi ||
            parent::isFeatureAvailableOnStructuredUi();
    }
 
    public function modifyQuery( IDatabase $dbr, ChangesListSpecialPage $specialPage,
        &$tables, &$fields, &$conds, &$query_options, &$join_conds
    ) {
        if ( $this->queryCallable === null ) {
            return;
        }
 
        call_user_func_array(
            $this->queryCallable,
            [
                get_class( $specialPage ),
                $specialPage->getContext(),
                $dbr,
                &$tables,
                &$fields,
                &$conds,
                &$query_options,
                &$join_conds
            ]
        );
    }
 
    public function getJsData() {
        $output = parent::getJsData();
 
        $output['default'] = $this->defaultValue;
 
        return $output;
    }
 
    public function isSelected( FormOptions $opts ) {
        return !$opts[ $this->getName() ] &&
            array_filter(
                $this->getSiblings(),
                function ( ChangesListBooleanFilter $sibling ) use ( $opts ) {
                    return $opts[ $sibling->getName() ];
                }
            );
    }
 
    public function isActive( FormOptions $opts, $isStructuredUI ) {
        if ( $this->isReplacedInStructuredUi && $isStructuredUI ) {
            return false;
        }
 
        return $opts[ $this->getName() ] === $this->activeValue;
    }
}