SearchEngineFactory.php

Go to the documentation of this file.

<?php
 
use MediaWiki\HookContainer\HookContainer;
use Wikimedia\ObjectFactory\ObjectFactory;
use Wikimedia\Rdbms\IDatabase;
use Wikimedia\Rdbms\ILoadBalancer;
 
class SearchEngineFactory {
    private $config;
 
    private $hookContainer;
 
    private $loadBalancer;
 
    public function __construct(
        SearchEngineConfig $config,
        HookContainer $hookContainer,
        ILoadBalancer $loadBalancer
    ) {
        $this->config = $config;
        $this->hookContainer = $hookContainer;
        $this->loadBalancer = $loadBalancer;
    }
 
    public function create( $type = null ) {
        $configuredClass = $this->config->getSearchType();
        $alternativesClasses = $this->config->getSearchTypes();
 
        if ( $type !== null && in_array( $type, $alternativesClasses ) ) {
            $class = $type;
        } elseif ( $configuredClass !== null ) {
            $class = $configuredClass;
        } else {
            $class = self::getSearchEngineClass( $this->loadBalancer );
        }
 
        $mappings = $this->config->getSearchMappings();
 
        if ( isset( $mappings[$class] ) ) {
            $spec = $mappings[$class];
        } else {
            // Convert non mapped classes to ObjectFactory spec
            $spec = [ 'class' => $class ];
        }
 
        $args = [];
 
        if ( isset( $spec['class'] ) && is_subclass_of( $spec['class'], SearchDatabase::class ) ) {
            $args['extraArgs'][] = $this->loadBalancer;
        }
 
        // ObjectFactory::getObjectFromSpec accepts an array, not just a callable (phan bug)
        // @phan-suppress-next-line PhanTypeInvalidCallableArraySize
        $engine = ObjectFactory::getObjectFromSpec( $spec, $args );
        $engine->setHookContainer( $this->hookContainer );
        return $engine;
    }
 
    public static function getSearchEngineClass( $dbOrLb ) {
        $type = ( $dbOrLb instanceof IDatabase )
            ? $dbOrLb->getType()
            : $dbOrLb->getServerType( $dbOrLb->getWriterIndex() );
 
        switch ( $type ) {
            case 'sqlite':
                return SearchSqlite::class;
            case 'mysql':
                return SearchMySQL::class;
            case 'postgres':
                return SearchPostgres::class;
            default:
                return SearchEngineDummy::class;
        }
    }
}