README

施兰兹搜索印章
Yii 集成

Schranz Search — 搜索引擎抽象层（SEAL）集成到 Yii。

注意：这是 schranz-search/schranz-search 项目的部分，请在 主仓库 中创建问题。

注意：此项目正在积极开发中，任何反馈都将受到高度重视。

安装

使用 composer 安装包

composer require schranz-search/yii-module

同时安装以下列表中的任何一个适配器。

适配器列表

以下适配器可用

• MemoryAdapter: schranz-search/seal-memory-adapter
• ElasticsearchAdapter: schranz-search/seal-elasticsearch-adapter
• OpensearchAdapter: schranz-search/seal-opensearch-adapter
• MeilisearchAdapter: schranz-search/seal-meilisearch-adapter
• AlgoliaAdapter: schranz-search/seal-algolia-adapter
• SolrAdapter: schranz-search/seal-solr-adapter
• RediSearchAdapter: schranz-search/seal-redisearch-adapter
• TypesenseAdapter: schranz-search/seal-typesense-adapter
• ... 更多即将推出

额外的包装适配器

• 读写适配器
• 多适配器

创建自己的适配器？请将 seal-php-adapter 主题添加到您的 Github 仓库。

用法

以下代码显示了如何配置包

<?php

// config/common/params.php

return [
    // ...
    'schranz-search/yii-module' => [
        'schemas' => [
            'app' => [
                'dir' => 'config/schemas',
            ],
        ],
        'engines' => [
            'default' => [
                'adapter' => 'meilisearch://127.0.0.1:7700',
            ],
        ],
        'index_name_prefix' => '',
        'reindex_providers' => [
            \App\Search\BlogReindexProvider::class,
        ],
    ],
];

更复杂的配置可以在这里找到

<?php

// config/common/params.php

return [
    // ...
    'schranz-search/yii-module' => [
        'schemas' => [
            'app' => [
                'dir' => 'config/schemas/app',
                'engine' => 'meilisearch',
            ],
            'other' => [
                'dir' => 'config/schemas/other',
                'engine' => 'algolia',
            ],
        ],
        'engines' => [
            'algolia' => [
                'adapter' => 'algolia://' . $_ENV['ALGOLIA_APPLICATION_ID'] . ':' . $_ENV['ALGOLIA_ADMIN_API_KEY'],
            ],
            'elasticsearch' => [
                'adapter' => 'elasticsearch://127.0.0.1:9200',
            ],
            'meilisearch' => [
                'adapter' => 'meilisearch://127.0.0.1:7700',
            ],
            'memory' => [
                'adapter' => 'memory://',
            ],
            'opensearch' => [
                'adapter' => 'opensearch://127.0.0.1:9200',
            ],
            'redisearch' => [
                'adapter' => 'redis://supersecure@127.0.0.1:6379',
            ],
            'solr' => [
                'adapter' => 'solr://127.0.0.1:8983',
            ],
            'typesense' => [
                'adapter' => 'typesense://S3CR3T@127.0.0.1:8108',
            ],
            
            // ...
            'multi' => [
                'adapter' => 'multi://elasticsearch?adapters[]=opensearch',
            ],
            'read-write' => [
                'adapter' => 'read-write://elasticsearch?write=multi',
            ],
        ],
    ],
];

默认引擎作为 Engine 提供

class Some {
    public function __construct(
        private readonly \Schranz\Search\SEAL\EngineInterface $engine,
    ) {
    }
}

可以通过 EngineRegistry 访问多个引擎

class Some {
    private Engine $engine;

    public function __construct(
        private readonly \Schranz\Search\SEAL\EngineRegistry $engineRegistry,
    ) {
        $this->engine = $this->engineRegistry->getEngine('algolia');
    }
}

如何创建 Schema 文件和使用您的 Engine 可以在 SEAL 文档 中找到。

命令

该包提供了以下命令

创建配置的索引

./yii schranz:search:index-create

删除配置的索引

./yii schranz:search:index-drop

作者

• Alexander Schranz
• 社区贡献者