ChangesListFilterFactory.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\RecentChanges;
 
use InvalidArgumentException;
use UnexpectedValueException;
 
class ChangesListFilterFactory {
    private ?string $showHidePrefix;
 
    public function __construct( private array $config ) {
        $this->showHidePrefix = $config['showHidePrefix'] ?? null;
    }
 
    public function registerFiltersFromDefinitions(
        ChangesListFilterGroupContainer $container,
        array $definitions
    ) {
        foreach ( $definitions as $groupDefinition ) {
            if ( !$this->isConfigSatisfied( $groupDefinition ) ) {
                continue;
            }
            $this->transformGroupDefinition( $container, $groupDefinition );
            $group = $this->createGroup( $groupDefinition );
            $this->registerSupersets( $group, $groupDefinition );
            $container->registerGroup( $group );
            $this->registerConflicts( $container, $group, $groupDefinition );
            $this->handlePendingConflicts( $container, $group );
        }
    }
 
    private function isConfigSatisfied( array $def ) {
        foreach ( $def['requireConfig'] ?? [] as $name => $value ) {
            if ( !array_key_exists( $name, $this->config ) || $this->config[$name] !== $value ) {
                return false;
            }
        }
        return true;
    }
 
    private function transformGroupDefinition(
        ChangesListFilterGroupContainer $container,
        array &$groupDefinition
    ) {
        $groupDefinition['priority'] =
            $container->fillPriority( $groupDefinition['priority'] ?? null );
 
        $filterDefs = [];
        foreach ( $groupDefinition['filters'] as $def ) {
            if ( !$this->isConfigSatisfied( $def ) ) {
                continue;
            }
            $def = $this->transformFilterDefinition( $def );
            $filterDefs[] = $def;
        }
        $groupDefinition['filters'] = $filterDefs;
    }
 
    private function transformFilterDefinition( array $filterDefinition ) {
        if ( $this->showHidePrefix !== null && isset( $filterDefinition['showHideSuffix'] ) ) {
            $filterDefinition['showHide'] = $this->showHidePrefix . $filterDefinition['showHideSuffix'];
        }
 
        return $filterDefinition;
    }
 
    private function createGroup( array $groupDefinition ): ChangesListFilterGroup {
        $className = $groupDefinition['class'];
        unset( $groupDefinition['class'] );
 
        $group = new $className( $groupDefinition );
        if ( !( $group instanceof ChangesListFilterGroup ) ) {
            throw new UnexpectedValueException(
                "$className was expected to be an instance of ChangesListFilterGroup" );
        }
        return $group;
    }
 
    private function registerSupersets( ChangesListFilterGroup $group, array $groupDefinition ) {
        foreach ( $groupDefinition['filters'] as $def ) {
            foreach ( $def['subsets'] ?? [] as $subsetName ) {
                $filter = $group->getFilter( $def['name'] );
                $subset = $group->getFilter( $subsetName );
                if ( $filter && $subset ) {
                    $filter->setAsSupersetOf( $subset );
                }
            }
        }
    }
 
    private function registerConflicts(
        ChangesListFilterGroupContainer $container,
        ChangesListFilterGroup $group,
        array $groupDefinition
    ) {
        foreach ( $groupDefinition['filters'] as $def ) {
            $filter = $group->getFilter( $def['name'] );
            foreach ( $def['conflictsWith'] ?? [] as $conflictingGroupName => $conflictingFilters ) {
                foreach ( $conflictingFilters as $conflictingFilterName => $opts ) {
                    '@phan-var array $opts';
                    $opts += $def['conflictOptions'] ?? [];
                    $missing = array_diff(
                        [ 'globalKey', 'forwardKey', 'backwardKey' ],
                        array_keys( $opts )
                    );
                    if ( $missing ) {
                        throw new InvalidArgumentException(
                            "The conflict option(s) " . implode( ', ', $missing ) .
                            " must be present in either conflictsWith or conflictOptions in " .
                            "the definition of filter {$group->getName()}/{$def['name']}"
                        );
                    }
                    $conflictingGroup = $container->getGroup( $conflictingGroupName );
                    $conflictingFilter = $conflictingGroup?->getFilter( $conflictingFilterName );
                    if ( $conflictingFilter ) {
                        $filter->conflictsWith(
                            $conflictingFilter,
                            $opts['globalKey'],
                            $opts['forwardKey'],
                            $opts['backwardKey']
                        );
                    } else {
                        $container->addPendingConflict(
                            $filter,
                            $conflictingGroupName,
                            $conflictingFilterName,
                            $opts
                        );
                    }
                }
            }
        }
    }
 
    private function handlePendingConflicts(
        ChangesListFilterGroupContainer $container,
        ChangesListFilterGroup $group
    ) {
        foreach ( $group->getFilters() as $filter ) {
            $conflicts = $container->popPendingConflicts( $group, $filter );
            foreach ( $conflicts as [ $sourceFilter, $opts ] ) {
                $sourceFilter->conflictsWith(
                    $filter,
                    $opts['globalKey'],
                    $opts['forwardKey'],
                    $opts['backwardKey']
                );
            }
        }
    }
}