README

请参阅 问题 #117

以下是一些您可能可以使用的替代链接（我不保证这些项目的适用性或质量，请在确保它们满足您的需求之前进行自己的尽职调查）

• 待办事项

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 集合

将搜索结果转换为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来覆盖设置，将配置复制到您的config文件夹中的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

匹配类似首字母缩略词的字符串，但不返回大写字母匹配。例如，搜索“fb”将匹配“foo bar”或“Fred Brown”，但不匹配“FreeBeer”。

ConsecutiveCharactersMatcher

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

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

StartOfWordsMatcher

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

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

StudlyCaseMatcher

仅使用单词的首字母匹配大写字母字符串。

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

InStringMatcher

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

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

TimesInStringMatcher

根据搜索字符串在字符串中出现的次数进行匹配，然后对每个出现应用乘数。例如，搜索“tha”将匹配“I hope that that cat has caught that mouse”（3倍乘数）或“Thanks, it was great!”（1倍乘数）

LevenshteinMatcher

参见 Levenshtein 驱动器

扩展

驱动程序

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

匹配器

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

贡献和报告错误

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

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