PHP文档工具

 更新时间:2016年11月25日 15:19  点击:1875
写文档是一项乏味却不得不做的工作,而编写API级的文档更是意味着大量的重复劳动和难以保持的一致性。这里我们要推荐给大家的,是支持PHP5语法分析的文档工具——phpDocumentor。
使用phpDocumentor不仅可以自动从代码中提取出函数和方法定义,还可以自动处理各个class之间的关系,并据此生成class tree。你还可以选择将文档生成html、chm或者pdf。有了phpDocumentor,文档工作变得轻松了很多。

安装phpDocumentor
在pear下安装phpDocumentor是一件极其简单的事情,只需要在cmd窗口中cd 到php安装目录下,然后输入
Pear install phpDocumentor

Pear就会自己下载并完成phpDocumentor的安装。
在phpDocumentor成功安装后,php安装目录下会多出来一个phpdoc.bat。这个文件就是我们用来生成文档的批处理文件了。
<? 相关知识 ?>

phpDocumentor是phpDoc的升级版本,是专门为支持php5语法而重写的文档工具,当你的php版本为5时,运行phpDoc.bat,它会自动去调用phpDocumentor。所以文章中的提到的phpDoc和phpDocumentor实际上是相同的。


在phpdoc.bat所在目录下,输入
Phpdoc 学习PHP时,我们总是被教导到,PHP是一种服务器端脚本,是不能用来控制客户端的。而伴随着PHP5的发布,这句话就不是那么正确了。因为现在,PHP也可以用来写客户端脚本了。是的,你没有听错,用PHP写客户端脚本。

ActivePHP的安装

下面我们就来演示一下如何使用PHP写客户端脚本。首先,你需要下载PHP5在windows上的安装包,然后解压到一个目录里,比如:C:Program FilesEasyPHP5php,接着呢,进入windows的命令行模式,cd到你解压PHP5的目录,然后键入:
regsvr32 php5activescript.dll

回车以后,你就会看见一个成功提示:
这说明你已经可以使用ActivePHP了。好,下边我们就来写一个简单的脚本来测试下,仍然是全球通用的HelloWorld:P。

<? 代码列表 ?>

<script language="ActivePHP5">
$document->write( 'Hello World!' );
</script>


将上边的代码保存为Hello.htm,然后双击它,你就可以看见下边的结果了。

<? 环境要求 ?>

PHP:5.0.0
OS: Windows
Browser: IE

嗯,效果不错,但是还不够有客户端的特色。让我们来修改下代码:

<? 代码列表 ?>

<script language="ActivePHP5">
$window->alert( 'Hello World!' );
</script>


再运行下看看~
是不是有些感觉了?

我们的版本管理系统

下边我们回过头来说说版本管理系统。我们要做的版本管理系统很简单,就是把开发目录下的文件和数据库的数据表打成一个RAR包,按时间命名并放到一个备份目录下。由于本文的主要目的是演示ActivePHP的使用,我们就不考虑对RAR包的管理和将其解压覆盖原有数据的内容了,不过对于一个版本管理系统来说,这部分是很重要的,建议大家自己完成;) 。

<? 相关知识 ?>

Mysql的数据库是以文件形式存放在mysql/data目录下的,一个库对应着一个目录。


首先我们需要知道PHP调用Windows上其他程序的方法,那就是System命令。这个命令简单得和Echo一样,直接
System('command');

就可以了。

然后我们就需要知道RAR的命令行使用方法了,这种东西应该当然要找帮助文档了,就在RAR的安装目录下。在英文堆里看了好久,终于找到了一个方法:把要压缩的文件写到一个文本文件里,再把文件名作为参数,传给RAR。写成命令行就是:
H1>
(PHP 3, PHP 4 >= 4.0.0)
fwrite -- 二进制文件写入
描述
 
int fwrite (int fp, string string [, int length])
 
fwrite() 写入字符串string 的内容到由fp指定的文件流中。如果length 给出,将写完length 指定的字节后结束。
注意,如果length 参数给出,那么magic_quotes_runtime 配置选项将被忽略,同时字符串中的“”将不被删除。
注意:在某些系统上将区分二进制和文本文件(i.e. Windows),这个文件必须使用带有'b'参数的模式的fopen() 来打开。
参见fread(), fopen(), fsockopen(), popen(), 和 fputs().

  这里可以看到另外一个语句Limit,Limit语句就是用来针对具体的请求方法来设定访问控制的,其中可以使用GET、POST等各种服务器支持的请求方法做Limit的参数,来设定对不同请求方法的访问限制。一般可以打开对GET、POST、 HEAD三种请求方法,而屏蔽其他的请求方法,以增加安全性。Limit语句中,可以用Order 、Allow、Deny,Allow和Deny中可以使用匹配的方法针对域名和IP进行限制,只是对于域名是从后向前匹配,对于IP地址则从前向后匹配。
 

  DirectoryIndex index.html
  很多情况下,URL中并没有指定文档的名字,而只是给出了一个目录名。那么Apache服务器就自动返回这个目录下由DirectoryIndex定义的文件,当然可以指定多个文件名字,系统会这个目录下顺序搜索。当所有由DirectoryIndex指定的文件都不存在时,Apache服务器可以根据系统设置,生成这个目录下的所有文件列表,提供用户选择。此时该目录的访问控制选项中的Indexes选项(Options Indexes )必须打开,以使得服务器能够生成目录列表,否则Apache将拒绝访问。
 

  AccessFileName .htaccess
  AccessFileName定义每个目录下的访问控制文件的文件名,缺省为.htaccess,可以通过更改这个文件,来改变不同目录的访问控制限制。
 

