README

这个搜索引擎的一个小型演示可以在这里找到。这个演示使用了2006年和2016年的1000部电影的数据集。结果会随着你的输入提供。

安装

使用Composer安装此库

composer require vfou/php-search 1.1

它能做什么？

简而言之

• 索引和搜索文档（带有得分、模糊搜索和分词）
• 支持12种语言的词干提取和停用词处理
• 维度分片
• 自动补全
• 连接搜索

请查看特性页面以获取更完整的列表

快速开始

该搜索引擎附带一个示例模式，允许你快速上手库。

首先，你需要加载搜索引擎。

use VFou\Search\Engine;

$engine = new Engine();

你可以在类的构造函数参数中提供一个数组，有关更多信息，请参阅维基百科的配置页面。

通过构建引擎，将在索引文件旁边出现一些目录

• var/engine/index
• var/engine/documents
• var/engine/cache

（所有这些目录都可以通过配置数组进行更改）

首先，你需要给引擎一些可以搜索的东西。我们将创建一些文档并要求引擎索引它们。

$doc = [
    "id" => 1,
    "type" => "example-post",
    "title" => "this is my first blog post !",
    "content" => "I am very happy to post this first post in my blog !",
    "categories" => [
        "party",
        "misc."
    ],
    "date" => "2018/01/01",
    "comments" => [
        [
            "author" => "vincent",
            "date" => "2018/01/01",
            "message" => "Hello world!"
        ],
        [
            "author" => "someone",
            "date" => "2018/01/02",
            "message" => "Welcome !"
        ]
    ]
];
$engine->update($doc);
$doc = [
    "id" => 2,
    "type" => "example-post",
    "title" => "This is the second blog post",
    "content" => "a second one for fun",
    "date" => "2018/01/05",
    "categories" => [
        "misc."
    ],
    "comments" => [
        [
            "author" => "someone",
            "date" => "2018/01/05",
            "message" => "Another one ?!"
        ]
    ]
];
$engine->update($doc);

注意：你也可以将这些两个文档放入一个数组中，并使用updateMultiple()函数一次性索引多个文档。

现在，你的文档已索引，你可以使用搜索功能并获取结果

$response = $engine->search('second post');
var_dump($response);

$response = $engine->search('post');
var_dump($response);

有关此库的更多信息，例如如何使用更高级的功能，请访问此存储库的维基百科页面

管理面板

⚠️ 警告：此面板本身不处理任何安全措施。如果你使用它，防止公众访问的责任由你承担！

管理面板是一个需要实例化和然后运行的类。它不是一个可调用的文件，因此你需要通过一个常规PHP文件来调用它

<?php

use VFou\Search\AdminPanel;

// include the composer autoload file, modify the path if needed
require "vendor/autoload.php";

// securize your file access or directly here
// if($_SERVER['REMOTE_ADDR'] != "127.0.0.1") exit('unauthorized');

// instantiate the panel and then run it
$admin = new AdminPanel();
echo $admin->run();

AdminPanel的构造函数接受与实例化引擎时使用的相同配置数组作为第一个参数，如果你已经自定义了模式，则希望传递它（否则面板将无法正常工作）

更多详细信息请参阅管理面板手册

许可证

此库受MIT许可证的约束。请参阅完整许可证