Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
A tool for quickly measuring the size of a PHP project.
PHP

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
PHPLOC
Tests
README.markdown
package.xml
phploc.bat
phploc.php
phpunit.xml.dist

README.markdown

phploc

phploc is a tool for quickly measuring the size of a PHP project.

The goal of phploc is not 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 understanding of a project's size.

Requirements

  • The tokenizer extension is required to count the Comment Lines of Code (CLOC) and Non-Comment Lines of Code (NCLOC) as well as the number of interfaces, classes, methods, and functions of a project.
  • The bytekit extension is an optional requirement and is used to count the Executable Lines of Code (ELOC) of a project.

Installation

phploc 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 phploc needs to be registered with the local PEAR environment:

sb@ubuntu ~ % pear channel-discover pear.phpunit.de
Adding Channel "pear.phpunit.de" succeeded
Discovery of channel "pear.phpunit.de" 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/phploc
downloading phploc-1.3.1.tgz ...
Starting to download phploc-1.3.1.tgz (8,241 bytes)
.....done: 8,241 bytes
downloading File_Iterator-1.0.0.tgz ...
Starting to download File_Iterator-1.0.0.tgz (2,353 bytes)
...done: 2,353 bytes
install ok: channel://pear.phpunit.de/File_Iterator-1.0.0
install ok: channel://pear.phpunit.de/phploc-1.3.1

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

Usage Examples

sb@ubuntu ~ % phploc --count-tests /usr/local/src/ezcomponents/trunk/Workflow
phploc 1.3.1 by Sebastian Bergmann.

Directories:                                         13
Files:                                              100

Lines of Code (LOC):                              14065
  Cyclomatic Complexity / Lines of Code:           0.08
Executable Lines of Code (ELOC):                   5249
Comment Lines of Code (CLOC):                      5213
Non-Comment Lines of Code (NCLOC):                 8852

Interfaces:                                           6
Classes:                                             79
  Abstract:                                          12 (15.19%)
  Concrete:                                          67 (84.81%)
  Lines of Code / Number of Classes:                145
Methods:                                            310
  Scope:
    Non-Static:                                     287 (92.58%)
    Static:                                          23 (7.42%)
  Visibility:
    Public:                                         237 (76.45%)
    Non-Public:                                      73 (23.55%)
  Lines of Code / Number of Methods:                 37
  Cyclomatic Complexity / Number of Methods:       2.31
Functions:                                            0

Constants:                                           10
  Global constants:                                   0
  Class constants:                                   10

Tests:
  Classes:                                           10
  Methods:                                          199
Something went wrong with that request. Please try again.