androa / phploc

A tool for quickly measuring the size of a PHP project.

phploc

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

The goal of phploc 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 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. Furthermore, a component that phploc 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/phploc
downloading phploc-1.5.0.tgz ...
Starting to download phploc-1.5.0.tgz (7,871 bytes)
.....done: 7,871 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/phploc-1.5.0

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.5.0 by Sebastian Bergmann.

Directories:                                         13
Files:                                              100

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

Namespaces:                                           0
Interfaces:                                           6
Classes:                                             79
  Abstract:                                          12 (15.19%)
  Concrete:                                          67 (84.81%)
  Lines of Code / Number of Classes:                142
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:                 36
  Cyclomatic Complexity / Number of Methods:       2.31

Anonymous Functions:                                  0
Functions:                                            0

Constants:                                           10
  Global constants:                                   0
  Class constants:                                   10

Tests:
  Classes:                                           10
  Methods:                                          199