Elastica 技术文档

1. 安装指南

1.1 环境要求

• PHP 版本：>=8.0 <8.4
• Elasticsearch 版本：8.x
• elasticsearch-php 版本：^8.4

1.2 安装步骤

1. 使用 Composer 安装 Elastica：

   composer require ruflin/elastica
   

2. 确保你的项目中已经安装了 Elasticsearch 服务，并且服务正在运行。

2. 项目的使用说明

2.1 初始化客户端

在使用 Elastica 之前，首先需要初始化一个 Elasticsearch 客户端实例：

use Elastica\Client;

$client = new Client([
    'host' => 'localhost',
    'port' => 9200
]);

2.2 创建索引

创建一个新的索引：

$index = $client->getIndex('my_index');
$index->create();

2.3 添加文档

向索引中添加文档：

$document = new \Elastica\Document(1, ['title' => 'Sample Document', 'content' => 'This is a sample document.']);
$index->addDocument($document);

2.4 搜索文档

执行搜索操作：

$query = new \Elastica\Query(['query' => ['match' => ['content' => 'sample']]]);
$resultSet = $index->search($query);

foreach ($resultSet as $result) {
    echo $result->getData()['title'];
}

3. 项目API使用文档

3.1 客户端 API

• new Client(array $config)：创建一个新的 Elasticsearch 客户端实例。
• getIndex(string $name)：获取或创建一个索引。

3.2 索引 API

• create(array $settings = [])：创建一个新的索引。
• addDocument(Document $document)：向索引中添加文档。
• search(Query $query)：执行搜索操作。

3.3 文档 API

• new Document(int $id, array $data)：创建一个新的文档实例。

4. 项目安装方式

4.1 使用 Composer 安装

通过 Composer 安装 Elastica 是最推荐的方式：

composer require ruflin/elastica

4.2 手动安装

如果你不使用 Composer，也可以手动下载 Elastica 的源码，并将其包含在你的项目中。

---

通过以上文档，你应该能够顺利安装和使用 Elastica 项目。如果在使用过程中遇到问题，可以参考项目的 CONTRIBUTING 文件或通过 Stack Overflow 寻求帮助。