PHP FastCGI 客户端技术文档

1. 安装指南

使用 Composer 安装

1. 确保你已经安装了 Composer，如果没有安装，请先安装 Composer。
2. 在你的项目根目录下运行以下命令来安装 PHP FastCGI 客户端：

composer require adoy/fastcgi-client

3. 安装完成后，你可以在项目中使用 require 'vendor/autoload.php'; 来引入自动加载文件。

2. 项目的使用说明

基本使用

PHP FastCGI 客户端是一个轻量级的单文件 FastCGI 客户端，用于与 FastCGI 服务器（如 PHP-FPM）进行通信。以下是一个基本的使用示例：

<?php

require 'vendor/autoload.php';

use Adoy\FastCGI\Client;

// 使用 Unix 域套接字连接到 FastCGI 服务器
$client = new Client('unix:///path/to/php/socket', -1);

// 或者使用网络套接字连接到 FastCGI 服务器
$client = new Client('localhost', '9000');

$content = 'key=value';
echo $client->request(
    array(
        'GATEWAY_INTERFACE' => 'FastCGI/1.0',
        'REQUEST_METHOD' => 'POST',
        'SCRIPT_FILENAME' => 'test.php',
        'SERVER_SOFTWARE' => 'php/fcgiclient',
        'REMOTE_ADDR' => '127.0.0.1',
        'REMOTE_PORT' => '9985',
        'SERVER_ADDR' => '127.0.0.1',
        'SERVER_PORT' => '80',
        'SERVER_NAME' => 'mag-tured',
        'SERVER_PROTOCOL' => 'HTTP/1.1',
        'CONTENT_TYPE' => 'application/x-www-form-urlencoded',
        'CONTENT_LENGTH' => strlen($content)
    ),
    $content
);

命令行工具

项目还提供了一个命令行工具 fcgiget.php，用于通过网络套接字或 Unix 域套接字与 FastCGI 服务器进行通信。

通过网络套接字运行

./fcgiget.php localhost:9000/status

通过 Unix 域套接字运行

./fcgiget.php unix:/var/run/php-fpm/web.sock/status

注意： 该命令行工具主要用于调试目的。

3. 项目API使用文档

Client::__construct

public Client::__construct(string $host, int $port = -1)

• 参数：

  • $host：FastCGI 服务器的主机名或 Unix 域套接字路径。
  • $port：FastCGI 服务器的端口号，如果使用 Unix 域套接字，则设置为 -1。

• 返回值：

  • 返回一个 Client 对象，用于与 FastCGI 服务器进行通信。

Client::request

public Client::request(array $params, string $content = '')

• 参数：

  • $params：包含请求参数的数组。
  • $content：请求的内容，通常是 POST 数据。

• 返回值：

  • 返回 FastCGI 服务器的响应内容。

4. 项目安装方式

使用 Composer 安装

如前所述，使用 Composer 是安装 PHP FastCGI 客户端的推荐方式。通过 Composer 安装可以确保你获得最新的稳定版本，并且可以方便地管理依赖关系。

composer require adoy/fastcgi-client

手动安装

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

1. 从 GitHub 下载项目的源代码。
2. 将 src/Client.php 文件复制到你的项目目录中。
3. 在你的 PHP 脚本中手动引入 Client.php 文件：

require 'path/to/Client.php';

通过以上步骤，你就可以在项目中使用 PHP FastCGI 客户端了。