hpbuniat / phpcpd

Copy/Paste Detector (CPD) for PHP code.

phpcpd

phpcpd is a Copy/Paste Detector (CPD) for PHP code.

The goal of phpcpd is not to replace more sophisticated tools such as phpcs, pdepend, or phpmd, but rather to provide an alternative to them when you just need to get a quick overview of duplicated code in a project.

Requirements

• The tokenizer extension is required.

Installation

phpcpd should be installed using the PEAR Installer. This installer is the backbone of PEAR, which provides a distribution system for PHP packages, and is shipped with every release of PHP since version 4.3.0.

The PEAR channel (pear.phpunit.de) that is used to distribute phpcpd needs to be registered with the local PEAR environment. Furthermore, a component that phpcpd depends upon is hosted on the eZ Components PEAR channel (components.ez.no).

sb@ubuntu ~ % pear channel-discover pear.phpunit.de
Adding Channel "pear.phpunit.de" succeeded
Discovery of channel "pear.phpunit.de" succeeded

sb@ubuntu ~ % pear channel-discover components.ez.no
Adding Channel "components.ez.no" succeeded
Discovery of channel "components.ez.no" succeeded

This has to be done only once. Now the PEAR Installer can be used to install packages from the PHPUnit channel:

sb@ubuntu ~ % pear install phpunit/phpcpd
downloading phpcpd-1.3.0.tgz ...
Starting to download phpcpd-1.3.0.tgz (7,809 bytes)
.....done: 7,809 bytes
downloading File_Iterator-1.1.0.tgz ...
Starting to download File_Iterator-1.1.0.tgz (3,181 bytes)
...done: 3,181 bytes
downloading ConsoleTools-1.6.tgz ...
Starting to download ConsoleTools-1.6.tgz (869,925 bytes)
.........................................................
.........................................................
.........................................................
..done: 869,925 bytes
downloading Base-1.8.tgz ...
Starting to download Base-1.8.tgz (236,357 bytes)
...done: 236,357 bytes
install ok: channel://components.ez.no/Base-1.8
install ok: channel://components.ez.no/ConsoleTools-1.6
install ok: channel://pear.phpunit.de/File_Iterator-1.1.0
install ok: channel://pear.phpunit.de/phpcpd-1.3.0

After the installation you can find the phpcpd source files inside your local PEAR directory; the path is usually /usr/lib/php/PHPCPD.

Usage Example

sb@ubuntu ~ % phpcpd /usr/local/src/phpunit/trunk 
phpcpd 1.3.0 by Sebastian Bergmann.

Found 4 exact clones with 131 duplicated lines in 7 files:

  - PHPUnit/Samples/BankAccountDB/BankAccountDBTestMySQL.php:84-128
    PHPUnit/Samples/BankAccountDB/BankAccountDBTest.php:84-128

  - PHPUnit/Tests/Extensions/Database/DataSet/XmlDataSetsTest.php:71-97
    PHPUnit/Tests/Extensions/Database/DataSet/CsvDataSetTest.php:70-96

  - PHPUnit/Tests/Extensions/Database/DataSet/XmlDataSetsTest.php:71-98
    PHPUnit/Tests/Extensions/Database/DataSet/YamlDataSetTest.php:70-97

  - PHPUnit/Extensions/Database/DataSet/AbstractTable.php:156-190
    PHPUnit/Extensions/Database/DataSet/ReplacementTable.php:172-206

0.20% duplicated lines out of 64826 total lines of code.