chrisreedio / laravel-scout-keys
提供用户级别的租户令牌/作用域搜索密钥。
v1.0.0-beta.4
2024-09-18 19:14 UTC
Requires
- php: ^8.2
- http-interop/http-factory-guzzle: ^1.2
- illuminate/contracts: ^10.0||^11.0
- laravel/scout: ^10.11
- meilisearch/meilisearch-php: ^1.10
- spatie/laravel-package-tools: ^1.16
- typesense/typesense-php: ^4.9
Requires (Dev)
- larastan/larastan: ^2.9
- laravel/pint: ^1.14
- nunomaduro/collision: ^8.1.1||^7.10.0
- orchestra/testbench: ^9.0.0||^8.22.0
- pestphp/pest: ^2.34
- pestphp/pest-plugin-arch: ^2.7
- pestphp/pest-plugin-laravel: ^2.3
- phpstan/extension-installer: ^1.3
- phpstan/phpstan-deprecation-rules: ^1.1
- phpstan/phpstan-phpunit: ^1.3
- spatie/laravel-ray: ^1.35
This package is auto-updated.
Last update: 2024-09-18 19:15:48 UTC
README
此包为 Laravel Scout 提供用户级别的租户令牌/作用域搜索密钥。
当前实现支持 Meilisearch 和 Typesense 驱动程序。
待办事项
- 添加对生成密钥面/过滤属性运行时配置的支持
安装
您可以通过 composer 安装此包
composer require chrisreedio/laravel-scout-keys
您可以使用以下命令发布和运行迁移
php artisan vendor:publish --tag="laravel-scout-keys-migrations"
php artisan migrate
您可以使用以下命令发布配置文件
php artisan vendor:publish --tag="laravel-scout-keys-config"
这是已发布配置文件的内容
return [ /** * Whether to register the Scout Indexing commands for use via web. */ 'register_commands' => false, 'key' => [ /** * The number of minutes a search key should be valid for. */ 'lifetime' => env('SCOUT_KEY_EXPIRATION', 60 * 12), ], ];
用法
将 SearchUser
接口和 HasSearchKeys
特性添加到您的 User
模型中。
示例
class User extends Authenticatable SearchUser { use HasFactory, HasSearchKeys; // ... }
最后,将以下内容添加到您的 web.php
路由文件中
ScoutKeys::getRoute();
如果您想更改默认的 /search/key
路径,可以将期望的路径作为第一个参数传递给 getRoute
方法。
ScoutKeys::getRoute('dashboard/search/key');
测试
composer test
变更日志
有关最近更改的更多信息,请参阅CHANGELOG。
贡献
有关详细信息,请参阅CONTRIBUTING。
安全漏洞
有关如何报告安全漏洞,请参阅我们的安全策略。
致谢
许可协议
MIT 许可协议 (MIT)。有关更多信息,请参阅许可文件。