README

注意：SignatureV4 支持已集成到 Opensearch-PHP 客户端（opensearch-project/opensearch-php）自 版本 2.0.1 起如果您正在使用 Opensearch-PHP 客户端，则不需要使用此库。

此包为官方 Elasticsearch-PHP 客户端（elasticsearch/elasticsearch）提供了签名处理程序。默认情况下，处理程序将从环境变量中加载 AWS 凭证并使用 RingPHP cURL 处理程序发送请求。

搜索库包需要单独安装。以下文档将使用 Elasticsearch-PHP 在示例中，但这两个库应该非常相似。

基本用法

Aws\ElasticsearchService\ElasticsearchPhpHandler 实例是满足 Elasticsearch-PHP 处理程序约定的可调用对象。可以将它们传递给 Elasticsearch\ClientBuilder 的 setHandler 方法

use Aws\ElasticsearchService\ElasticsearchPhpHandler;
use Elasticsearch\ClientBuilder;

// Create a handler (with the region of your Amazon Elasticsearch Service domain)
$handler = new ElasticsearchPhpHandler('us-west-2');

// Use this handler to create an Elasticsearch-PHP client
$client = ClientBuilder::create()
    ->setHandler($handler)
    ->setHosts(['https://search-foo-3gn4utxfus5cqpn89go4z5lbsm.us-west-2.es.amazonaws.com:443'])
    ->build();

// Use the client as you normally would
$client->index([
    'index' => $index,
    'type' => $type,
    'id' => $id,
    'body' => [$key => $value]
]);

使用自定义凭证

默认情况下，处理程序将尝试从环境变量中获取凭证，如 AWS SDK for PHP 文档中所述 所述。要使用自定义凭证，请传递一个 凭证提供者

use Aws\Credentials\CredentialProvider;
use Aws\Credentials\Credentials;
use Aws\ElasticsearchService\ElasticsearchPhpHandler;

$provider = CredentialProvider::fromCredentials(
    new Credentials('foo', 'bar', 'baz')
);

$handler = new ElasticsearchPhpHandler('us-west-2', $provider);

使用自定义 HTTP 处理程序

默认情况下，处理程序将使用 Elasticsearch\ClientBuilder::defaultHandler() 来分派 HTTP 请求，但可以通过可选构造函数参数进行自定义。例如，此存储库的测试使用自定义处理程序来模拟网络流量

class ElasticsearchPhpHandlerTest extends \PHPUnit_Framework_TestCase
{
    public function testSignsRequestsPassedToHandler()
    {
        $toWrap = function (array $ringRequest) {
            $this->assertArrayHasKey('X-Amz-Date', $ringRequest['headers']);
            $this->assertArrayHasKey('Authorization', $ringRequest['headers']);
            $this->assertStringStartsWith(
                'AWS4-HMAC-SHA256 Credential=',
                $ringRequest['headers']['Authorization'][0]
            );

            return $this->getGenericResponse();
        };
        $handler = new ElasticsearchPhpHandler('us-west-2', null, $toWrap);

        $client = \Elasticsearch\ClientBuilder::create()
            ->setHandler($handler)
            ->build();

        $client->get([
            'index' => 'index',
            'type' => 'type',
            'id' => 'id',
        ]);
    }
    ...
}

安装

Composer

composer require jsq/amazon-es-php elasticsearch/elasticsearch:"<8.0"

或

composer require jsq/amazon-es-php opensearch-project/opensearch-php