PHP-CLI 项目教程

PHP-CLI 项目教程

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

php-cli/
├── bin/
│   └── php-cli
├── src/
│   ├── CLI.php
│   ├── Colors.php
│   ├── Options.php
│   └── SplittbrainException.php
├── tests/
│   ├── CLI.test.php
│   ├── Colors.test.php
│   ├── Options.test.php
│   └── SplittbrainException.test.php
├── vendor/
│   └── (Composer 依赖包)
├── .gitignore
├── composer.json
├── composer.lock
├── LICENSE
├── README.md
└── phpunit.xml

• bin/: 包含可执行文件。
• src/: 包含项目的核心源代码。
  • CLI.php: 主类文件，用于创建命令行应用。
  • Colors.php: 用于处理命令行颜色输出。
  • Options.php: 用于解析命令行选项和参数。
  • SplittbrainException.php: 自定义异常类。
• tests/: 包含单元测试文件。
• vendor/: Composer 依赖包。
• .gitignore: Git 忽略文件配置。
• composer.json: Composer 配置文件。
• composer.lock: Composer 锁定文件。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• phpunit.xml: PHPUnit 配置文件。

2. 项目的启动文件介绍

项目的启动文件位于 bin/ 目录下，名为 php-cli。这个文件是一个可执行的 PHP 脚本，用于启动命令行应用。

#!/usr/bin/env php
<?php

require __DIR__ . '/../vendor/autoload.php';

use splitbrain\phpcli\CLI;
use splitbrain\phpcli\Options;

class MyCLI extends CLI
{
    protected function setup(Options $options)
    {
        $options->setHelp('A simple PHP CLI application.');
        $options->registerOption('version', 'print version', 'v');
    }

    protected function main(Options $options)
    {
        if ($options->getOpt('version')) {
            $this->info('1.0.0');
        } else {
            echo $options->help();
        }
    }
}

$cli = new MyCLI();
$cli->run();

3. 项目的配置文件介绍

项目的配置文件主要是 composer.json，它包含了项目的依赖、脚本和其他配置信息。

{
    "name": "splitbrain/php-cli",
    "description": "A simple PHP CLI application framework",
    "type": "library",
    "license": "MIT",
    "authors": [
        {
            "name": "Andreas Gohr",
            "email": "andi@splitbrain.org"
        }
    ],
    "require": {
        "php": ">=5.6"
    },
    "autoload": {
        "psr-4": {
            "splitbrain\\phpcli\\": "src/"
        }
    },
    "bin": ["bin/php-cli"]
}

• name: 项目名称。
• description: 项目描述。
• type: 项目类型。
• license: 项目许可证。
• authors: 项目作者信息。
• require: 项目依赖。
• autoload: 自动加载配置。
• bin: 可执行文件路径。

通过这些配置，可以管理项目的依赖和自动加载，确保项目能够正确运行。