Download the PHP package voku/phpdoctor without Composer

🏥 PHPDoctor

PHPDoctor: type and PHPDoc quality profiling for PHP projects.

If you already use PHPStan for your type checks but sometimes someone in the team still commit non typed code, then PHPDoctor is for you.

PHPDoctor keeps its original PHPDoc doctor identity as the first diagnostic stage and grows from there. It checks missing native types, missing or wrong PHPDoc types, deprecated documentation gaps, parse errors, and other type-documentation regressions without trying to replace PHPStan, Psalm, or a generic architecture review.

Install via "phar" (recommended)

All releases: https://github.com/voku/PHPDoctor/releases

Install via "composer require"

Quick Start

Staged profiling

PHPDoctor is evolving in focused stages:

1. keep the existing PHPDoc and native type diagnostics as the seed;
2. add structured profiling around the current findings;
3. support JSON baselines so CI can fail only on newly introduced findings;
4. provide project-level summaries for actionable type documentation coverage;
5. expose machine-readable JSON for CI dashboards.

This stays intentionally narrow: PHPDoctor profiles type documentation quality and controlled regressions, not generic code quality scores.

Show a profile summary:

Generate a baseline:

Use the baseline in CI so only new findings fail:

Emit JSON for dashboards:

Emit GitHub Actions workflow annotations:

Use GitHub Actions annotations with a minimal workflow step:

Use baseline-aware GitHub Actions annotations so only new findings are annotated:

Exit codes:

• 0: no findings, or no new findings when --baseline-file is active
• 1: findings found, or new findings found when --baseline-file is active
• 2: CLI, configuration, or baseline errors

Demo

Parse a string:

Ignore errors

You can use in @param or @return phpdocs to ignore the errors directly in your code.

Building the PHAR file

The PHAR is built automatically via GitHub Actions whenever a new version tag (*.*.*) is pushed. The resulting phpdoctor.phar is attached to the corresponding GitHub Release and can be downloaded directly:

To build locally, install humbug/box and run:

Support

For support and donations please visit Github | Issues | PayPal | Patreon.

For status updates and release announcements please visit Releases | Twitter | Patreon.

For professional support please contact me.

Thanks

• Thanks to GitHub (Microsoft) for hosting the code and a good infrastructure including Issues-Management, etc.
• Thanks to IntelliJ as they make the best IDEs for PHP and they gave me an open source license for PhpStorm!
• Thanks to GitHub Actions for the awesome CI/CD platform!
• Thanks to StyleCI for the simple but powerful code style check.
• Thanks to PHPStan && Psalm for really great Static analysis tools and for discover bugs in the code!