README

Laravel 5的阿里云开放搜索桥接器

安装

该软件包可以通过Composer安装。

composer require orzcc/aliyun-opensearch

一旦安装了OpenSearch，您需要注册服务提供者。打开config/app.php并在providers键中添加以下内容。

• 'Orzcc\Opensearch\OpensearchServiceProvider'

如果您愿意，可以在config/app.php文件的aliases键中注册Opensearch外观。

• 'Opensearch' => 'Orzcc\Opensearch\Facades\Opensearch'

配置

Opensearch需要连接配置。

要开始使用，您需要发布所有供应商资产

$ php artisan vendor:publish

这将创建一个config/opensearch.php文件，您可以修改它来设置配置。同时，请确保检查此软件包中原始配置文件在版本之间的更改。

有两个配置选项

默认连接名称

此选项（'default'）是您指定以下哪个连接作为所有工作的默认连接的地方。当然，您可以使用管理类同时使用多个连接。此设置的默认值是'main'。

OpenSearch连接

此选项（'connections'）是您为应用程序设置每个连接的地方。已包含示例配置，但您可以添加尽可能多的连接。

用法

OpensearchManager

这是最感兴趣的类。它绑定到ioc容器中的'opensearch'，可以通过Facades\Opensearch外观访问。该类通过扩展AbstractManager实现ManagerInterface接口。接口和抽象类都是我的Laravel Manager软件包的一部分，因此您可能想查看该存储库的文档，了解如何使用管理类。请注意，返回的连接类始终是CloudsearchSearch的实例。

Facades\Opensearch

此外观将动态将静态方法调用传递到ioc容器中的'opensearch'对象，默认情况下是OpensearchManager类。

OpensearchServiceProvider

此类不包含任何感兴趣的公共方法。应将此类添加到config/app.php中的提供者数组。此类将设置ioc绑定。

真实示例

在这里，您可以看到这个软件包是多么简单易用。默认情况下，默认适配器是main。在您在配置文件中输入认证和主机详情后，它就会正常工作。

use Orzcc\Opensearch\Facades\Opensearch;
// you can alias this in config/app.php if you like

// Add a new app to search
// $opensearch = Opensearch::connection('main');
// $opensearch = Opensearch::connection('app2');
$opensearch = Opensearch::connection();
$opensearch->setFormat('json');
$opensearch->setQueryString('default:阿里云');

$result = $opensearch->search();

OpenSearch管理器将表现得像一个CloudsearchSearch类。如果您想调用特定的连接，可以使用connection方法。

有关如何使用我们在这里幕后调用的CloudsearchSearch类的更多信息，请参阅http://docs.aliyun.com/#/opensearch/sdk/php&sdk-doc-cloudsearchsearch上的文档，以及https://github.com/GrahamCampbell/Laravel-Manager#usage上的管理类。

许可证

Laravel Aliyun OpenSearch在MIT许可证（MIT）下许可。