README

由于原始 Laravel-Searchy 已经停止维护，我创建了分支使其与 laravel 8 兼容，通过编辑 composer.json 和必要的代码来实现，但没有进行全面测试，请谨慎使用。

大部分原始代码、命名空间和函数名都保持不变。

原始仓库在这里 https://github.com/TomLingham/Laravel-Searchy

Laravel 5+ Searchy

简化数据库搜索

Searchy 是一个易于使用、轻量级、仅支持 MySQL 的 Laravel 扩展包，它使得在模型数据上运行用户驱动的搜索变得简单而有效。它使用伪模糊搜索和其他加权机制，具体取决于您启用的搜索驱动程序。它不需要在服务器上安装其他软件（因此可能比专用搜索程序稍慢），但可以在几分钟内设置并运行。

!! Laravel 4 !!

寻找与 Laravel 4 兼容的 Searchy？查看 1.0 分支 :)

https://github.com/TomLingham/Laravel-Searchy/tree/1.0

安装

将 "tom-lingham/searchy" : "2.*" 添加到您的 composer.json 文件中的 require 部分

"require": {
  "laravel/framework": "5.*",
  "tom-lingham/searchy" : "2.*"
}

在终端中运行 composer update 以将包拉入您的 vendors 文件夹。

将服务提供程序添加到 Laravel 的 ./config/app.php 文件中的 providers 数组

TomLingham\Searchy\SearchyServiceProvider::class

如果您希望在应用程序中快速访问它，请将别名添加到 Laravel 的 ./config/app.php 文件中的 aliases 数组

'Searchy' => TomLingham\Searchy\Facades\Searchy::class

用法

要使用 Searchy，您可以利用魔法方法。

如果您正在搜索 users 表中用户的名字和电子邮件列/字段，例如，您可以运行

$users = Searchy::users('name', 'email')->query('John Smith')->get();

您也可以这样写

$users = Searchy::search('users')->fields('name', 'email')->query('John Smith')->get();

在这种情况下，将您想要搜索的列传递给 fields() 方法。

这两个示例都返回包含您的搜索结果的 Object 数组。如果您想要对结果进行进一步操作，可以使用 getQuery() 替换 get() 来返回数据库查询对象的实例。

$users = Searchy::search('users')->fields('name', 'email')->query('John Smith')
    ->getQuery()->having('relevance', '>', 20)->get();

返回结果限制

要限制您的结果，您可以使用 Laravel 内置的数据库查询构建器方法和链式方法来缩小您的结果。

// Only get the top 10 results
$users = Searchy::search('users')->fields('name', 'email')->query('John Smith')
    ->getQuery()->limit(10)->get();

搜索多个列

您还可以向要搜索的列/字段列表添加多个参数。

例如，如果您想搜索用户的名字、电子邮件地址和用户名，您可能会运行

$users = Searchy::users('name', 'email', 'username')->query('John Smith')->get();

如果您需要动态构建表单列表，您也可以将字段数组作为第一个参数传递（其他所有后续参数将被忽略）

$users = Searchy::users(['name', 'email', 'username'])->query('John Smith')->get();

搜索连接/连接列

有时您可能想要利用对连接列的搜索。例如，在 first_name 和 last_name 字段上，但您只想运行一个查询。要做到这一点，可以使用双冒号分隔列

$users = Searchy::users('first_name::last_name')->query('John Smith')->get();

软删除记录

默认情况下，软删除的记录将不会包含在您的结果中。但是，如果您希望包含软删除的记录，您可以在指定表和字段后添加 withTrashed() 来实现

Searchy::users('name')->withTrashed()->query('Batman')->get();

仅返回特定列

您可以在搜索中指定要返回的列

$users = Searchy::users('first_name::last_name')->query('John Smith')->select('first_name')->get();

// Or you can swap those around...
$users = Searchy::users('first_name::last_name')->select('first_name')->query('John Smith')->get();

但是，这也会返回 relevance 别名列，无论在这里输入了什么。

如何获取 Laravel Eloquent Collection

将搜索结果转换为Laravel Eloquent模型集合超出了本项目范围。然而，一个简单的方法是在不频繁访问数据库的情况下实现这一点，那就是使用Eloquent的hydrate()方法。

\App\User::hydrate(Searchy::users('name', 'email')->query('Andrew')->get());

此方法将创建一个由普通数组构成的模型集合。这正是我们的情况，因为Searchy的结果以数组的形式提供，通过使用hydrate，我们将它们转换为User模型的实例。

Unicode字符支持

如果您因为搜索数据中包含Unicode字符而遇到返回结果的问题，可以使用FuzzySearchUnicodeDriver。

请注意：在将字符串插入到原始MySQL语句之前，没有对通过FuzzySearchUnicodeDriver传递的字符串进行清理。您必须首先自行清理字符串，否则可能会使您的应用程序面临SQL注入攻击。警告过您了。

要使用，首先按照说明发布您的配置文件（php artisan vendor:publish），并将默认驱动程序从fuzzy更改为ufuzzy。