Order allow,deny
Deny from all
  除了可以针对目录进行访问控制之外,还可以根据文件来设置访问控制,这
就是File语句的任务。使用File 语句,不管文件处于哪个目录,只要名字匹配, 就必须接受相应的访问控制。这个语句对于系统安全比较重要,例如上例将屏蔽所有的使用者不能访问.htaccess文件,这样就避免.htaccess中的关键安全信息不至于被客户获取。
 

  #CacheNegotiatedDocs
  缺省情况下如果代理服务器和Apache服务器协商是否缓存其网页,Apache给
予否定的回答,不希望自己的网页被代理服务器缓存。然而这样就不能有效的利用代理服务器的优势,因此可以设置CacheNegotiatieDocs 选项, 使得代理服务器可以对网页进行缓存。然而即使不设置这个选项,有的代理服务器(或通过调整设置)也能对网页进行缓存。
 

  UseCanonicalName On
  打开这个UseCanonicalName是Web服务器的标准做法,因为客户发送的大部分请求都是对本服务器的引用,这样服务器就能使用ServerName和Port选项的设置内容构建完整的URL,并回应客户,使浏览器能得到规范的URL。如果将这个参数设置为Off,那么Apache将使用从客户请求中获得服务器的名字和端口值(支持HTTP 1.1的客户的请求中将会有这些信息),重新构建URL。
TABLE border=0 cellPadding=0 cellSpacing=0 height="100%" width="100%">
require()
require() 语句用它指定的文件代替它自己,这很像C中的预处理#include 的功能。
如果在PHP中"URL fopen wrappers"项是打开的(这是默认的配置),你可以在require()中使用URL代替本地路径。更多的信息参见Remote files和fopen()。
一个重要的提示是:当一个文件被include()或require()时,是怎样工作的,从目标文件开始分析PHP模块和HTML模块的点滴,在结束时重新摘要PHP模块。
前提是,有一些被有效地PHP开始和结束标签包含着的可执行的PHP代码在文件中。
require() 实际上不是一个PHP函数:正确的说,它是一个语言的构成部分。它的规则与函数有一些不同。如,require() 不会受包含控制结构的控制。另外,它不会返回任何值;尝试从require()调用中读取一个返回值的结果是解析错误。
不同的是include(), require() 将总是读目标文件,即使它没有可执行的行。如果你想有条件的包含一个文件,请使用include()。条件语句不会影响require()。
 可是,if the line on which the require() occurs is not executed, neither will any of the code in the target file be executed.
类似的,循环控制也不会影响require()的行为。
 尽管包含文件仍然受循环的控制,但是require() 只执行一次。
这意味着,你不能把require() 语句放在一个循环语句中,期待着它能在每一次循环中包含不同的文件。要这样做,请使用include() 语句。
 
require ('header.inc');
 
当一个文件被require()包含时, 包含着的代码将继承发生require() 那行的变量作用域。在调用文件行的任何可用变量在被调用文件中都将可用。如果require() 发生在正在调用文件中的函数里,这时被调用文件中的全部代码就好像已经被定义在了函数中一样。
如果require()包含的文件是经过HTTP使用fopen打开的,如果目标服务器能作为PHP代码解析目标文件,变量可以使用带有URL的有HTTP GET请求字符串的require()传递。严格的说require()一个文件和继承它的父文件的变量作用域是不同的:这个脚本实际上是运行在远程服务器上,在本地脚本中包含的是它的结果。
 
/* 这人例子假设someserver已经配置了.php的解析而不是.txt文件。
 * 同样,'works' 意味着被包含文件中的变量$varone 和$vartwo 是可用的*/
[!--infotagslink--]

