引用文件是将另一个源文件的全部内容包含到当前源文件汇中进行使用,引用外部文件可以减少代码的重复编写。PHP提供了include语句、require语句、include_once语句及require_once语句实现引用文件。
include\include_once
include()语句将引用指定文件中的所有文本,并把文本复制到该语句所在的文件中。这些包含的文件中的PHP代码就好像是主文档的一部分一样来执行。语法格式:
boolinclude (string $filename); //如果文件已被包含,则返回true
当一个文件被包含时,其中所包含的代码继承了include所在行的变量范围。这意味着从该处开始,调用文件在该行处可用的任何变量在被调用的文件中也都可用,而且所有在包含文件中定义的函数和类都具有全局作用域。
另一种导入文件方法是使用include_once()函数。include_once()函数会在导入文件前检测该文件是否在该页面的其他部分被导入过,如果有的话,就不会重复导入该文件,例如,要导入的文件中存在一些自定义函数,那么如果在同一个程序中重复导入这个文件在第二次导入时便会发生错误,因为PHP不允许相同名称的函数被重复声明。
PHP中的被包含文件可以像函数一样返回一个值,只需要在被包含文件的末尾使用return语句来结束代码的执行。
$var=include(string $filename);
require\require_once
引用文件requlre语句的使用方法与include语句类似,都是实现对外部文件的引用。在PHP文件被执行之前,PHP解析器会用被引用的文件的全部内容替换require语句,然后与require语句之外的其他语句组成新的PHP文件,最后再按新PHP文件执行程序代码。因为require语句相当于将另一个源文件的内容完全复制到本文件中,所以一般将其放在源文件的起始位置,用于引用需要使用的公共函数文件和公共类文件等。PHP可以使用任何扩展名来命名引用文件,但PHP通常用来解析扩展名被定义为.php的文件。引用语法:
voidrequire(string filename); //filename指定完整路径文件名
在实际编程中会遇到一个页面调用多个页面的情况,可能出现嵌套调用,重复调用,所以就要用到require_once避免重复调用引起的错误。在应用require_once语句时会先检查要引用文件是不是在程序中的其他地方已被引用过,如果有,则不会再次重复调用该文件。
总结一下,require语句来调用文件和include语句是类似的,但存在如下区别。
使用require语句调用文件时,如果调用的文件没找到,require语句会输出错误信息,并且立即终止脚本的处理。而include语句在没有找到文件时则会输出警告,不会终止脚本的处理。
使用require语句调用文件时,在PHP脚本被执行之前,PHP解析器将用外部文件替换require语句,然后与其他语句组成新的PHP文件并执行该新的程序;而通过include语句调用外部文件时,只有程序执行到该语句时,才会调用外部文件。
include_once和require_once语句确保一个被包含文件只包含一次,使用这个语句可以防止意外多次包含相同的函数库,从而导致函数和类的重复定义及变量重新赋值而产生错误。但include_once语句在脚本执行期间调用外部文件发生错误时,产生一个警告,而require_once语句则导致一个致命错误。
不同目录下文件相互引用
当多个php文件存在相互引用关系时,保险的做法是写上文件的全路径,这样可以在任意目录下启动主程序所在文件。但这种使用这种引用方式不利于文档迁移和部署。
因此我们通常使用相对路径进行引用。
相对路径
相对路径文件引用即在文件路径中使用‘.’、‘..’、‘/’,其中. 表示当前目录; ..表示上级目录; /表示目录分隔符。如果文件名以”./”或者”../”做前缀,则表示当前文件所在目录或父目录。如
[root@localhostphp]# tree
.
├──a.php
└──b
├──b.php
[root@localhost php]# cat b/b.php
include_once("../a.php");
$filepath=dirname(__FILE__);
echo
"b file is in: ".$filepath."\n";
?>
我们分别在b目录和其上级目录下运行b.php,如
[root@localhost b]# php b.php
a fileis in: /test/php
b fileis in: /test/php/b
[root@localhost php]# php b/b.php
PHPWarning: include_once(../a.php): failedto open stream: No such file or directory in /test/php/b/b.php on line 2
PHPWarning: include_once(): Failed opening'../a.php' for inclusion (include_path='.:/usr/share/pear:/usr/share/php') in/test/php/b/b.php on line 2
b fileis in: /test/php/b
[root@localhostphp]#
这是为什么呢?这是因为在相对路径使用时,其他一些web编程语言中相对路径都是以当前处理文件(本例为b.php)所在目录为基准,而在php中并非如此,php中相对路径是以当前工作目录(php解释器运行所在目录)为基准的,并非以当前处理文件所在的目录为基准。所以,在b目录下运行b.php,php解释器会去php目录下寻找a.php文件,这是可以找到的。当在php目录下运行b.php,php解释器会去test目录下寻找a.php文件,这当然是找不到的。
解决这一问题,有两种方法,
在包含语句中使用dirname(__FILE__),如
[root@localhostb]# vi b.php
include_once(dirname(__FILE__)."/../a.php");
$filepath=dirname(__FILE__);
echo"b file is in: ".$filepath."\n";
?>
使用dirname(__FILE__)获取当前文件所在的目录,然后根据这个目录,向前或者向后定位。dirname(__FILE__)."/../a.php"就等价于/test/php/b/../a.php,即/test/php/a.php。
[root@localhostb]# cd /test/php/b/../
[root@localhostphp]#
验证一下
[root@localhostphp]# php b/b.php
a fileis in: /test/php
b fileis in: /test/php/b
使用chdir(__FILE__)
这个语句可以把当前文件所在的目录设置为当前工作目录,尤其是交叉引用的时候非常有用。格式
chdir(dirname(__FILE__));
set_include_path
以上都是使用include()函数或require()函数来引用文件,我们也可以修改php.ini配置文件达到同样的目的,设置include_path的作用就是针对include和require的路径范围进行限定。
[root@localhostetc]# cat php.ini | grep include_path
;include_path= ".:/php/includes" ;linux平台下的路径配置
;include_path= ".;c:\php\includes" ;windows下路径配置
;PHP's default setting for include_path is ".;/path/to/php/pear"
[root@localhostetc]#
设置了include_path后,要包函文件就比较简便了,不用写一大串的路径,当很多需要包函的文件都在一个目录下时,这样会觉得比较方便。如include(‘/test/php/a.php’)和include(‘a.php’)是等价的,只不过后者需要在配置文件中将include_path设置为”/test/php”。
除了在配置文件中修改路径外,我们可以动态地修改这个路径,使用set_include_path函数在脚本里动态地对PHP.ini中include_path修改。
如,
[root@localhostb]# vi b.php
//include_once(dirname(__FILE__)."/../a.php");
set_include_path(get_include_path().PATH_SEPARATOR.dirname(__FILE__)."/../"); //设置include_path
$include_value= ini_get('include_path'); //获取当前inclue_path值
echo$include_value."\n";
include('AA.php');
$filepath=dirname(__FILE__);
echo"b file is in: ".$filepath."\n";
?>
get_include_path()是获取当前include_path的默认值。PATH_SEPARATOR 是个常量,是include_path的路径分界符合,window上是;,在unix和Linux上是:。
[root@localhostb]# php b.php
.:/usr/share/pear:/usr/share/php:/test/php/b/../
a fileis in: /test/php
b fileis in: /test/php/b
当指定的 include_path含有多个目录时 ,而所要求包含的文件在这几个目录都有相同名称的文件存在时,php选择使用设定 include_path 时排位居前的目录下的文件。