PHP 代码复制/粘贴检测器 (PHPCPD) 技术文档

1. 安装指南

1.1 使用 PHP Archive (PHAR) 安装

phpcpd 工具以 PHP Archive (PHAR) 的形式分发。您可以通过以下步骤进行安装：

$ wget https://phar.phpunit.de/phpcpd.phar
$ php phpcpd.phar --version

1.2 使用 Phive 安装

推荐使用 Phive 来管理项目的工具依赖：

$ phive install phpcpd
$ ./tools/phpcpd --version

1.3 不推荐使用 Composer 安装

根据项目维护者的建议，不推荐使用 Composer 来下载和安装此工具。

2. 项目使用说明

2.1 基本用法

phpcpd 是一个用于检测 PHP 代码中复制/粘贴的工具。您可以通过以下命令来运行它：

$ php phpcpd.phar --fuzzy wordpress-5.5

2.2 输出示例

运行上述命令后，phpcpd 将输出检测到的代码克隆信息，包括克隆的文件路径、行数、重复的代码行数等。

phpcpd 6.0.0 by Sebastian Bergmann.

Found 121 clones with 8137 duplicated lines in 69 files:

  - /home/sb/wordpress-5.5/wp-includes/sodium_compat/src/Core/Curve25519/H.php:19-1466 (1447 lines)
    /home/sb/wordpress-5.5/wp-includes/sodium_compat/src/Core32/Curve25519/H.php:19-1466
.
.
.
  - /home/sb/wordpress-5.5/wp-includes/sodium_compat/src/Core32/Curve25519.php:879-889 (10 lines)
    /home/sb/wordpress-5.5/wp-includes/sodium_compat/src/Core32/Curve25519.php:1072-1082

1.82% duplicated lines out of 446676 total lines of code.
Average size of duplication is 67 lines, largest clone has 1447 of lines

Time: 00:02.980, Memory: 318.00 MB

3. 项目 API 使用文档

phpcpd 主要通过命令行接口 (CLI) 进行操作，没有提供额外的 API 接口。您可以通过命令行参数来控制其行为。

3.1 常用命令行参数

• --fuzzy：启用模糊匹配模式。
• --version：显示当前版本信息。
• --help：显示帮助信息。

4. 项目安装方式

4.1 使用 PHAR 文件安装

通过下载 PHAR 文件并直接运行：

$ wget https://phar.phpunit.de/phpcpd.phar
$ php phpcpd.phar --version

4.2 使用 Phive 安装

通过 Phive 安装并管理依赖：

$ phive install phpcpd
$ ./tools/phpcpd --version

4.3 不推荐使用 Composer 安装

根据项目维护者的建议，不推荐使用 Composer 来安装此工具。