PHP include_path 用法详解
ini_set('include_path', CAKE_CORE_INCLUDE_PATH . PATH_SEPARATOR . ROOT . DS . APP_DIR . DS . PATH_SEPARATOR . ini_get('include_path'));
我们看到这个程序动态修改include_path,不过cake在这儿是把 CAKE_CORE_INCLUDE_PATH 和 APP_DIR 加到 include_path里,并且优先在这两个目录下找包含程序.
注意到它这里用到了PATH_SEPARATOR这个变量,这样这段代码在windows和linux下能通用.
从中受到启发,我们可以根据自己的需要把一些include目录动态的加入进来,比如说我们有很多libs:lib1,lib2,lib3等等,我们不必把这些libs都加到include_path里,因为它们之间可能冲突.
可以建立一个inc_dir,并把这个目录加入到include_path,在inc_dir下,分别建立inc_path1.php inc_path2.php inc_path3.php,分别写入:
- <?php
- ini_set('include_path', ini_get('include_path').PATH_SEPARATOR.$dirToLib1);
- <?php
- ini_set('include_path', ini_get('include_path').PATH_SEPARATOR.$dirToLib2);
- <?php
- ini_set('include_path', ini_get('include_path').PATH_SEPARATOR.$dirToLib3);
在写程序的时候,比如要用lib2的functions.php,就可以这么写:
- <?php
- require 'inc_path2.php';
- require 'functions.php';
- ?>
当时候函数include(),require(),fopen_with_path()函数来寻找文件时候.在不设置include_path的情况下,这些函数打开文件时候默认的是以web根目录去寻找.当设置include_path以后,这些php函数就会先在指定的include_path目录下面去搜索寻找.
其原理和window系统的环境变量相似,在window运行cmd命令的时候,输入一些cmd的命令之后系统会在其设定的环境变量里面去搜索这些命令是否存在,存在就可以执行.
2.include_path的设置
第一种方法:修改php.ini文件中的include_path项。
include_path = .:/usr/local/lib/php:./include
第二个方法：使用ini_set方法。
ini_set("include_path", ".:../:./include:../include");
3.注意
zendframework include 设置 index.php,代码如下:
- set_include_path('.' .PATH_SEPARATOR.'../library/'
- .PATH_SEPARATOR.'./application/models/'
- .PATH_SEPARATOR.'./application/lib/'
- .PATH_SEPARATOR.get_include_path());
PATH_SEPARATOR是一个常量,在Linux系统中是一个" : "号,Windows上是一个";"号,所以编写程序时最好用常量 PATH_SEPARATOR 代替,否则如果系统从linux移植到win系统或反过来移植会出错.
get_include_path取得当前已有的环境变量,加上前面的设置就是新的系统include
include_path是怎么起作用的?
如果有多个include_path顺序是怎么样的?什么情况下include_path不起作用?今天,我就全面的介绍下这个问题,先从一个例子开始吧.如下的目录结构:
- root
- ├ 1.php
- ├ 3.php
- └ subdir
- ├ 2.php
- └ 3.php
在1.php中:
- <?php
- ini_set(“include_path”, “.:path_to_subdir”);
- require(“2.php”);
- ?>
而在2.php中:
- <?php
- require(“3.php”);
- ?>
而在root目录下的3.php打印出”root”,在subdir目录下的3.php打印出”subdir”;现在,我的问题来了:
1. 当在root目录下运行1.php,会得到什么输出?
2. 在subdir下运行上一级目录的1.php,有会得到什么输出?
3. 当取消include_path中的当前目录path(也就是include_path=”path_to_subdir”),上面俩个问题又会是什么输出?
PHP中的include_path
PHP在遇到require(_once)/include(_once)的指令的时候,首先会做如下的判断:
要包含的文件路径是绝对路径么?
如果是, 则直接包含, 并结束.
如果不是, 进入另外的逻辑(经过多次调用,宏展开后进入_php_stream_fopen_with_path)寻找此文件
接下来,在_php_stream_fopen_with_path中,会做如下判断:
要包含的文件路径是相对路径么(形如./file, ../dir/file, 以下用”目录相对路径代替”)?
如果是,则跳过include_path的作用逻辑,直接解析相对路径(随后单独介绍),会根据include_path,和当前执行文件的path组成一个待选的目录列表,比如对于文章前面的例子来说,会形成一个如下的待选列表.
“.:path_to_subdir:current_script_dir
然后,依次从待选列表头部开始,根据DEFAULT_DIR_SEPARATOR(本文的环境是”:”)取出待选列表中的一个路径,然后把要包含的文件名附加在这个路径后面,进行尝试,如果成功包含,则返回,否则继续下一个待选路径.
到现在为止,我们已经可以回答我开头提出的3个问题了:
1. 因为在root目录下执行, 所以在1.php中包含2.php的时候, include_path的第二个待选路径起了作用(path_to_subdir), 找到了path_to_subdir/2.php, 而在2.php包含3.php的时候, 当前工作目录是root下, 所以在包含3.php的时候, include_path的第一个待选路径”.”(当前工作目录)下就找到的匹配的文件, 所以得到的输出是”root”.
2. 同1, 只不过当前的路径是subdir, 所以得到的输出是”subdir”.
3. 因为没有了当前路径为include_path,所以在root目录下运行的时候2.php中包含3.php的时候,是path_to_subdir起了作用,所以无论在root还是subdir都将得到”subdir”的输出.
而如果在2.php中清空include_path:
- <?php
- ini_set(“include_path”, ”);
- require(“3.php”);
- ?>
那么将会是current_script_dir起作用,而这个时候current_script_dir是2.php的路径,所以还是会得到”subdir”的输出.
目录相对路径
在使用目录相对路径的情况下,相对路径的基点,永远都是当前工作目录.为了说明在目录相对路径下的情况,我们再看个列子,还是上面的目录结构,只不过1.php变成了:
- <?php
- ini_set(“include_path”, “/”);
- require(“./subdir/2.php”);
- ?>
2.php变成了:
- <?php
- require(“./3.php”);
- ?>
如果在root目录下执行,2.php中寻找3.php将会在当前目录的相对路径下寻找,所以得到的输出是”root”,而如果是在subdir下执行上一级目录的1.php(php -f ../1.php), 将会因为在subdir下找不到”./subdir/2.php”而异常退出.
后记:1.因为使用include_path和相对路径的情况下,性能会和寻找的次数有关,最坏的情况下,如果你有10个include_path,那么最多可能会重试11次才能找到要包含的文件,所以,在能使用绝对路径的情况下最好使用绝对路径.