PHPXref

PHPXref - The PHP Cross Referencing Documentation Utility analyzing the following items of PHP scripts:

• Variable references
• Function references
• Class references
• Constant references

Using PHPXref on MS Windows

requirement

1. Download PHPXref for MS Windows Win / macOS / Linux
2. install the perl if perl was not installed
   • Win Download IndigoPerl, a binary distribution of Perl for Windows or xampp built-in perl (not TinyPerl 2.0 because they lack of some required perl modules .pm )
   • Verify the perl was installed: perl -v

installation

1. (optional) Install the "IndigoPerl" to the default directory: c:\usr\ (perl.exe will be located to c:\usr\bin\perl.exe )
2. Extract "PHPXref" to c:\PHPXref (or other directory you preferred)
3. Set the source php scripts where you want to analysis
   • Modify the configuration file phpxref.cfg where the source php scripts located OR copy the php_scripts you want to analyze to c:\PHPXref\source\php_scripts\

SOURCE=c:\PHPXref\source\php_scripts\

# Character set to specify for generated HTML
# CHARSET=iso-8859-1
CHARSET=utf-8

generation the cross reference report

1. Execute the following command and wait some minutes...
   • Win : c:\PHPXref\phpxref.exe
   • macOS /Linux : perl phpxref.pl
2. Example of summary statistics

	Files Scanned: 1284 containing 669767 lines
	7640 variable names in 24339 definitions and 238971 references.
	5102 function/method names in 7711 definitions and 44215 references.
	288 constant names in 317 definitions and 6332 references.
	688 class names in 696 definitions and 5925 references.
	0 table names in 0 references.

Browse the generated report: file://c:/PHPXref/output/index.html

version:

• Win PHPXref 0.7 + IndigoPerl V9.02 / Perl 5.10.0
• Win PHPXref 0.7 + XAMPP 1.7.2 / v5.10.0 built for MSWin32-x86-multi-thread
• macOS PHPXref 0.7.1 + perl 5, version 18, subversion 2 (v5.18.2) built for darwin-thread-multi-2level