ChangesListBooleanFilterGroup.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\RecentChanges;
 
use InvalidArgumentException;
use MediaWiki\Html\FormOptions;
use MediaWiki\SpecialPage\ChangesListSpecialPage;
use Wikimedia\Rdbms\IReadableDatabase;
 
class ChangesListBooleanFilterGroup extends ChangesListFilterGroup {
    public const TYPE = 'send_unselected_if_any';
 
    public function __construct( array $groupDefinition ) {
        $groupDefinition['isFullCoverage'] = true;
        $groupDefinition['type'] = self::TYPE;
 
        parent::__construct( $groupDefinition );
    }
 
    protected function createFilter( array $filterDefinition ) {
        return new ChangesListBooleanFilter( $filterDefinition );
    }
 
    public function setDefault( $defaultValue ) {
        if ( !is_array( $defaultValue ) ) {
            throw new InvalidArgumentException(
                "Can't set the default of filter options group \"{$this->getName()}\"" .
                ' to a value of type "' . gettype( $defaultValue ) . ': expected bool[]' );
        }
        foreach ( $defaultValue as $name => $value ) {
            if ( !is_bool( $value ) ) {
                throw new InvalidArgumentException(
                    "Can't set the default of filter option \"{$this->getName()}/$name\"" .
                    ' to a value of type "' . gettype( $value ) . ': expected bool' );
            }
            $this->getFilter( $name )?->setDefault( $value );
        }
    }
 
    public function registerFilter( ChangesListBooleanFilter $filter ) {
        $this->filters[$filter->getName()] = $filter;
    }
 
    public function modifyQuery( IReadableDatabase $dbr, ChangesListSpecialPage $specialPage,
        &$tables, &$fields, &$conds, &$query_options, &$join_conds,
        FormOptions $opts, $isStructuredFiltersEnabled
    ) {
        foreach ( $this->getFilters() as $filter ) {
            if ( $filter->isActive( $opts, $isStructuredFiltersEnabled ) ) {
                $filter->modifyQuery( $dbr, $specialPage, $tables, $fields, $conds,
                    $query_options, $join_conds );
            }
        }
    }
 
    public function addOptions( FormOptions $opts, $allowDefaults, $isStructuredFiltersEnabled ) {
        foreach ( $this->getFilters() as $filter ) {
            $defaultValue = $allowDefaults ? $filter->getDefault( $isStructuredFiltersEnabled ) : false;
            $opts->add( $filter->getName(), $defaultValue );
        }
    }
}
 
class_alias( ChangesListBooleanFilterGroup::class, 'ChangesListBooleanFilterGroup' );