相关文章

  • 源码分析系列之json_encode()如何转化一个对象

    这篇文章主要介绍了源码分析系列之json_encode()如何转化一个对象,对json_encode()感兴趣的同学,可以参考下...2021-04-22
  • php中去除文字内容中所有html代码

    PHP去除html、css样式、js格式的方法很多,但发现,它们基本都有一个弊端:空格往往清除不了 经过不断的研究,最终找到了一个理想的去除html包括空格css样式、js 的PHP函数。...2013-08-02
  • 微信小程序二维码生成工具 weapp-qrcode详解

    这篇文章主要介绍了微信小程序 二维码生成工具 weapp-qrcode详解,教大家如何在项目中引入weapp-qrcode.js文件,通过实例代码给大家介绍的非常详细,需要的朋友可以参考下...2021-10-23
  • index.php怎么打开?如何打开index.php?

    index.php怎么打开?初学者可能不知道如何打开index.php,不会的同学可以参考一下本篇教程 打开编辑:右键->打开方式->经文本方式打开打开运行:首先你要有个支持运行PH...2017-07-06
  • Elasticsearch工具cerebro的安装与使用教程

    这篇文章主要介绍了Elasticsearch工具cerebro的安装与使用教程,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下...2021-03-08
  • PHP中func_get_args(),func_get_arg(),func_num_args()的区别

    复制代码 代码如下:<?php function jb51(){ print_r(func_get_args()); echo "<br>"; echo func_get_arg(1); echo "<br>"; echo func_num_args(); } jb51("www","j...2013-10-04
  • PHP编程 SSO详细介绍及简单实例

    这篇文章主要介绍了PHP编程 SSO详细介绍及简单实例的相关资料,这里介绍了三种模式跨子域单点登陆、完全跨单点域登陆、站群共享身份认证,需要的朋友可以参考下...2017-01-25
  • PHP实现创建以太坊钱包转账等功能

    这篇文章主要介绍了PHP实现创建以太坊钱包转账等功能,对以太坊感兴趣的同学,可以参考下...2021-04-20
  • 国庆节到了,利用JS实现一个生成国庆风头像的小工具 详解实现过程

    明天就是国庆节了,最近看到好多好友换了国庆风的头像,感觉这个挺有意思,就找到了类似的源码研究了一番,并进行了改造(并非原创,只是进行了改造,只要想分享一下实现思路)。下面就来看看如何实现一键生成国庆风头像小工具。&#8203;...2021-10-01
  • PS中像素大小、文档大小的区别

    在PS中像素大小、文档大小有什么区别呢,这个估计很多初学者不清楚,下面我来给大家讲解一下,希望对你有帮助。 1、像素大小 通常用于显示屏显示的图片大小的调整。菜...2016-09-14
  • php微信公众账号开发之五个坑(二)

    这篇文章主要为大家详细介绍了php微信公众账号开发之五个坑,具有一定的参考价值,感兴趣的小伙伴们可以参考一下...2016-10-02
  • ThinkPHP使用心得分享-ThinkPHP + Ajax 实现2级联动下拉菜单

    首先是数据库的设计。分类表叫cate.我做的是分类数据的二级联动,数据需要的字段有:id,name(中文名),pid(父id). 父id的设置: 若数据没有上一级,则父id为0,若有上级,则父id为上一级的id。数据库有内容后,就可以开始写代码,进...2014-05-31
  • 短视频(douyin)去水印工具的实现代码

    这篇文章主要介绍了市面上短视频(douyin)"去水印"的工具原来是这样实现的,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下...2021-03-30
  • PHP如何通过date() 函数格式化显示时间

    这篇文章主要介绍了PHP如何通过date() 函数格式化显示时间,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下...2020-11-13
  • PHP+jQuery+Ajax实现多图片上传效果

    今天我给大家分享的是在不刷新页面的前提下,使用PHP+jQuery+Ajax实现多图片上传的效果。用户只需要点击选择要上传的图片,然后图片自动上传到服务器上并展示在页面上。...2015-03-15
  • golang与php实现计算两个经纬度之间距离的方法

    这篇文章主要介绍了golang与php实现计算两个经纬度之间距离的方法,结合实例形式对比分析了Go语言与php进行经纬度计算的相关数学运算技巧,需要的朋友可以参考下...2016-07-29
  • PHP如何使用cURL实现Get和Post请求

    这篇文章主要介绍了PHP如何使用cURL实现Get和Post请求,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下...2020-07-11
  • 谈谈PHP中相对路径的问题与绝对路径的使用

    经常看到有人踩在了PHP路径的坑上面了,感觉有必要来说说PHP中相对路径的一些坑,以及PHP中绝对路径的使用,下面一起来看看。 ...2016-08-24
  • Eclipse中安装反编译工具Fernflower的方法(Enhanced Class Decompiler)

    这篇文章主要介绍了Eclipse中安装反编译工具Fernflower的方法(Enhanced Class Decompiler),本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下...2021-01-20
  • thinkPHP中多维数组的遍历方法

    这篇文章主要介绍了thinkPHP中多维数组的遍历方法,以简单实例形式分析了thinkPHP中foreach语句的使用技巧,需要的朋友可以参考下...2016-01-12