PHPxref 安装使用手册

2,116 人次阅读
没有评论

共计 1578 个字符,预计需要花费 4 分钟才能阅读完成。

PHPXref是一个十分优秀的PHP开发工具,它能将某一个程序(如Magento)中所有的函数、变量、常量等分类记录,生成一个HTML网页列表,你可以轻松地在这个列表中找到某个函数在什么位置被定义,在什么位置被引用。这一点无论是对于一个Magento插件开发者,还是想学习研究Magento的人都是十分有用的,这里有个已经制作好的Magento分析文档: http://files.magentochina.org。

PHPXref的主要功能包括

  1. 文件管理

    无论要找什么文件,用它能很快地搜索到,如果你的文件中有符合语法规则的注释,PHPXref还能将它列在文件名的旁边,更容易了解这个文件的功能用途,也不用为了找一个文件翻遍整个文件夹,打开每个文件查找注释了

  2. 函数、变量、常量、类管理

    Magento内置了多种功能强大的函数、类,无论是字符处理还是远程URL读取等都有现成的函数,但我们往往不知道这个函数能在Magento里 面找到,现在容易多了,搜索一下就找到了,如果在开发过程中遇到某个Magento函数,不知道它是干什么用的,这时候就得找到这个函数在哪里定义的,可 是Magento里面上百个文件上哪找去?还是用PHPXref好了

  3. 文件包含管理

    PHPXref提供了每个文件的包含文件列表和被包含的文件

  4. 源代码高亮

    这个功能也是比较实用的,但在实际测试中偶尔会出错

  5. 出色的关联功能

    在浏览源代码时,将鼠标指到某个函数名,就会在鼠标旁边出现函数的定义页面,以及被使用次数,而且对使用较多的变量名,也是可以直接显示所有的关于这个变量的使用情况

Window安装PHPxref

PHPXref有不同平台的版本。WINDOWS版本无需安装,更不需要任何第三方组件,直接下载解压后,即可运行。
1、打开PHPXref网站:http://phpxref.sourceforge.net ,下载phpxref-0.7.1-win32.zip 解压到本地的web目录下,例如:D:\xampp\htdocs\phpxref
2、将Magento某个版本的PHP源代码复制到 D:\xampp\htdocs\phpxref\source 目录下
3、如果下载的是phpxref-0.7.1-win32.zip,直接运行:PHPXref.exe 即可,不需要安装Perl
4、将D:\xampp\htdocs\phpxref\output 生成好的文档复制到web目录即可

Linux安装PHPxref

Linux安装PHPxref只需要下载phpxref-0.7.1.tar.gz ,运行perl phpxref.pl,其他同Windows安装一样。

PHPxref配置

PHPxref配置文档在phpxref.cfg里,可以配置:Output路径、项目名称、Cookie、Html模板文件等信息

PS:我使用PHPxref生成Magento1.6,Output文件大概有1.5GB,处理结果如下:

Summary statistics:
Files Scanned: 9906 containing 1798284 lines
18534 variable names in 82688 definitions and 533902 references.
18297 function/method names in 40688 definitions and 277903 references.
250 constant names in 281 definitions and 1411 references.
6465 class names in 6511 definitions and 23951 references.
0 table names in 0 references.

http://files.magentochina.org/使用过CDN加速,上网方便的话还是推荐使用这个Magento在线文档分析

正文完
 0