Typesense PHP 客户端库使用教程

Typesense PHP 客户端库使用教程

typesense-phpPHP client for Typesense: https://github.com/typesense/typesense项目地址:https://gitcode.com/gh_mirrors/ty/typesense-php

1. 项目的目录结构及介绍

Typesense PHP 客户端库的目录结构如下：

typesense-php/
├── src/
│   ├── Client.php
│   ├── Collection.php
│   ├── Document.php
│   ├── Health.php
│   ├── Keys.php
│   ├── MultiSearch.php
│   ├── Operations.php
│   ├── Overrides.php
│   ├── Schemas.php
│   ├── Synonyms.php
│   └── Typesense.php
├── tests/
│   ├── ClientTest.php
│   ├── CollectionTest.php
│   ├── DocumentTest.php
│   ├── HealthTest.php
│   ├── KeysTest.php
│   ├── MultiSearchTest.php
│   ├── OperationsTest.php
│   ├── OverridesTest.php
│   ├── SchemasTest.php
│   ├── SynonymsTest.php
│   └── TypesenseTest.php
├── composer.json
├── LICENSE
├── README.md
└── phpunit.xml

目录结构介绍

• src/：包含 Typesense PHP 客户端库的主要源代码文件。

  • Client.php：客户端类，用于与 Typesense 服务器进行交互。
  • Collection.php：集合操作类。
  • Document.php：文档操作类。
  • Health.php：健康检查类。
  • Keys.php：API 密钥管理类。
  • MultiSearch.php：多搜索操作类。
  • Operations.php：通用操作类。
  • Overrides.php：覆盖操作类。
  • Schemas.php：模式管理类。
  • Synonyms.php：同义词管理类。
  • Typesense.php：主类，包含所有其他类的实例。

• tests/：包含单元测试文件，用于测试客户端库的各个功能。

• composer.json：Composer 配置文件，用于管理依赖关系。

• LICENSE：项目许可证文件。

• README.md：项目说明文档。

• phpunit.xml：PHPUnit 配置文件，用于运行单元测试。

2. 项目的启动文件介绍

Typesense PHP 客户端库的启动文件是 src/Client.php。这个文件定义了 Client 类，它是与 Typesense 服务器进行交互的主要接口。

Client.php 文件介绍

Client.php 文件包含了以下主要功能：

• 初始化客户端实例：

  use Typesense\Client;
  
  $client = new Client([
      'api_key' => 'your_api_key',
      'nodes' => [
          [
              'host' => 'localhost',
              'port' => '8108',
              'protocol' => 'http'
          ]
      ],
      'connection_timeout_seconds' => 2
  ]);
  

• 提供与 Typesense 服务器交互的方法，如创建集合、添加文档、搜索等。

3. 项目的配置文件介绍

Typesense PHP 客户端库的配置文件是 composer.json。这个文件用于管理项目的依赖关系和其他配置。

composer.json 文件介绍

composer.json 文件包含了以下主要内容：

• 项目名称和描述：

  {
      "name": "typesense/typesense-php",
      "description": "Typesense PHP Client",
      "type": "library",
      "license": "Apache-2.0",
      "authors": [
          {
              "name": "Typesense",
              "email": "contact@typesense.org"
          }
      ],
      "require": {
          "php": ">=7.2",
          "ext-curl": "*",
          "ext-json": "*"
      },
      "autoload": {
          "psr-4": {
              "Typesense\\": "src/"
          }
      },
      "require-dev": {
          "phpunit/phpunit": "^8.5"
      }
  }
  

• 依赖关系：

  • php：要求 PHP 版本大于等于 7.2。
  • `ext-

typesense-phpPHP client for Typesense: https://github.com/typesense/typesense项目地址:https://gitcode.com/gh_mirrors/ty/typesense-php