GetOpt.PHP 技术文档

1. 安装指南

1.1 环境要求

• PHP 版本 7.1 及以上。

1.2 安装方式

使用 Composer 进行安装，运行以下命令：

composer require ulrichsg/getopt-php

2. 项目的使用说明

2.1 基本用法

GetOpt.PHP 是一个用于命令行参数处理的库。它支持短选项（如 -v）和长选项（如 --version），并且提供了多种参数处理方式。

2.2 示例代码

以下是一个简单的示例，展示如何使用 GetOpt.PHP 处理命令行参数：

require 'vendor/autoload.php';

use GetOpt\GetOpt;
use GetOpt\Option;

$getOpt = new GetOpt();

// 添加选项
$getOpt->addOptions([
    Option::create('v', 'version', GetOpt::NO_ARGUMENT)
        ->setDescription('显示版本信息'),
    Option::create('h', 'help', GetOpt::NO_ARGUMENT)
        ->setDescription('显示帮助信息'),
    Option::create('o', 'output', GetOpt::REQUIRED_ARGUMENT)
        ->setDescription('指定输出文件')
]);

// 解析命令行参数
try {
    $getOpt->process();
} catch (Exception $e) {
    echo $e->getMessage();
    exit;
}

// 获取选项值
$version = $getOpt->getOption('v');
$help = $getOpt->getOption('h');
$output = $getOpt->getOption('o');

// 处理逻辑
if ($version) {
    echo "版本信息\n";
}

if ($help) {
    echo $getOpt->getHelpText();
    exit;
}

if ($output) {
    echo "输出文件: $output\n";
}

3. 项目API使用文档

3.1 GetOpt 类

• __construct(array $options = [], array $settings = []): 构造函数，初始化 GetOpt 实例。
• addOptions(array $options): 添加选项。
• process(): 解析命令行参数。
• getOption(string $name): 获取指定选项的值。
• getHelpText(): 生成帮助文本。

3.2 Option 类

• create(string $short, string $long, int $mode): 创建一个选项。
• setDescription(string $description): 设置选项的描述。

4. 项目安装方式

4.1 使用 Composer 安装

运行以下命令进行安装：

composer require ulrichsg/getopt-php

4.2 手动安装

1. 下载项目源码。
2. 将源码放置在项目目录中。
3. 在项目中引入 autoload.php 文件：

require 'path/to/getopt-php/vendor/autoload.php';

通过以上步骤，您可以成功安装并使用 GetOpt.PHP 库来处理命令行参数。