PHP项目骨架技术文档

本文档将详细介绍如何安装、使用以及通过API操作一个标准的PHP项目骨架，帮助开发者快速搭建现代、整洁且面向测试的PHP项目。

1. 安装指南

首先，确保您的环境中已经安装了composer。如果没有，请访问composer官网进行安装。

安装完成后，使用以下命令创建您的项目：

composer create-project koriym/php-skeleton <项目路径>

替换<项目路径>为您希望存放项目的目录。

执行命令后，您将被询问一些问题以配置项目：

• 您的供应商名称（默认为"MyVendor"）。
• 包名称（默认为"MyPackage"）。
• 您的名字（默认为"Akihito Koriyama"）。
• 您的电子邮件地址（默认为"[e-mail]"）。

根据提示输入相应的信息，即可完成项目的初始化。

2. 项目的使用说明

2.1 常用命令

项目安装完成后，以下命令可用于项目开发：

• composer test: 运行PHPUnit测试框架。
• composer tests: 运行代码风格检查（cs）、代码分析（sa）和测试（test）。
• composer coverage: 生成测试覆盖率报告。使用XDebug、phpdbg或pcov。
• composer cs: 检查代码风格。
• composer cs-fix: 自动修复PHP代码风格问题。
• composer sa: 运行静态代码分析工具（phpstan和psalm）。
• composer metrics: 报告代码度量。
• composer build: 构建所有报告。

2.2 配置文件

项目包含一些常用持续集成工具的配置文件，如.travis.yml、.gitlab-ci.yml等。

3. 项目API使用文档

本项目使用的API主要是composer命令，具体命令和用途已在“项目的使用说明”部分详细说明。开发者可以根据项目需求和开发进度，选择合适的命令进行操作。

4. 项目安装方式

请参考“安装指南”部分，使用composer create-project命令进行安装。这是官方推荐的安装方式，可以确保项目依赖的正确安装和配置。

通过以上文档，开发者可以快速上手并使用本项目骨架，搭建自己的PHP项目。