PHPXref: Difference between revisions

From LemonWiki共筆
Jump to navigation Jump to search
No edit summary
 
(17 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[http://phpxref.sourceforge.net/ PHPXref - The PHP Cross Referencing Documentation Utility] ([http://xref.moodle.org/nav.html?index.html demo])
[http://phpxref.sourceforge.net/ PHPXref - The PHP Cross Referencing Documentation Utility] analyzing the following items of PHP scripts:
 
* Variable references
Using PHPXref on MS Windows
* Function references
* Class references
* Constant references


== requirement ==
== requirement ==
# [http://phpxref.sourceforge.net/#download Download] PHPXref for MS Windows
# [http://phpxref.sourceforge.net/#download Download] PHPXref for MS Windows {{Win}} / {{Mac}} / {{Linux}}
# Download [http://www.indigostar.com/indigoperl.htm IndigoPerl], a binary distribution of Perl for Windows (not use the [http://www.apachefriends.org/en/xampp.html xampp] built-in perl or [http://tinyperl.sourceforge.net/ TinyPerl] 2.0 because they lack of some required perl modules .pm )
# install the perl if perl was not installed
#* {{Win}} Download [http://www.indigostar.com/indigoperl.htm IndigoPerl], a binary distribution of Perl for Windows or [http://www.apachefriends.org/en/xampp.html xampp] built-in perl (not [http://tinyperl.sourceforge.net/ TinyPerl] 2.0 because they lack of some required perl modules .pm )
#* Verify the perl was installed: {{kbd | key = perl -v}}


== installation ==
== installation ==
# Install the "IndigoPerl" to the default directory: c:\perl-5.10.0\  (perl.exe will be located to c:\perl-5.10.0\bin\perl.exe)
# (optional) Install the "IndigoPerl" to the default directory: c:\usr\  (perl.exe will be located to c:\usr\bin\perl.exe )
# Extract "PHPXref" to c:\PHPXref (or other directory you preferred)
# Extract "PHPXref" to c:\PHPXref (or other directory you preferred)
# Modify the perl path of the file c:\PHPXref\phpxref.bat  by means of text editor such as NotePad, [http://notepad-plus.sourceforge.net/ Notepad++]... <pre>C:\Perl\bin\perl phpxref.pl </pre> to <pre>c:\perl-5.10.0\bin\perl.exe phpxref.pl </pre>
# Set the source php scripts where you want to analysis
# Copy the ''php_scripts'' you want to analyze to c:\PHPXref\source\''php_scripts\''
#* 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\''
 
<pre>
# Character set to specify for generated HTML
# CHARSET=iso-8859-1
CHARSET=utf-8
</pre>


== generation the cross reference report ==
== generation the cross reference report ==
# Execute the c:\PHPXref\phpxref.bat and wait some minutes...
# Execute the following command and wait some minutes...
#* {{Win}}: {{kbd | key=c:\PHPXref\phpxref.exe}}
#* {{Mac}}/{{Linux}}: {{kbd | key=perl phpxref.pl}}
# Example of summary statistics  
# Example of summary statistics  
<pre> Files Scanned: 1284 containing 669767 lines
<pre> Files Scanned: 1284 containing 669767 lines
Line 24: Line 38:
</pre>
</pre>


Browse the generated report: file://c:\PHPXref\output/index.html or see the [http://xref.moodle.org/nav.html?index.html demo]
Browse the generated report: file://c:/PHPXref/output/index.html  




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


[[Category:PHP]] [[Category:Programming]] [[Category:Software]]
[[Category:PHP]] [[Category:Programming]] [[Category:Software]]

Latest revision as of 18:41, 8 February 2016

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

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

requirement[edit]

  1. Download PHPXref for MS Windows Win   / Mac icon_os_mac.png / 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[edit]

  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[edit]

  1. Execute the following command and wait some minutes...
    • Win   : c:\PHPXref\phpxref.exe
    • Mac icon_os_mac.png /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
  • Mac icon_os_mac.png PHPXref 0.7.1 + perl 5, version 18, subversion 2 (v5.18.2) built for darwin-thread-multi-2level
Retrieved from "https://wiki.planetoid.info/index.php?title=PHPXref&oldid=16217"