README

此搜索引擎的小型演示可在此处找到。

安装

通过Composer安装此库

composer require saosangmo/php-search

它能做什么？

简而言之

• 索引和搜索文档（带得分、模糊搜索和分词）
• 分面搜索
• 自动完成
• 连接搜索

有关更完整的功能列表，请参阅功能页面

快速入门

搜索引擎包含了一个示例模式，允许您快速上手此库。

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

use saosangmo\Search\Engine;

$engine = new Engine();

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

构建搜索引擎时，将在您的索引文件旁边出现一些目录

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

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

首先，您需要向引擎提供一些要搜索的内容。我们将创建一些文档并要求引擎对它们进行索引。

$doc = [
    "id" => 1,
    "type" => "product",
    "name" => "this is my first blog post !",
    "description" => "I am very happy to post this first post in my blog !",
    "categories" => [
        "party",
        "misc."
    ],
    "date" => "2018/01/01"
];
$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 saosangmo\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许可证。 查看完整许可证