PHP Copy/Paste Detector

https://github.com/systemsdk/phpcpd
Admin
PHP Copy/Paste Detector (PHPCPD) is a tool for detecting duplicated and similar PHP code to improve...
Tokens:5,101
Snippets:58
Trust Score:7.8
License:BSD-3-Clause
Update:3 months ago
Show doc for...
Tokens:
Raw
### Initialize development environment

Source: https://github.com/systemsdk/phpcpd/blob/master/readme.md

Build, start, and perform initial setup for the development containers.

```bash
make build-dev
make start
make setup
```

--------------------------------

### CI/CD Integration - GitHub Actions Example

Source: https://context7.com/systemsdk/phpcpd/llms.txt

This GitHub Actions workflow configures a CI job to run PHPCPD, install dependencies, and upload the generated report as an artifact. It uses `always()` to ensure the report is uploaded regardless of the PHPCPD step's success.

```yaml
name: Code Quality

on: [push, pull_request]

jobs:
  phpcpd:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Setup PHP
        uses: shivammathur/setup-php@v2
        with:
          php-version: '8.4'

      - name: Install dependencies
        run: composer install --no-progress

      - name: Run PHPCPD
        run: |
          php ./vendor/bin/phpcpd \
            --fuzzy \
            --min-lines 5 \
            --exclude vendor \
            --log-pmd reports/phpcpd.xml \
            src

      - name: Upload PHPCPD Report
        uses: actions/upload-artifact@v4
        if: always()
        with:
          name: phpcpd-report
          path: reports/phpcpd.xml
```

--------------------------------

### Manage environment lifecycle

Source: https://github.com/systemsdk/phpcpd/blob/master/readme.md

Start or stop the development environment containers.

```bash
make start
make stop
```

--------------------------------

### Run phpcpd with Manual Installation

Source: https://github.com/systemsdk/phpcpd/blob/master/readme.md

If you installed phpcpd manually as a PHAR archive, use this command to run the analysis.

```bash
php phpcpd.phar --fuzzy --verbose src tests
```

--------------------------------

### CI/CD Integration - Bash Script Example

Source: https://context7.com/systemsdk/phpcpd/llms.txt

This bash script demonstrates running PHPCPD with specific configurations for a CI/CD pipeline. It uses exit codes to indicate success or failure based on detected duplications.

```bash
#!/bin/bash
set -e

# Run PHPCPD with strict settings
php ./vendor/bin/phpcpd \
  --fuzzy \
  --min-lines 5 \
  --min-tokens 70 \
  --exclude vendor \
  --exclude var \
  --log-pmd build/reports/phpcpd.xml \
  src

# Exit code 0 = no duplications (build passes)
# Exit code 1 = duplications found (build fails)
echo "Code duplication check passed!"
```

--------------------------------

### XML report format example

Source: https://github.com/systemsdk/phpcpd/blob/master/docs/report.md

