Merge branch '6.0'

[GitHub/WoltLab/WCF.git] / wcfsetup / install / files / lib / system / search / AbstractSearchEngine.class.php

<?php

namespace wcf\system\search;

use wcf\system\database\util\PreparedStatementConditionBuilder;
use wcf\system\SingletonFactory;

/**
 * Default implementation for search engines, this class should be extended by
 * all search engines to preserve compatibility in case of interface changes.
 *
 * @author  Alexander Ebert
 * @copyright   2001-2019 WoltLab GmbH
 * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
 */
abstract class AbstractSearchEngine extends SingletonFactory implements ISearchEngine
{
    /**
     * class name for preferred condition builder
     * @var string
     */
    protected $conditionBuilderClassName = PreparedStatementConditionBuilder::class;

    /**
     * list of engine-specific special characters
     * @var string[]
     */
    protected $specialCharacters = [];

    /**
     * @inheritDoc
     */
    public function getConditionBuilderClassName()
    {
        return $this->conditionBuilderClassName;
    }

    /**
     * @inheritDoc
     */
    public function removeSpecialCharacters($string)
    {
        if (!empty($this->specialCharacters)) {
            return \str_replace($this->specialCharacters, '', $string);
        }

        return $string;
    }
}