require()和include()有許多相似之處,也有些不同。理解它們的不同點非常重要,否則很容易犯錯誤。
我把這兩個語句放在一起介紹,讀者可以比較學習。
1.require()語句
require()語句用於指定的文件代替語句本身,就象C語言中的include()語句一樣。如果php配置文件php.ini中的URL fopen wrappers 是打開的(默認情況下是打開的),就可以使用URL來指定文件的位置從而實現遠程文件的調用。
有一點就是使用require()和include()語句時要特別的注意。那就是在被包含的文件中,處理器是按照html模式來解釋其中的內容的,處理完被包含的內容後又恢復到php模式。所以如果需要在被包含文件中使用php語法,就要使用正確的php開始和結束標記來把這些語句包含進去。
require()和include()知識php中的一種語言特性,而不是函數。它們和函數有許多不同的地方。
比如:require()所包含的文件中不能包含控制結構,而且不能使用return這樣的語句。在require()所包含的文件中使用return語句會產生處理錯誤。
不象include()語句,require()語句會無條件地讀取它所包含的文件的內容,而不管這些語句是否執行。所以如果你想按照不同的條件包含不同的文件,就必須使用include()語句。當然,如果require()所在位置的語句不被執行,require()所包含的文件中的語句也不會被執行。
require()不能在循環體中根據條件的不同而包含不同的文件。require()語句只會在第一次執行時調用它所包含的文件中的內容替換本身這條語句,當再次被執行時只能執行第一次所包含的語句。但是include()語句可以在循環體中來包含不同的文件。
require()語句中的變量繼承require()語句所在位置的變量作用域。所有在require()語句的位置可以訪問的變量,在require()語句所包含的文件中都可以訪問。如果require()語句位於一個函數內部,那麼被包含文件內的語句都相當於定義在函數內部。
require()語句在PHP程序執行前就會將使用require引用的文件讀入,因此require通常放到程序的開始處。因此要特別注意一點,require語句有一點強,不管程序是否真的需要引用的文件,只要你使用require語句,它都會把他們包含進來!即使你是在條件控制語句中使用這個函數進行包含,那怕是那個條件不為真,引用文件也會被包含進來!形成了僵屍,在運行過程中這些僵屍是不起任何可見作用的,但是很明顯它會加重負擔,所以這一點要特別注意!如果使用require語句發生了包含錯誤,那麼程序將輸出出錯信息並停止運行!!
如果require()語句通過聲明文件的URL來包含遠程文件,而且遠程服務器按照php代碼來解釋該文件的話,本地php文件中所包含的內容是在遠程服務器上處理以後的結果。例如:
/*
這個例子假設some_server服務器可以解釋.php文件,而不對.txt文件進行解釋。在遠程文件中
需要變量$varfirst和$varsecond
*/
/*不能正確執行,遠程服務器不處理.txt文件*/
require("http://some_server/file.txt?varfirst=1&varsecond=2");
/*不正確,這樣只能在本地機上尋找file.php文件*/
require("file.php?varfirst=1&varsecond=2");
/*正確的語句*/
require("http://some_server/file.php?varfirst=1&varsecond=2");
$varfirst=1;
$varsecond=2;
require("file.txt"); /*正確的語句*/
require("file.php"); /*正確的語句*/
本來在php3.0中,require()所包含的文件可以使用return語句,但條件是return語句不能出現在{}內部,而必須出現在被包含文件的全局范圍內。在php4.0中已經取消了require()的這個功能,但是仍然可以使用include()來實現。
2.include()語句 include()語句和require()語句有許多相同的地方。凡是在上邊require()語句中沒有明確說明不能適用於include()的部分外,require()語句的功能完全適用於include()語句。下邊介紹require()語句所沒有的include()語句的功能和特點。
include語句只有在被執行時才會讀入要包含的文件。在錯誤處理方便,使用include語句,如果發生包含錯誤,程序將跳過include語句,雖然會顯示錯誤信息但是程序還是會繼續執行!
php處理器會在每次遇到include()語句時,對它進行重新處理,所以可以根據不同情況的,在條件控制語句和循環語句中使用include()來包含不同的文件。
例如:
<?php
$files=array('first.php','second.php','third.php');
for($i=0;$i<count($files);$i++)
{
include $files[$i];
}
?>
在php3.0和php4.0中include()語句所包含的文件中都可以使用return語句來返回一個值,並停止執行被包含文件下面的內容。但php3.0和php4.0在處理這樣的情況時有所不同。在php3.0中return語句不能包含在{}內,除非它在一個函數中,因為這時它表示函數的返回值而不是文件的返回值。而在php4.0中就沒有了這樣的限制,用戶甚至可以在文件中返回一個數字,就象函數的返回值一樣。這樣的語句在
php3.0中通常會報告錯誤。以下舉例說明:
假設被包含的文件為test.inc和主文件main.php位於一個目錄中。test.inc的內容如下:
test.inc
<?php
echo "Before the return<br>\n";
if(1)
{
return 27;
}
echo "After the return<br>\n";
?>
假設在main.php文件中包含下面的語句:
<?php
$retval=include('test.inc');
echo "File returned:'$retval'<br>\n";
?>
php3.0解釋器會在第二行報告錯誤,而不能得到include()語句的返回值。但在php4.0中會得到下面的結果:
Before the return
File returned: '27'
下邊假設main.php改為:
<?php
include('test.inc');
echo "Back in main.html<br>\n";
?>
在php4.0中的輸出結果是:
Before the return
Back in main.html
在php5.0中的輸出結果也是:
Before the return
Back in main.html
在php3.0中的輸出結果是:
Before the return
27Back in main.html
Parse error:parse error in /apache/htdocs/phptest/main.html on line 5
出現上面的錯誤是因為return語句位於{}內部而且不是一個函數內部。如果把{}去掉,使它位於test.inc的最外層,輸出結果是:
Before the return
27Back in main.html
之所以出現27,是因為在php3.0中不支持include()返回。
3.require_once()和include_once()語句
require_once()和include_once()語句分別對應於require()和include()語句。require_once()和include_once()語句主要用於需要包含多個文件時,可以有效地避免把同一段代碼包含進去而出現函數或變量重復定義的錯誤。例如:如果創建兩個文件util.inc和fool.inc,程序代碼分別為:
util.inc:
<?php
define(PHPVERSION,floor(phpversion()));
echo "GLOBALS ARE NICE<br>\n";
function goodTea()
{
return "Olong tea tasts good!";
}
?>
和fool.inc:
<?php
require ("util.inc");
function showVar($var)
{
if(PHPVERSION==4)
{
print_r($var);
}
else
{
var_dump($var);
}
}
?>
然後在error_require.php中包含這兩個文件:
<?php
require("fool.inc");
require("util.inc");//此句會產生一個錯誤
$foo=array("1",array("complex","quaternion"));
echo "this is requiring util.inc again which is also<br>\n";
echo "required in fool.inc\n";
echo "Running goodTea:".goodTea()."<br>\n";
echo "Printing foo:<br>\n";
showVar($foo);
?>
當運行error_require.php時,輸出結果如下:
GLOBALS ARE NICE
GLOBALS ARE NICE
Fatal error:Cannot redeclare goodTea() in util.inc on line 4
如果使用require_once()語句來代替 require()語句,就不會出現上面的錯誤。我們把error_require.php和fool.inc中的require()語句改為require_once()語句並重命名為error_require_once.php,這是顯示結果如下:
GLOBALS ARE NICE
this is requiring util.inc again which is also
required in fool.inc Running goodTea:Olong tea tastes good!
Printing foo:
Array([0] => 1 [1] => Array ([0] => complex [1] = quaternion))
include_once()語句的語法和include()語句類似,主要區別也是避免多次包含一個文件而引起函數或變量的重復定義。
require_once語句有一個引用鏈,它可以保證文件加入你的程序僅僅只有一次,而且會避開變量值和函數名之間的沖突。
和require_once語句一樣,include_once語句把include的功能擴展了。在程序執行期間,將指定的文件包含進來,如果從文件引用進來的程序先前已經包含過的時候,include_once()就不會把它再包含進來。也就是僅僅可以引用同一個文件一次!
include_once() 語句在腳本執行期間包含並運行指定文件。此行為和 include() 語句類似,唯一區別是如果該文件中的代碼已經被包含了,則不會再次包含。如同此語句名字暗示的那樣,只會包含一次。
include_once() 應該用於在腳本執行期間同一個文件有可能被包含超過一次的情況下,想確保它只被包含一次以避免函數重定義,變量重新賦值等問題。
使用 require_once() 和 include_once() 的更多例子見最新的 PHP 源程序發行包中的 PEAR 代碼。
返回值和 include() 相同。如果文件已被包含,本函數返回 TRUE。
注: include_once() 是 PHP 4.0.1pl2 中新加入的。
注: 要注意 include_once() 和 require_once() 在大小寫不敏感的操作系統中(例如 Windows)的行為
可能不是所期望的。
例子: include_once() 在 Windows 下不區分大小寫
<?php
include_once("a.php"); // this will include a.php
include_once("A.php"); // this will include a.php again on Windows! (PHP 4 only)
?>
此行為在 PHP 5 中改了,路徑先被規格化,因此 C:\PROGRA~1\A.php 和 C:\Program Files\a.php 的實現一樣,文件只會被包含一次。
如果要包含的文件不存在,include提示notice,然後繼續執行下面的語句,require提示致命錯誤並且退出。
win32平台下它們都是先包含後執行,所以被包含文件裡最好不要再有include或require語句,這樣會造成目錄混亂。或許Linux下情況不同,暫時還沒測試。
如果一個文件不想被包含多次可以使用include_once或require_once## 讀取,可以寫入文檔數據。
<?php
function r($file_name) {
$filenum=@fopen($file_name,"r");
@flock($filenum,LOCK_SH);
$file_data=@fread($filenum,filesize($file_name));
@fclose($filenum);
return $file_data;
}
function w($file_name,$data,$method="w"){
$filenum=@fopen($file_name,$method);
flock($filenum,LOCK_EX);
$file_data=fwrite($filenum,$data);
fclose($filenum);
return $file_data;
}
?>