Shows the structure of the PMD-CPD XML output generated by phpcpd.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<pmd-cpd xmlns="https://systemsdk.github.io/phpcpd/report" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" phpcpdVersion="8.2.4" timestamp="2025-11-07T21:42:17+00:00" version="1.0.0" xsi:schemaLocation="https://systemsdk.github.io/phpcpd/report https://systemsdk.github.io/phpcpd/report/phpcpd-report-v1_0_0.xsd">
  <duplication lines="59" tokens="136">
    <file line="116" endline="175" path="/var/www/html/tests/Fixture/Math.php"/>
    <file line="217" endline="276" path="/var/www/html/tests/Fixture/Math.php"/>
    <codefragment><![CDATA[    public function div($v1, $v2)
    {
        $v3 = $v1 / ($v2 + $v1);
        if ($v3 > 14)
        {
            $v4 = 0;
            for ($i = 0; $i < $v3; $i++)
            {
                $v4 += ($v2 * $i);
            }
        }
        $v5 = ($v4 < $v3 ? ($v3 - $v4) : ($v4 - $v3));

        $v6 = ($v1 * $v2 * $v3 * $v4 * $v5);

        $d = array($v1, $v2, $v3, $v4, $v5, $v6);

        $v7 = 1;
        for ($i = 0; $i < $v6; $i++)
        {
            shuffle( $d );
            $v7 = $v7 + $i * end($d);
        }

        $v8 = $v7;
        foreach ( $d as $x )
        {
            $v8 *= $x;
        }

        $v3 = $v1 / ($v2 + $v1);
        if ($v3 > 14)
        {
            $v4 = 0;
            for ($i = 0; $i < $v3; $i++)
            {
                $v4 += ($v2 * $i);
            }
        }
        $v5 = ($v4 < $v3 ? ($v3 - $v4) : ($v4 - $v3));

        $v6 = ($v1 * $v2 * $v3 * $v4 * $v5);

        $d = array($v1, $v2, $v3, $v4, $v5, $v6);

        $v7 = 1;
        for ($i = 0; $i < $v6; $i++)
        {
            shuffle( $d );
            $v7 = $v7 + $i * end($d);
        }

        $v8 = $v7;
        foreach ( $d as $x )
        {
            $v8 *= $x;
        }

        return $v8;
]]></codefragment>
  </duplication>
</pmd-cpd>
```

--------------------------------

### Install phpcpd using Composer

Source: https://github.com/systemsdk/phpcpd/blob/master/readme.md

Use this command to install phpcpd as a development dependency in your PHP project.

```bash
composer require systemsdk/phpcpd --dev
```

--------------------------------

### Verify PHPCPD Installation

Source: https://context7.com/systemsdk/phpcpd/llms.txt

Checks if PHPCPD has been installed correctly by displaying its version number. This is a quick way to confirm the installation and check the active version.

```bash
# Verify installation
php ./vendor/bin/phpcpd --version
# Output: Copy/Paste Detector 9.0.0
```

--------------------------------

### Install PHPCPD via Composer

Source: https://context7.com/systemsdk/phpcpd/llms.txt

Installs PHPCPD as a development dependency using Composer. This command adds the package to your project and makes its binaries available.

```bash
# Install via Composer
composer require systemsdk/phpcpd --dev
```

--------------------------------

### Available Makefile commands

Source: https://github.com/systemsdk/phpcpd/blob/master/readme.md

A comprehensive list of available commands for project maintenance, testing, and reporting.

```bash
make build-dev

make start

make stop

make down

make restart

make ssh
make ssh-root

make setup

make update

make composer-audit

make info
make help

make phar
make signed-phar

make phpunit
make phpcs
make ecs
make ecs-fix
make phpstan

make phpcpd-run
make phpcpd-html-report

make logs

etc....
```

--------------------------------

### Selecting Detection Algorithms

Source: https://context7.com/systemsdk/phpcpd/llms.txt

Choose between Rabin-Karp and Suffix Tree algorithms, with optional edit distance settings for approximate matching.

```bash
# Use default Rabin-Karp algorithm
php ./vendor/bin/phpcpd --algorithm rabin-karp src

# Use Suffix Tree algorithm for approximate matching
php ./vendor/bin/phpcpd --algorithm suffix-tree src

# Suffix Tree with edit distance for near-duplicates
php ./vendor/bin/phpcpd \
  --algorithm suffix-tree \
  --edit-distance 5 \
  --head-equality 10 \
  --verbose \
  src
```

--------------------------------

### Basic CLI Usage for PHPCPD

Source: https://context7.com/systemsdk/phpcpd/llms.txt

Execute basic scans on directories using the vendor binary or PHAR archive.

```bash
# Basic scan of src directory
php ./vendor/bin/phpcpd src

# Scan multiple directories with verbose output
php ./vendor/bin/phpcpd --verbose src tests

# Using PHAR archive directly
php phpcpd.phar src
```

--------------------------------

### Configuring Thresholds and Filters

Source: https://context7.com/systemsdk/phpcpd/llms.txt

Adjust detection sensitivity and exclude specific directories or file types from the analysis.

```bash
# Set minimum 10 identical lines and 100 tokens to report
php ./vendor/bin/phpcpd --min-lines 10 --min-tokens 100 src

# Include only specific file suffixes
php ./vendor/bin/phpcpd --suffix .php --suffix .inc src

# Exclude vendor and test directories
php ./vendor/bin/phpcpd --exclude vendor --exclude tests src

# Combined configuration for production use
php ./vendor/bin/phpcpd \
  --fuzzy \
  --min-lines 5 \
  --min-tokens 70 \
  --exclude vendor \
  --exclude migrations \
  --verbose \
  src
```

--------------------------------

### Programmatic Code Detection with Detector API

Source: https://context7.com/systemsdk/phpcpd/llms.txt

Demonstrates direct usage of the PHPCPD Detector API to analyze files, configure detection strategies, and process results. Requires importing necessary classes and setting up arguments for analysis.

```php
<?php

declare(strict_types=1);

use SebastianBergmann\FileIterator\Facade;
use Systemsdk\PhpCPD\Cli\Arguments;
use Systemsdk\PhpCPD\Detector\Detector;
use Systemsdk\PhpCPD\Detector\Strategy\DefaultStrategy;
use Systemsdk\PhpCPD\Detector\Strategy\StrategyConfiguration;
use Systemsdk\PhpCPD\Detector\Strategy\SuffixTreeStrategy;
use Systemsdk\PhpCPD\Detector\SuppressionGuard;
use Systemsdk\PhpCPD\Log\PMD;
use Systemsdk\PhpCPD\Log\Text;

// Create arguments with desired configuration
$arguments = new Arguments(
    directories: ['src', 'tests'],
    suffixes: ['.php'],
    exclude: ['vendor'],
    pmdCpdXmlLogfile: 'reports/phpcpd.xml',
    linesThreshold: 5,      // Minimum identical lines
    tokensThreshold: 70,    // Minimum identical tokens
    fuzzy: true,            // Normalize variable names
    verbose: true,
    help: false,
    version: false,
    algorithm: 'rabin-karp',
    editDistance: 0,
    headEquality: 10,
    ignoreNoFiles: false
);

// Get list of PHP files to analyze
$files = (new Facade())->getFilesAsArray(
    $arguments->directories(),
    $arguments->suffixes(),
    '',
    $arguments->exclude()
);

// Configure detection strategy
$config = new StrategyConfiguration($arguments);
$guard = new SuppressionGuard();

// Choose algorithm: DefaultStrategy (Rabin-Karp) or SuffixTreeStrategy
$strategy = new DefaultStrategy($config, $guard);
// $strategy = new SuffixTreeStrategy($config, $guard);

// Run detection with progress bar
$detector = new Detector($strategy, useProgressBar: true);
$clones = $detector->copyPasteDetection($files);

// Output results to console
$textLogger = new Text();
$textLogger->printResult($clones, verbose: true);

// Generate XML report
if ($arguments->pmdCpdXmlLogfile()) {
    $pmdLogger = new PMD($arguments->pmdCpdXmlLogfile());
    $pmdLogger->processClones($clones);
}

// Access clone details programmatically
printf("Found %d code clones\n", count($clones));
printf("Duplicated lines: %d\n", $clones->numberOfDuplicatedLines());
printf("Duplication percentage: %s\n", $clones->percentage());
printf("Files with clones: %d\n", $clones->numberOfFilesWithClones());

foreach ($clones as $clone) {
    printf("\nClone (%d lines, %d tokens):\n", $clone->numberOfLines(), $clone->numberOfTokens());
    foreach ($clone->files() as $file) {
        printf("  - %s:%d-%d\n", $file->name(), $file->startLine(), $file->endLine());
    }
}

```

--------------------------------

### Run phpcpd with Composer

Source: https://github.com/systemsdk/phpcpd/blob/master/readme.md

Execute phpcpd from your project's vendor directory to analyze source and test files. The --fuzzy and --verbose flags are used for detailed output.

```bash
$ php ./vendor/bin/phpcpd --fuzzy --verbose src tests
```

--------------------------------

### Generating PMD-CPD XML Reports

Source: https://context7.com/systemsdk/phpcpd/llms.txt

Output analysis results in XML format for use with external dashboards or CI/CD pipelines.

```bash
# Generate PMD-CPD XML report
php ./vendor/bin/phpcpd --log-pmd reports/phpcpd-report.xml src

# Full analysis with XML output
php ./vendor/bin/phpcpd \
  --fuzzy \
  --verbose \
  --log-pmd reports/phpcpd/phpcpd-report-v1.xml \
  src tests
```

--------------------------------

### Tear down environment

Source: https://github.com/systemsdk/phpcpd/blob/master/readme.md

Stop and remove all environment containers and networks.

```bash
make down
```

--------------------------------

### phpcpd Command-Line Options

Source: https://github.com/systemsdk/phpcpd/blob/master/readme.md

This section lists available command-line options for customizing phpcpd's file selection, analysis, and report generation.

```bash
--suffix <suffix>   Include files with names ending on <suffix> (default: .php; can be given multiple times)
--exclude <path>    Exclude files with <path> in their path (can be given multiple times)

--algorithm <name>  Select which algorithm to use ('rabin-karp' (default) or 'suffix-tree')
--fuzzy             Fuzz variable names
--min-lines <N>     Minimum number of identical lines (default: 5)
--min-tokens <N>    Minimum number of identical tokens (default: 70)
--edit-distance <N> Distance in number of edits between two clones (only for suffix-tree; default: 0)
--head-equality <N> Minimum equality at start of clone (only for suffix-tree; default 10)
--verbose           Print results details
--ignore-no-files   To return a success exit code if no files were found

--log-pmd <file>    Write log in PMD-CPD XML format to <file>

--version           Display version
--help              Display help
```

--------------------------------

### Fuzzy Matching and Variable Normalization

Source: https://context7.com/systemsdk/phpcpd/llms.txt

Enable fuzzy matching to detect clones that differ only by variable names, optionally combined with custom thresholds.

```bash
# Enable fuzzy matching to detect clones with different variable names
php ./vendor/bin/phpcpd --fuzzy --verbose src

# Combine with custom thresholds
php ./vendor/bin/phpcpd --fuzzy --min-lines 10 --min-tokens 100 src
```

--------------------------------

### Configure Linux Docker permissions

Source: https://github.com/systemsdk/phpcpd/blob/master/readme.md

Grant the current user access to the Docker daemon on Linux systems.

```bash
sudo usermod -aG docker $USER
```

--------------------------------

### Generate XML report with phpcpd

Source: https://github.com/systemsdk/phpcpd/blob/master/docs/report.md

Executes the phpcpd tool to analyze source code and output a PMD-compatible XML report.

```bash
php ./vendor/bin/phpcpd --fuzzy --verbose --log-pmd=reports/phpcpd/phpcpd-report-v1.xml src
```

--------------------------------

### Run PHPCPD via Composer Scripts

Source: https://context7.com/systemsdk/phpcpd/llms.txt

Executes PHPCPD using predefined scripts in composer.json. These scripts allow for quick execution of common tasks like running the detector or generating reports.

```bash
# Run using Composer scripts
composer phpcpd
composer phpcpd:report
composer quality
```

--------------------------------

### Configure Composer Scripts for PHPCPD

Source: https://context7.com/systemsdk/phpcpd/llms.txt

Adds convenient scripts to the composer.json file for running PHPCPD with specific configurations and for organizing quality checks.

```json
{
    "require-dev": {
        "systemsdk/phpcpd": "^9.0"
    },
    "scripts": {
        "phpcpd": "phpcpd --fuzzy --verbose src tests",
        "phpcpd:report": "phpcpd --fuzzy --log-pmd=reports/phpcpd.xml src tests",
        "quality": [
            "@phpcpd",
            "@phpstan",
            "@phpcs"
        ]
    }
}
```

--------------------------------

### Transform XML to HTML with Xalan

Source: https://github.com/systemsdk/phpcpd/blob/master/docs/report.md

Uses the Xalan tool to apply an XSLT stylesheet to the generated XML report for HTML output.

```bash
xalan -in reports/phpcpd/phpcpd-report-v1.xml -xsl https://systemsdk.github.io/phpcpd/report/phpcpd-html-v1_0_0.xslt -out reports/phpcpd/phpcpd-report-v1.html
```

--------------------------------

### Generate and Transform PHPCPD XML Report

Source: https://context7.com/systemsdk/phpcpd/llms.txt

First, generate an XML report using the PHPCPD CLI. Then, transform the XML report to HTML using Xalan for an interactive view.

```bash
php ./vendor/bin/phpcpd --fuzzy --verbose --log-pmd=reports/phpcpd/phpcpd-report-v1.xml src
```

```bash
xalan -in reports/phpcpd/phpcpd-report-v1.xml \
      -xsl https://systemsdk.github.io/phpcpd/report/phpcpd-html-v1_0_0.xslt \
      -out reports/phpcpd/phpcpd-report-v1.html
```

```bash
open reports/phpcpd/phpcpd-report-v1.html
```

--------------------------------

### Access container shell

Source: https://github.com/systemsdk/phpcpd/blob/master/readme.md

Open a shell session inside the PHP container.

```bash
make ssh
```

--------------------------------

### Rebuild development container

Source: https://github.com/systemsdk/phpcpd/blob/master/readme.md

Rebuild the environment after modifying the Dockerfile or configuration.

```bash
make down
make build-dev
make start
```

--------------------------------

### Suppress CPD analysis with Attributes

Source: https://github.com/systemsdk/phpcpd/blob/master/readme.md

Use the `#[SuppressCpd]` attribute to ignore specific classes or functions from Copy/Paste Detector analysis. This is useful for generated code or intentional duplication.

```php
use Systemsdk\PhpCPD\Attributes\SuppressCpd;

#[SuppressCpd]
class LegacyDataFixtures
{
    // All methods and properties inside this class will be ignored
    // ...
}

#[SuppressCpd]
function globalHelperFunction() {
    // ...
}
```

--------------------------------

### Suppressing Code Clone Detection

Source: https://github.com/systemsdk/phpcpd/blob/master/ChangeLog.md

Use the SuppressCpd attribute to ignore specific classes or methods during analysis.

```php
use Systemsdk\PhpCPD\Attributes\SuppressCpd;
```
Tokens:
Raw