README

FlorianWolters\Component\Util\Command 是一个易于使用的 PHP 组件，它提供了 Command 行为设计模式。

目录 (ToC)

介绍
特性
要求
用法
安装
- 本地安装
- 系统级安装
作为组件的依赖
- Composer
- PEAR
开发环境
贡献
致谢
许可证

介绍

命令是一个行为设计模式，定义为如下：

"封装一个请求为一个对象，从而让你可以用不同的请求参数化客户端，排队或记录请求，并支持可撤销的操作。"

-- E. Gamma, et al. 设计模式：可重用面向对象软件元素。Westford: Addison-Wesley, 1995。

特性

遵循 Command 设计模式的命名约定
- 命令提供了一个成员方法 execute()。
- 可以使用 MacroCommand 执行一系列命令，它实现了复合结构设计模式。
使用静态和动态测试程序测试了工件
- 使用 PHPUnit 实现了动态组件测试（单元测试）。
- 使用以下工具执行静态代码分析
  - PHP_CodeSniffer: 风格检查器
  - PHP Mess Detector (PHPMD): 代码分析器
  - phpcpd: 复制/粘贴检测器 (CPD)
  - phpdcd: 死代码检测器 (DCD)
可通过 Composer 或 PEAR 安装程序安装。
- 提供了一个 Packagist 包，可以使用依赖管理器 Composer 安装。
  - 点击此处查看Packagist上的包。
- 提供了一个 PEAR 包，可以使用包管理器 PEAR 安装程序安装。
  - 点击此处查看Pear通道。
提供了一个使用文档生成器 phpDocumentor 生成的完整的应用程序编程接口 (API) 文档。
- 点击此处查看当前的API文档。
遵循 PSR-0 要求以实现自动加载器互操作性。
遵循PSR-1基本编码风格指南。
遵循PSR-2编码风格指南。
遵循PSR-5 PHPDoc标准。
遵循语义化版本控制（SemVer）规范 2.0.0-rc.1。

要求

PHP >= 5.3

用法

FlorianWolters\Component\Util\Command的最佳文档是其单元测试，这些测试包含在软件包中。您可以在您的PEAR存储库中找到它们，在Linux系统中通常是/usr/share/php/test。

安装

本地安装

FlorianWolters\Component\Util\Command应该使用依赖管理器Composer进行安装。您可以使用PHP安装Composer。

php -r "eval('?>'.file_get_contents('https://getcomposer.org.cn/installer'));"

这将检查几个PHP设置，然后将composer.phar下载到您的当前工作目录。此文件是Composer的二进制文件。它是一个PHAR（PHP存档），它是一种可以在命令行上运行的PHP存档格式，可用于许多其他用途。

接下来，运行install命令以解析和下载依赖项

php composer.phar install

系统级安装

FlorianWolters\Component\Util\Command应该使用PEAR安装程序进行安装。此安装程序是PHP社区用于安装PHP组件的事实标准。

pear channel-discover pear.florianwolters.de
pear install --alldeps fw/Command

作为组件的依赖

Composer

如果您正在创建依赖于FlorianWolters\Component\Util\Command的组件，请确保将FlorianWolters\Component\Util\Command添加到您的组件的composer.json文件中

{
    "require": {
        "florianwolters/component-util-command": "0.1.*"
    }
}

PEAR

如果您正在创建依赖于FlorianWolters\Component\Util\Command的组件，请确保将FlorianWolters\Component\Util\Command添加到您的组件的package.xml文件中

<dependencies>
  <required>
    <package>
      <name>Command</name>
      <channel>pear.florianwolters.de</channel>
      <min>0.1.0</min>
      <max>0.1.99</max>
    </package>
  </required>
</dependencies>

开发环境

如果您想要修补或增强此组件，您需要创建一个合适的发展环境。最简单的方法是安装phix4componentdev

# phix4componentdev
pear channel-discover pear.phix-project.org
pear install phix/phix4componentdev

然后，克隆Git存储库

# PHP-Component-Util-Command
git clone http://github.com/FlorianWolters/PHP-Component-Util-Command

然后，安装此组件依赖项的本地副本以完成开发环境

# build vendor/ folder
phing build-vendor

为了使您的生活更轻松，一些常见的任务（如运行单元测试、生成代码审查分析以及创建PEAR包）已使用phing自动完成。您将在组件随附的build.xml文件中找到这些自动化步骤。

在组件的顶层文件夹中运行phing命令以查看可用的自动化任务列表。

贡献

请参阅CONTRIBUTING.md。

致谢

许可证

本程序是免费软件：您可以按照自由软件基金会发布的GNU Lesser General Public License的条款重新分发和/或修改它，无论是许可证的第3版，还是（根据您的选择）任何较新版本的许可证。

本程序按照希望对您有用进行分发，但没有任何保证；甚至没有关于适销性或特定用途的暗示性保证。有关详细信息，请参阅GNU Lesser General Public License。

您应该已经收到与该程序一起的GNU通用公共许可证（ Lesser General Public License）副本。如果没有收到，请参阅http://gnu.org/licenses/lgpl.txt。

florianwolters / component-util-command

维护者

详细信息