guikingone/meili-search-bundle

一个启用 MeiliSearch 的 Symfony 扩展包

维护者

详细信息

github.com/Guikingone/MeiliSearchBundle

源代码

问题

安装: 3

依赖者: 0

建议者: 0

安全: 0

星标: 11

关注者: 2

分支: 2

开放问题: 8

类型：symfony-bundle

0.1.0 2020-11-02 17:34 UTC

Requires

Requires (Dev)

Suggests

  • doctrine/common: Allow to use the Document annotation
  • doctrine/orm: Allow to listen to entity events and trigger related MeiliSearch actions
  • symfony/cache: Allow to use the CachedSearchEntryPoint to improve performances
  • symfony/form: Allow to use custom types which brings search features
  • symfony/messenger: Allow to dispatch messages and delay some actions (like index|documents creation)
  • twig/extensions: Allow to lazy-load the SearchExtension
  • twig/twig: Allow to use the search features in Twig templates

MIT 92288a654e5f839ab2158a44cc83eb0be4d13c2e

  • Guillaume Loulier <contact.woop@guillaumeloulier.fr>

symfonysearchbundlemeilisearch

This package is auto-updated.

Last update: 2024-09-23 21:39:27 UTC

README

MeiliSearchBundle CI SymfonyInsight

MeiliSearchBundle 是一个有偏见的 Symfony 扩展包，它可以配置和启用 MeiliSearch。

核心逻辑作为官方 MeiliSearch PHP SDK 的包装器。

主要功能

  • 支持 DTO（通过 Symfony/Serializer）对文档进行操作
  • 通过 YAML/XML/PHP/Annotation 进行映射
  • 通过注解或自定义提供者定义文档
  • Symfony/Messenger 集成
  • 支持 Symfony/HttpClient
  • 集成 Symfony/Cache（回退、搜索、CRUD）
  • 支持 Symfony/ExpressionLanguage 构建查询
  • 集成 Twig
  • 自定义表单类型
  • 支持 PHP 7.2 到 7.4（目前不支持 8.0）
  • 支持 Ramsey/uuid

安装

请确保已全局安装 Composer，如 Composer 文档的 安装章节 所述。

composer require guikingone/meili-search-bundle

安装完成后，更新 config/bundles.php

// config/bundles.php

return [
    // ...
    MeiliSearchBundle\MeiliSearchBundle::class => ['all' => true],
];

完成操作后，添加 config/packages/meili_search.yaml

# config/packages/meili_search.yaml
meili_search:
    host: '%env(MEILI_HOST)%' # Default to http://127.0.0.1
    api_key: '%env(MEILI_API_KEY)%' # Optional but recommended in development mode

使用

有关如何使用此扩展包的完整说明，请参阅 文档。

贡献

有关如何为此扩展包做出贡献的完整说明，请参阅 CONTRIBUTING.md。