return [

    'default' => 'ufuzzy',

  ...
]

配置

您可以将配置文件发布到您的app目录，并通过运行php artisan vendor:publish来覆盖设置，将配置复制到您的配置文件夹中的searchy.php。

您可以在配置文件中设置用于搜索的默认驱动程序。目前您的选项是：fuzzy、simple和levenshtein。

您还可以在运行搜索时使用以下语法覆盖这些方法

Searchy::driver('fuzzy')->users('name')->query('Batman')->get();

驱动程序

Searchy利用“驱动程序”来处理指定字段的匹配条件。

驱动程序是简单地指定的一组“匹配器”，根据特定条件匹配字符串。

目前只有三个驱动程序：简单、模糊和Levenshtein（实验性）。

简单搜索驱动程序

简单搜索驱动程序仅使用3个匹配器，每个匹配器都使用与测试环境最合适的相关乘数。

protected $matchers = [
  'TomLingham\Searchy\Matchers\ExactMatcher'                 => 100,
  'TomLingham\Searchy\Matchers\StartOfStringMatcher'         => 50,
  'TomLingham\Searchy\Matchers\InStringMatcher'              => 30,
];

模糊搜索驱动程序

模糊搜索驱动程序是另一组匹配器，设置如下。乘数是我使用的，但您可以根据需要更改这些或创建具有相同匹配器的自定义驱动程序，并更改乘数以适应。

protected $matchers = [
  'TomLingham\Searchy\Matchers\ExactMatcher'                 => 100,
  'TomLingham\Searchy\Matchers\StartOfStringMatcher'         => 50,
  'TomLingham\Searchy\Matchers\AcronymMatcher'               => 42,
  'TomLingham\Searchy\Matchers\ConsecutiveCharactersMatcher' => 40,
  'TomLingham\Searchy\Matchers\StartOfWordsMatcher'          => 35,
  'TomLingham\Searchy\Matchers\StudlyCaseMatcher'            => 32,
  'TomLingham\Searchy\Matchers\InStringMatcher'              => 30,
  'TomLingham\Searchy\Matchers\TimesInStringMatcher'         => 8,
];

Levenshtein搜索驱动程序（实验性）

Levenshtein搜索驱动程序使用Levenshtein距离来计算字符串之间的“距离”。它要求您在MySQL中有一个类似以下存储过程的存储过程：levenshtein(string1, string2)。在res文件夹中有一个包含合适函数的SQL文件 - 您可以使用这个。

protected $matchers = [
  'TomLingham\Searchy\Matchers\LevenshteinMatcher' => 100
];

匹配器

ExactMatcher

匹配精确字符串并应用高乘数以将任何精确匹配项置于顶部。

StartOfStringMatcher

匹配以搜索字符串开头的字符串。例如，搜索“hel”会匹配“Hello World”或“helping hand”。

AcronymMatcher

匹配类似于缩写的字符串，但不返回Studly Case匹配。例如，搜索“fb”会匹配“foo bar”或“Fred Brown”，但不匹配“FreeBeer”。

ConsecutiveCharactersMatcher

匹配包含搜索字符串中所有字符的字符串，这些字符在字符串中的位置相对。它还计算字符串中匹配的字符百分比，并相应地应用乘数。

例如，搜索“fba”会匹配“Foo Bar”或“Afraid of bats”，但不匹配“fabulous”。

StartOfWordsMatcher

匹配每个单词的开头与搜索中的每个单词进行匹配。

例如，搜索“jo ta”会匹配“John Taylor”或“Joshua B. Takeshi”。

StudlyCaseMatcher

使用单词的首字母匹配Studly Case字符串。

例如，搜索“hp”会匹配“HtmlServiceProvider”或“HashParser”，但不匹配“hasProvider”。

InStringMatcher

匹配字符串中任何字符串出现的情况，且不区分大小写。

例如，搜索“smi”会匹配“John Smith”或“Smiley Face”

TimesInStringMatcher

基于搜索字符串在字符串中出现的次数匹配字符串，并对每个出现应用乘数。例如，搜索“tha”会匹配“I hope that that cat has caught that mouse”（3 x 乘数）或“Thanks, it was great!”（1 x 乘数）

LevenshteinMatcher

见 Levenshtein Driver

扩展

驱动程序

自己编写搜索驱动程序非常简单。只需创建一个扩展TomLingham\Searchy\SearchDrivers\BaseSearchDriver的类，并添加一个名为$matchers的属性，其值为匹配器类的数组，每个匹配器的乘数作为值。您可以选择Searchy已包含的类，或者创建自己的类。

匹配器

要创建自己的匹配器，您可以创建一个扩展TomLingham\Searchy\Matchers\BaseMatcher的类，并且（对于简单的匹配器）重写formatQuery方法，以返回带有%通配符的字符串格式。对于更高级的扩展，您可能还需要重写buildQuery方法和其他方法。

贡献 & 报告错误

如果您想改进这里的代码，请随时提交拉取请求。

如果您发现任何错误，请在此处提交，我会尽快响应。请确保提供尽可能多的信息。