hertel / phploc
A tool for quickly measuring the size of a PHP project
Maintainers
Fund package maintenance!
Requires
- php: >=7.3
- ext-dom: *
- ext-json: *
- phpunit/php-file-iterator: ^3.0
- sebastian/cli-parser: ^1.0
- sebastian/version: ^3.0
README
phploc is a tool for quickly measuring the size of a PHP project.
About this fork
PHPLOC was created and maintained by Sebastian Bergmann as
phploc/phploc from 2009 onwards, until he stopped maintaining it and
kept the repository for archival purposes. Every idea, every metric, and the shape of the report are his work, and this
fork stands entirely on it. Thank you, Sebastian.
This fork exists for one reason: OSS Complexity Report runs
phploc at its core, so the tool needs a maintained home. It is published as hertel/phploc and maintained by
Christopher Hertel, under the original BSD-3-Clause license with the original copyright
notice intact.
That purpose is what this fork is built around, and it is worth being explicit about what it means, because it is not the same as continuing the original project:
- It is shaped by one consumer. Decisions are made for what the OSS Complexity Report needs — measuring many open
source packages, unattended, and comparing the numbers over time. Where the original left a choice to the user, this
fork tends to pick one behaviour and keep it. The
--suffix,--exclude,--debug, and--count-testsoptions are gone for that reason, and so are the CSV and XML logs;--jsoncovers machine-readable output. - Test code is separated from production code by default. A size or complexity number that mixes a project's tests into its production code says little about either, so test classes and test methods are reported on their own.
- It measures the syntax tree, not the token stream. The original scanned tokens, which could not see enums,
anonymous classes, or arrow functions, and could not tell a property access from a method call. Everything is parsed
with
nikic/php-parsernow, which is also why some numbers differ from the ones the original reported for the same code. - The measurements are still not this project's own work. Lines of code and cyclomatic complexity come from
Sebastian Bergmann's
sebastian/lines-of-codeandsebastian/complexitylibraries. This tool decides what to count and how to group it; those libraries decide what a logical line and a decision point are. - It is not a drop-in replacement. The class names live in the
Hertel\PhpLocnamespace so that both packages can be installed side by side, the tool is a Composer dependency rather than a PHAR, and it requires PHP 8.4. SeeChangeLog.mdfor everything that changed.
If you want the original, unchanged, use phploc/phploc. If you want a phploc that is still maintained and is happy
to keep moving, use this one.
This fork is not affiliated with, supported by, or endorsed by Sebastian Bergmann. Please report issues with it here, never to the original project.
Installation
This tool is installed using Composer:
$ composer require --dev hertel/phploc $ ./vendor/bin/phploc --version
Pass --json to get the result as JSON instead of as the text report, for example to feed it into another tool:
$ ./vendor/bin/phploc --json src
Usage Example
$ ./vendor/bin/phploc src
phploc 8.0-dev by Sebastian Bergmann.
Directories 5
Files 18
Size
Lines of Code (LOC) 2,829
Comment Lines of Code (CLOC) 719 (25.42%)
Non-Comment Lines of Code (NCLOC) 2,110 (74.58%)
Logical Lines of Code (LLOC) 873 (30.86%)
Classes 873 (100.00%)
Average Class Length 51
Minimum Class Length 0
Maximum Class Length 189
Average Method Length 5
Minimum Method Length 1
Maximum Method Length 81
Average Methods Per Class 10
Minimum Methods Per Class 0
Maximum Methods Per Class 41
Functions 0 (0.00%)
Average Function Length 0
Not in classes or functions 0 (0.00%)
Cyclomatic Complexity
Average Complexity per LLOC 0.15
Average Complexity per Class 8.65
Minimum Class Complexity 1.00
Maximum Class Complexity 66.00
Average Complexity per Method 1.74
Minimum Method Complexity 1.00
Maximum Method Complexity 19.00
Average Complexity per Function 0.00
Minimum Function Complexity 0.00
Maximum Function Complexity 0.00
Dependencies
Global Accesses 0
Global Constants 0 (0.00%)
Global Variables 0 (0.00%)
Super-Global Variables 0 (0.00%)
Attribute Accesses 308
Non-Static 308 (100.00%)
Static 0 (0.00%)
Method Calls 431
Non-Static 418 (96.98%)
Static 13 (3.02%)
Structure
Namespaces 5
Interfaces 1
Traits 0
Enums 1
Classes 16
Abstract Classes 0 (0.00%)
Concrete Classes 16 (100.00%)
Final Classes 16 (100.00%)
Non-Final Classes 0 (0.00%)
Methods 176
Scope
Non-Static Methods 170 (96.59%)
Static Methods 6 (3.41%)
Visibility
Public Methods 144 (81.82%)
Protected Methods 0 (0.00%)
Private Methods 32 (18.18%)
Functions 0
Named Functions 0 (0.00%)
Anonymous Functions 0 (0.00%)
Constants 2
Global Constants 0 (0.00%)
Class Constants 2 (100.00%)
Public Constants 0 (0.00%)
Non-Public Constants 2 (100.00%)
Tests
Classes 0
Methods 0
Test classes and test methods are always reported in the Tests section of their own instead of being measured as
production code, so pointing phploc at a whole project keeps the numbers about the production code:
$ ./vendor/bin/phploc src tests
Test classes of PHPUnit, Codeception, and PhpSpec are recognised, as are Pest files, in which every file that declares
tests counts as one test class and every test() / it() call as one test method.