PHP 是甚麼？

PHP ("PHP: Hypertext Preprocessor" 的首字母縮略詞) 是一種被廣泛使用、多用途的開放源碼腳本語言，特別適合於網頁的開發，並可內嵌入 HTML 中。

一個簡單的答案，但到底是什麼意思呢﹖舉個例子：

請留意上述例子和其他語言如 Perl 或 C 所編寫的腳本之間的分別 -- 與其使用大量的指令來輸出 HTML，我們寫了一個內嵌了代碼的 HTML 腳本來做某些事〈以上述例子來說，輸出一行文字〉。PHP 代碼包含在特殊的開始和結束標記，讓您可以隨時進出“PHP 模式”。

和 Java Script 之類的用戶端語言不同的是，PHP 的代碼是在伺服器端執行。如果您的伺服器中有一個和上述例子中類似的腳本，用戶看到的將只是執行後的輸出，而無法知道該腳本的代碼內容。您甚至可以設定您的網頁伺服器用 PHP 來處理所有的 HTML 檔案。這樣一來，用戶也就無法知道您究竟在伺服器端做了些什麼。

對新手來說，PHP 是非常容易上手的，而對專業的程式員來說，它又提供了許多進階的功能。當您看到 PHP 長長的功能清單時，千萬不要感到害怕。您甚至可以在很短的時間內學會編寫一些簡單的腳本呢！

雖然 PHP 的開發是以執行伺服器端的腳本程式為主，但它實際上的功能卻遠超於此。後面的 PHP 能做些什麼？章節將更深入的為您介紹。

PHP 能做些什麼﹖

什麼都可以做！PHP 主要功能在於伺服器端的腳本程式，因此您可以用它來做任何 CGI 程式可以做的事，例如收集表單資料、動態產生網頁、或者發送 / 接收 Cookies。當然，PHP 可以做的不止這些。

PHP 腳本主要使用於三個領域。

• 伺服器端腳本：這是 PHP 最主要的工作領域。使用伺服器端腳本必須具備下列三項：PHP 剖析器〈CGI 或伺服器模組〉、網頁伺服器及瀏覽器。網頁伺服器需要和已安裝的 PHP 連線。當網頁伺服器啟動後，您可以使用瀏覽器、通過網頁伺服器來觀看 PHP 腳本的輸出。請查閱安裝指南以獲得更多資訊。
• 指令行腳本。您可以用 PHP 剖析器直接執行 PHP 腳本，而完全不需要瀏覽器或伺服器。這種用法對那些要經常以 cron (*nix 或 Linux 平台) 或 Task Scheduler (Windows 平台) 執行的腳本來說最適合不過了。這些腳本也可以用來進行簡單的文字處理。請參閱 PHP 的指令行用法以獲取更多的資訊。
• 編寫用戶端的圖形使用者介面 (GUI)。PHP 或許是用來開發視窗程式的最佳語言，不過如果您精通 PHP，並且希望在客戶端程式用上 PHP 的高階功能，您也可以使用 PHP-GTK 來開發這些程式。PHP-GTK 是 PHP 的一個延伸，並不包含在 PHP 的發行套件內。如果您對 PHP-GTK 感興趣，請瀏覽» 它的網站以獲取更多資料。

PHP 可以用在所有主流的作業系統上，包括 Linux、不同版本的 Unix〈包括 HP-UX、Solaris 和 OpenBSD〉、Microsoft Windows、Mac OS X、RISC OS 等。PHP 也支援現今大部份網頁伺服器，如 Apache、Microsoft Internet Information Server、Personal Web Server、Netscape 及 iPlanet、Oreilly Website Pro、Caudium、Xitami、OmniHTTPd 等等。PHP 已經為大多數的網頁伺服器提供了模組，至於其他的支持 CGI 標準的，PHP 也可以當作 CGI 處理器來使用。

在使用 PHP 的情況下，您可以自由地選用操作系統和網頁伺服器。此外，您還可以選擇以程序語言或物件導向程式設計，或混合兩者來開發程式。雖然 PHP 4 還不能實現所有標準的 OOP 功能，但許多代碼程式庫和大型的應用程式 〈包括 PEAR 程式庫〉都只使用了 OOP 代碼編寫而成。PHP 5 修正了 PHP 4 中 OOP 相關的弱點而且也引進了完整的物件模型。

PHP 的使用並不只局限於輸出 HTML。PHP 的功能還包括即時輸出圖像、PDF 檔案，甚至是 Flash 動畫 (須配合 libswf 和 Ming 的使用)。 您還可以很容易的輸出文字，如 XHTML 及任何的 XML 檔案。PHP 可以自動建立這些檔案，將它們儲存在文件系統裏作為動態內容的快取，而不需要將它們列印出來。

PHP 最強大、最顯著的功能之一就是它支援了許多種類的資料庫系統。以 PHP 編寫資料庫驅動的網頁是難以置信的簡單。下列為目前 PHP 所支援的資料庫系統：

• Adabas D
• dBase
• Empress
• FilePro (read-only)
• Hyperwave
• IBM DB2
• Informix
• Ingres
• InterBase
• FrontBase
• mSQL
• Direct MS-SQL
• MySQL
• ODBC
• Oracle (OCI7 and OCI8)
• Ovrimos
• PostgreSQL
• Solid
• Sybase
• Velocis
• Unix dbm

PHP 也支援使用 LDAP、IMAP、SNMP、NNTP、POP3、HTTP、COM〈Windows 操作系統〉等等通訊協定連接的服務。您還可以開啟原始的網絡通訊端口來與其他通訊協定交談。PHP 已有支援可以和絕大部份網頁程式語言進行複雜資料交流的 WDDX。說到互相連接，PHP 也可以將 Java 物件實體化，然後將它們當作是 PHP 物件來使用。您也可以用我們的 CORBA 延伸來存取遠端物件。

PHP 擁有極其有用的文字處理功能，由 POSIX 延伸或 Perl 規則運算式文字處理至剖析 XML 文件都可以做到。我們還支援 SAX 和 DOM 標準來剖析和存取 XML 文件。您也可以用我們的 XSLT 延伸來轉換 XML 文件。 PHP 5 在 libxml2 穩固的基礎上，將所有 XML 擴充功能標準化，而且也增加了 SimpleXML 和 XMLReader 等特性的支援。

另外，還有很多其它有趣的擴充功能。例如 mnoGoSearch 搜尋引擎函式、IRC 閘道函式、多種壓縮工具（gzip、bz2、zip）、日曆轉換、翻譯等……

由於我們無法在此一一列出 PHP 的所有功能和好處，敬請您繼續參閱安裝 PHP和函式參考章節以獲得上述廷伸的說明。

我需要些什麼呢？

在此教學，我們假定您的伺服器已經安裝了 PHP，而且所有以 .php 為副檔名的檔案全交由 PHP 來處理。一般的伺服器都預設此副檔名為 PHP 文檔，但是為安全起見，還是先向您的伺服器管理員查詢。若您的伺服器已支援 PHP，您只需將 .php 檔儲存在該伺服器的網頁目錄裡，伺服器就可以為您剖析 PHP 檔案，既不用編譯檔案，也不需要安裝任何工具。您就把這些 PHP 檔當作是普通的網頁好了，只不過是，我們為它加入了大量新的 HTML 標籤，而這些新標籤使得您可以做出各式各樣、變化無窮的把戲！大部份的網頁寄存服務商都支援 PHP，但如果您的服務商不提供此支援，您可以參考 » PHP 相關連結 一節。那兒列了許多支援 PHP 的服務商名單。

如果您想在自己的電腦﹝或區域網路上的主機﹞上編寫 PHP 程式，那麼您首先必須安裝一個網頁伺服器，如 » Apache。當然，還有 » PHP 啦。您最好也安裝一個資料庫伺服器，如 » MySQL。

您可以分開安裝這些程式或選擇一個較簡單的方法來安裝。可參考手冊中PHP 安裝指引 PHP 的部分（假設您已經設定好網頁伺服器），如果安裝 PHP 過程遇到了麻煩，我們建議您可以在» 安裝信件列表中詢問。如果選擇使用較簡單的方法，則可以適合您作業系統» 預先設定好的套件，只要幾個滑鼠的點選，就可以自動一次安裝所有的程式。無論在 MacOSX，Linux 還是在 Windows 的環境下安裝 支援 PHP 的網頁伺服器都是非常容易的。若使用 Linux 的話，» rpmfind 和 » PBone 可幫您找到所需的 RPM 套件，而 » apt-get可以找到 Debian 的套件。

您的第一個 PHP 網頁

在您的網頁伺服器的根目錄 (DOCUMENT_ROOT) 下建立一個稱為 hello.php 的檔案，而下列為其內容：

<html>
 <head>
  <title>PHP Test</title>
 </head>
 <body>
 <p>Hello World</p>
 </body>
</html>

      

其實，上述的程式簡單到根本用不著使用 PHP 來建立。它只不過是使用了 echo() 敘述來輸出 Hello World，如此而已。注意一點，這個檔案不需要是可執行的或有其他特殊要求。因為使用 ".php" 當作副檔名 （伺服器已被設定把這類檔案傳給 PHP），所以伺服器會找到這個檔案，並寫用 PHP 來解譯。可以把這個視為一個一般的 HTML 檔案，它有一些可使用的特別標籤用來做很多有趣的事。

可是，如果存取此檔案時並沒有輸出任何東西，或瀏覽器提示您下載它，又或者是看到原來的程式碼，那可能您的網頁伺服器並沒有開啟 PHP，或者沒有正確設定。這時，您可以詢問伺服器管理員按照手冊裡安裝這個章節裡的指示，來為您啟用 PHP 支援。如果您是在近端開發程式，可以閱讀安裝的章節並確認所有設定是正確的，並確認您是經由 http 來存取伺服器的檔案，如果只是從檔案系統開啟檔案，那麼就不會經過 PHP 的解析。當然，若您遇上無法解決的問題，» PHP 支援那兒有大量的資源可以幫助您。

這個例子也展示了 PHP 標籤的格式應用。我們使用 <?php 來表示 PHP 程式區塊的開始，然後用 ?> 標籤來表示結束。您可以像這樣的在一個 HTML 檔內任意進入或跳出 PHP 模式。詳細的語法及應用請參考基本 PHP 語法一章。

Note: 關於換行 儘管換行在 HTML 中的實際意義不是很大，但適當地使用換行可以使 HTML 易讀且美觀。PHP 會在輸出時自動刪除其結束符號 ?> 後的一個換行。該功能主要是針對在一個頁面中嵌入多段 PHP 代碼或者包含了無實質性輸出的 PHP 文件而設計，與此同時也造成了一些疑惑。如果在 PHP 結束符 ?> 後輸出換行的話，可以在其後加一個空格，或者在最後的一個 echo/print 語句中加入一個換行。

Note: 關於文字編輯器 市場上有許多可以用來建立、編寫或管理 PHP 檔案的文字編輯器和整合式開發環境 (IDEs)。部份的這些工具可在 » PHP 編輯器清單裡找到。若您想推薦某個編輯器，請向上述網站的負責人提出要求。一個擁有語法分色顯示 (syntax highlighting) 的編輯器對程式的編輯將提供很大的幫助。

Note: 關於文字處理器 文字處理器如 StarOffice Writer，Microsoft Word 及 Abiword 並不適合用來編輯 PHP 檔案。如果您還是想用上述文字處理器來編輯 PHP 程式，請務必將檔案儲存成純文字檔，否則 PHP 將無法讀取和執行該檔案。

Note: 關於 Windows 的記事本 如果您使用 Windows 的記事本﹝Notepad﹞，請在儲存時將副檔名改為 .php。為了防止記事本在儲存時自動加上 .txt 副檔名，您可以在儲存檔案時在檔名前後加上雙引號﹝如："hello.php"﹞，或在存檔對話方視窗的存檔類型項選"所有的檔案"，然後輸入檔名，這樣就不需要雙引號了。

您已成功的建立了一個 PHP 程式。現在該是我們建立一個最廣為人知的 PHP 腳本的時候了！在您的程式呼叫 phpinfo() 後，您將會看到許多非常有用的資訊，包括您的伺服器環境，PHP 的設定情況，如可用的預設變數，已載入的 PHP 模組及組態的設定等。您不妨花些時間去認識一下這些重要的訊息。

一個有實際用途的程式

現在讓我們來編寫一個具有實際用途的程式，用它來識別拜訪者所使用的瀏覽器種類。識別瀏覽器的方法是檢查瀏覽器傳遞給伺服器的 user agent 字串。此字串是 HTTP 要求的一部份，而它的資訊是以變數的形式儲存。PHP 的變數是以一個錢字符號（$）為開端，而現在我們要的變數是 $_SERVER["HTTP_USER_AGENT"]。

Note: $_SERVER 是一個特別的 PHP 保留變數，包含所有網頁伺服器的資訊。它被稱為 超全域變數（superglobal），它含有網頁伺服器的所有資訊。參閱手冊中superglobal這些特別的變數是在 PHP » 4.1.0 版本起才加入的。在此版本之前，我們使用的是舊式的 $HTTP_*_VARS 陣列，如 $HTTP_SERVER_VARS。雖然它們已廢棄不用，但仍舊存在。請順便參考一下舊程式碼的注意事項。

顯示此變數，我們可以使用下列程式碼：

Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1)
     

PHP 擁有許多不同型別的變數，而上述例子中，我們只不過列印出了陣列的其中一個元素。

$_SERVER 只是其中一個 PHP 自動提供給您的變數。詳細清單請查看手冊中保留的變數一節，或藉由之前章節中範例的phpinfo() 函式輸出取得完整的列表。

當然，您可以在一個 PHP 標籤裡編寫多行、功能不同的 PHP 敘述，組合成為一個程式區塊。例如，我們要檢查造訪者的瀏覽器是否是 Internet Explorer，我們可以用：

You are using Internet Explorer.<br />

      

在此，我們介紹了一個新的概念，使用了 if 敘述。如果您熟悉 C 的基本語法，那麼您就不會對它感到陌生了。若您對 C 語言或任何其他程式語言沒有任何認識的話，或許您應該先參考一些 PHP 入門書籍或閱讀此手冊的語法參考一節。

我們介紹的第二個概念：strpos() 函式的使用。strpos() 是 PHP 提供的其中一個函式，而它的功能是在一個字串中找尋另一個字串。如，我們要在 $_SERVER["HTTP_USER_AGENT"] （稱為 haystack）中尋找 "MSIE" （稱為 needle）這一字串。如果找到該字串，此函式傳回從 haystack 開始算起 needle 的相對位置，否則就傳回 FALSE。如果不是傳回 FALSE，那麼 if 敘述的評估值將是 TRUE，然後 { 大括號 } 裡的程式碼也就被執行了。相反的，若 if 的評估值是 FALSE，那 if 敘述就被跳過了。請嘗試使用 if，else，或其他函式如 strtoupper() 及 strlen() 來建立類似的程式。如果您不知如何使用某函式，請參閱其手冊。每一個函式的手冊都有範例和說明。此外，PHP 手冊中的如何閱讀函式定義和 PHP 函式也有助於對 PHP 語法的了解。

接下來我們將示範如何在 PHP 程式區塊中進入和跳離 PHP 模式。

<h3>strpos() must have returned non-false</h3>
<p>You are using Internet Explorer</p>

      

除了可以使用 echo 敘述輸出字串，我們也可以跳離 PHP 模式而直接以 HTML 輸出文字。使用這種方法的重大意義在於程式本身的邏輯並不受到影響，而哪一個 HTML 區塊會被輸出還是取決於 strpos() 所傳回的值，即有否找到 MSIE 這一字串。

處理表單

PHP 最強大的功能之一是它對 HTML 表單的處理能力。HTML 表單所傳回的所有項目將自動的提供給您的程式使用。更多使用表單的範例可參考來自 PHP 以外的變數一章。下面是 HTML 表單的範例：

<form action="action.php" method="post">
 <p>Your name: <input type="text" name="name" /></p>
 <p>Your age: <input type="text" name="age" /></p>
 <p><input type="submit" /></p>
</form>

這只是一個普通的 HTML 表單。它並不包含任何特別的標籤。當使用者填好表格，按下提交鍵後，表單中的所有資料將傳給 action.php，而此檔案則有下列的內容：

Hi Joe. You are 22 years old.

      

除了 htmlspecialchars() 和 (int)的部分之外，應該很明白這個程式做了什麼。htmlspecialchars()確定 html 中特殊字元被編碼，所以其他人無法在您的網頁放入 HTML 標籤或是 Javascript。關於 age 那一欄，我們知道它是一個數值，所以可以用convert來去除任何不正確的字元。也可以使用filter擴充功能讓 PHP 自動做這些事。PHP 自動的為您設定了 $_POST["name"] 和 $_POST["age"] 兩個變數。之前，我們使用過 $_SERVER 這個 superglobal，而上述例子則為您介紹了含有所有 POST 資料的 $_POST autoglobal。請留意我們表單所使用的方法（method）是 POST。如果我們剛才使用的是 GET，那所有的表單資料將存在 $_GET 這個 superglobal 裡了。若您不想理會表單使用了哪一種方法，那您可以改為使用 $_REQUEST 這個 autoglobal。它包含了所有 GET、POST、COOKIE 和 FILE 的資料。請參考 import_request_variables() 函式。

也可以在 PHP 中處理 XForms 的輸入，儘管可能更喜歡使用長久以來支援良好的 HTML 表單。XForms 目前還不適合初學者使用，但是您可能對它感興趣。手冊中在「特點」有章節對如何處理從 XForum 接收到的資料進行了簡短的介紹。

在新版本的 PHP 中使用舊程式碼

隨著 PHP 的日益普及，在網際網路上已有許多程式碼可供下載使用於您的程式中。PHP 的開發人員已盡量使得新版本的 PHP 能回溯相容（backward compatible），所以一般上在新版本的 PHP 中運行舊版下開發的 PHP 程式是不會有問題的。但事實上某些更改還是需要的。

近期兩個影響舊程式碼最大的更改是：

• $HTTP_*_VARS 式的陳列被取代（以往在函式或方法中使用它時必須指明它為全域）。下列新的 superglobal 陳列在 PHP » 4.1.0 版開始推出：$_GET、$_POST、$_COOKIE、$_SERVER、$_FILES、$_ENV、$_REQUEST 和 $_SESSION。舊有的$HTTP_*_VARS 式的陣列如 $HTTP_POST_VARS 自 PHP 3 開始就已存在，現時仍然可以使用。 自 PHP 5.0.0 起，長格式的 PHP 預設變數陣列可以由設置 register_long_arrays 來停用。
• 來自外部的變數已不會在全域範圍裡自動為您註冊。自 PHP » 4.2.0 起，php.ini 中的 register_globals 指令已預設為 off。存取這些變數值的建議方法是透過上面介紹過的 superglobal 陣列。舊的程式、書籍或教學文章可能依賴此指令設成 on 才能正常操作。當設成 on 時，http://www.example.com/foo.php?id=42 這一 URL 中 id 的值可直接以 $id 變數取得。無論是 on 與否，您都可以使用 $_GET['id']，而且是被建議的做法。

下一步？

您現在應有足夠的知識去理解手冊中大部份的內容和所提及的範例。更多的範例可在 php.net 的網站連接區» http://www.php.net/links.php找到。

此外，PHP Conference Material Sites﹝» http://conf.php.net/ 和 » http://talks.php.net/﹞也有更多介紹 PHP 的研討會幻燈片供您瀏覽，可以看到更多 PHP 可以做什麼。

Apache 1.3.x on Unix systems

This section contains notes and hints specific to Apache installs of PHP on Unix platforms. We also have instructions and notes for Apache 2 on a separate page.

You can select arguments to add to the configure on line 10 below from the list of core configure options and from extension specific options described at the respective places in the manual. The version numbers have been omitted here, to ensure the instructions are not incorrect. You will need to replace the 'xxx' here with the correct values from your files.

1.  gunzip apache_xxx.tar.gz
2.  tar -xvf apache_xxx.tar
3.  gunzip php-xxx.tar.gz
4.  tar -xvf php-xxx.tar
5.  cd apache_xxx
6.  ./configure --prefix=/www --enable-module=so
7.  make
8.  make install
9.  cd ../php-xxx

10. Now, configure your PHP.  This is where you customize your PHP
    with various options, like which extensions will be enabled.  Do a
    ./configure --help for a list of available options.  In our example
    we'll do a simple configure with Apache 1 and MySQL support.  Your
    path to apxs may differ from our example.

      ./configure --with-mysql --with-apxs=/www/bin/apxs

11. make
12. make install

    If you decide to change your configure options after installation,
    you only need to repeat the last three steps. You only need to 
    restart apache for the new module to take effect. A recompile of
    Apache is not needed.
  
    Note that unless told otherwise, 'make install' will also install PEAR,
    various PHP tools such as phpize, install the PHP CLI, and more.

13. Setup your php.ini file:

      cp php.ini-dist /usr/local/lib/php.ini

    You may edit your .ini file to set PHP options.  If you prefer your
    php.ini in another location, use --with-config-file-path=/some/path in
    step 10. 
    
    If you instead choose php.ini-recommended, be certain to read the list
    of changes within, as they affect how PHP behaves.

14. Edit your httpd.conf to load the PHP module.  The path on the right hand
    side of the LoadModule statement must point to the path of the PHP
    module on your system.  The make install from above may have already
    added this for you, but be sure to check.
        
    For PHP 4:
            
      LoadModule php4_module libexec/libphp4.so

    For PHP 5:
                      
      LoadModule php5_module libexec/libphp5.so
      
15. And in the AddModule section of httpd.conf, somewhere under the
    ClearModuleList, add this:
    
    For PHP 4:
    
      AddModule mod_php4.c
      
    For PHP 5:
    
      AddModule mod_php5.c

16. Tell Apache to parse certain extensions as PHP.  For example,
    let's have Apache parse the .php extension as PHP.  You could
    have any extension(s) parse as PHP by simply adding more, with
    each separated by a space.  We'll add .phtml to demonstrate.

      AddType application/x-httpd-php .php .phtml

    It's also common to setup the .phps extension to show highlighted PHP
    source, this can be done with:
    
      AddType application/x-httpd-php-source .phps

17. Use your normal procedure for starting the Apache server. (You must
    stop and restart the server, not just cause the server to reload by
    using a HUP or USR1 signal.)

     

Alternatively, to install PHP as a static object:

1.  gunzip -c apache_1.3.x.tar.gz | tar xf -
2.  cd apache_1.3.x
3.  ./configure
4.  cd ..

5.  gunzip -c php-5.x.y.tar.gz | tar xf -
6.  cd php-5.x.y
7.  ./configure --with-mysql --with-apache=../apache_1.3.x
8.  make
9.  make install

10. cd ../apache_1.3.x

11. ./configure --prefix=/www --activate-module=src/modules/php5/libphp5.a
    (The above line is correct! Yes, we know libphp5.a does not exist at this
    stage. It isn't supposed to. It will be created.)

12. make
    (you should now have an httpd binary which you can copy to your Apache bin dir if
    it is your first install then you need to "make install" as well)

13. cd ../php-5.x.y
14. cp php.ini-dist /usr/local/lib/php.ini

15. You can edit /usr/local/lib/php.ini file to set PHP options.
    Edit your httpd.conf or srm.conf file and add:
    AddType application/x-httpd-php .php

      

Note: Replace php-5 by php-4 and php5 by php4 in PHP 4.

Depending on your Apache install and Unix variant, there are many possible ways to stop and restart the server. Below are some typical lines used in restarting the server, for different apache/unix installations. You should replace /path/to/ with the path to these applications on your systems.

1. Several Linux and SysV variants:
/etc/rc.d/init.d/httpd restart

2. Using apachectl scripts:
/path/to/apachectl stop
/path/to/apachectl start

3. httpdctl and httpsdctl (Using OpenSSL), similar to apachectl:
/path/to/httpsdctl stop
/path/to/httpsdctl start

4. Using mod_ssl, or another SSL server, you may want to manually
stop and start:
/path/to/apachectl stop
/path/to/apachectl startssl

The locations of the apachectl and http(s)dctl binaries often vary. If your system has locate or whereis or which commands, these can assist you in finding your server control programs.

Different examples of compiling PHP for apache are as follows:

./configure --with-apxs --with-pgsql

This will create a libphp5.so (or libphp4.so in PHP 4) shared library that is loaded into Apache using a LoadModule line in Apache's httpd.conf file. The PostgreSQL support is embedded into this library.

./configure --with-apxs --with-pgsql=shared

This will create a libphp4.so shared library for Apache, but it will also create a pgsql.so shared library that is loaded into PHP either by using the extension directive in php.ini file or by loading it explicitly in a script using the dl() function.

./configure --with-apache=/path/to/apache_source --with-pgsql

This will create a libmodphp5.a library, a mod_php5.c and some accompanying files and copy this into the src/modules/php5 directory in the Apache source tree. Then you compile Apache using --activate-module=src/modules/php5/libphp5.a and the Apache build system will create libphp5.a and link it statically into the httpd binary (replace php5 by php4 in PHP 4). The PostgreSQL support is included directly into this httpd binary, so the final result here is a single httpd binary that includes all of Apache and all of PHP.

./configure --with-apache=/path/to/apache_source --with-pgsql=shared

Same as before, except instead of including PostgreSQL support directly into the final httpd you will get a pgsql.so shared library that you can load into PHP from either the php.ini file or directly using dl().

When choosing to build PHP in different ways, you should consider the advantages and drawbacks of each method. Building as a shared object will mean that you can compile apache separately, and don't have to recompile everything as you add to, or change, PHP. Building PHP into apache (static method) means that PHP will load and run faster. For more information, see the Apache » web page on DSO support.

Note: Apache's default httpd.conf currently ships with a section that looks like this:

User nobody
Group "#-1"

Unless you change that to "Group nogroup" or something like that ("Group daemon" is also very common) PHP will not be able to open files.

Note: Make sure you specify the installed version of apxs when using --with-apxs=/path/to/apxs. You must NOT use the apxs version that is in the apache sources but the one that is actually installed on your system.

Apache 2.0 on Unix systems

This section contains notes and hints specific to Apache 2.0 installs of PHP on Unix systems.

You are highly encouraged to take a look at the » Apache Documentation to get a basic understanding of the Apache 2.0 Server.

Note: PHP and Apache 2.0.x compatibility notes The following versions of PHP are known to work with the most recent version of Apache 2.0.x:

• PHP 4.3.0 or later available at » http://www.php.net/downloads.php.
• the latest stable development version. Get the source code » http://snaps.php.net/php5-latest.tar.gz or download binaries for Windows » http://snaps.php.net/win32/php5-win32-latest.zip.
• a prerelease version downloadable from » http://qa.php.net/.
• you have always the option to obtain PHP through » anonymous CVS.

These versions of PHP are compatible to Apache 2.0.40 and later.
Apache 2.0 SAPI-support started with PHP 4.2.0. PHP 4.2.3 works with Apache 2.0.39, don't use any other version of Apache with PHP 4.2.3. However, the recommended setup is to use PHP 4.3.0 or later with the most recent version of Apache2.
All mentioned versions of PHP will work still with Apache 1.3.x.

Download the most recent version of » Apache 2.0 and a fitting PHP version from the above mentioned places. This quick guide covers only the basics to get started with Apache 2.0 and PHP. For more information read the » Apache Documentation. The version numbers have been omitted here, to ensure the instructions are not incorrect. You will need to replace the 'NN' here with the correct values from your files.

1.  gzip -d httpd-2_0_NN.tar.gz
2.  tar xvf httpd-2_0_NN.tar
3.  gunzip php-NN.tar.gz
4.  tar -xvf php-NN.tar
5.  cd httpd-2_0_NN
6.  ./configure --enable-so
7.  make
8.  make install

    Now you have Apache 2.0.NN available under /usr/local/apache2,
    configured with loadable module support and the standard MPM prefork.
    To test the installation use your normal procedure for starting
    the Apache server, e.g.:
    /usr/local/apache2/bin/apachectl start
    and stop the server to go on with the configuration for PHP:
    /usr/local/apache2/bin/apachectl stop.

9.  cd ../php-NN

10. Now, configure your PHP.  This is where you customize your PHP
    with various options, like which extensions will be enabled.  Do a
    ./configure --help for a list of available options.  In our example
    we'll do a simple configure with Apache 2 and MySQL support.  Your
    path to apxs may differ, in fact, the binary may even be named apxs2 on
    your system. 
    
      ./configure --with-apxs2=/usr/local/apache2/bin/apxs --with-mysql

11. make
12. make install

    If you decide to change your configure options after installation,
    you only need to repeat the last three steps. You only need to
    restart apache for the new module to take effect. A recompile of
    Apache is not needed.
                
    Note that unless told otherwise, 'make install' will also install PEAR,
    various PHP tools such as phpize, install the PHP CLI, and more.
    
13. Setup your php.ini 
    
    cp php.ini-dist /usr/local/lib/php.ini
          
    You may edit your .ini file to set PHP options.  If you prefer having
    php.ini in another location, use --with-config-file-path=/some/path in
    step 10.
    
    If you instead choose php.ini-recommended, be certain to read the list
    of changes within, as they affect how PHP behaves.

14. Edit your httpd.conf to load the PHP module.  The path on the right hand
    side of the LoadModule statement must point to the path of the PHP
    module on your system.  The make install from above may have already
    added this for you, but be sure to check.

    For PHP 4:
  
      LoadModule php4_module modules/libphp4.so
      
    For PHP 5:
    
      LoadModule php5_module modules/libphp5.so
 
15. Tell Apache to parse certain extensions as PHP.  For example,
    let's have Apache parse the .php extension as PHP.  You could
    have any extension(s) parse as PHP by simply adding more, with
    each separated by a space.  We'll add .phtml to demonstrate.
            
      AddType application/x-httpd-php .php .phtml
                  
    It's also common to setup the .phps extension to show highlighted PHP
    source, this can be done with:
    
      AddType application/x-httpd-php-source .phps
 
16. Use your normal procedure for starting the Apache server, e.g.:
   
      /usr/local/apache2/bin/apachectl start
   


      

Following the steps above you will have a running Apache 2.0 with support for PHP as SAPI module. Of course there are many more configuration options available for both, Apache and PHP. For more information use ./configure --help in the corresponding source tree. In case you wish to build a multithreaded version of Apache 2.0 you must overwrite the standard MPM-Module prefork either with worker or perchild. To do so append to your configure line in step 6 above either the option --with-mpm=worker or --with-mpm=perchild. Take care about the consequences and understand what you are doing. For more information read the Apache documentation about the » MPM-Modules.

Note: If you want to use content negotiation, read the Apache MultiViews FAQ.

Note: To build a multithreaded version of Apache your system must support threads. This also implies to build PHP with experimental Zend Thread Safety (ZTS). Therefore not all extensions might be available. The recommended setup is to build Apache with the standard prefork MPM-Module.

Caudium

PHP 4 can be built as a Pike module for the » Caudium webserver. Note that this is not supported with PHP 3. Follow the simple instructions below to install PHP 4 for Caudium.

1.  Make sure you have Caudium installed prior to attempting to
    install PHP 4. For PHP 4 to work correctly, you will need Pike
    7.0.268 or newer. For the sake of this example we assume that
    Caudium is installed in /opt/caudium/server/.
2.  Change directory to php-x.y.z (where x.y.z is the version number).
3.  ./configure --with-caudium=/opt/caudium/server
4.  make
5.  make install
6.  Restart Caudium if it's currently running.
7.  Log into the graphical configuration interface and go to the
    virtual server where you want to add PHP 4 support.
8.  Click Add Module and locate and then add the PHP 4 Script Support module.
9.  If the documentation says that the 'PHP 4 interpreter isn't
    available', make sure that you restarted the server. If you did
    check /opt/caudium/logs/debug/default.1 for any errors related to
    <filename>PHP4.so</filename>. Also make sure that 
    <filename>caudium/server/lib/[pike-version]/PHP4.so</filename>
    is present.
10. Configure the PHP Script Support module if needed.

    

You can of course compile your Caudium module with support for the various extensions available in PHP 4. See the reference pages for extension specific configure options.

Note: When compiling PHP 4 with MySQL support you must make sure that the normal MySQL client code is used. Otherwise there might be conflicts if your Pike already has MySQL support. You do this by specifying a MySQL install directory the --with-mysql option.

fhttpd related notes

To build PHP as an fhttpd module, answer "yes" to "Build as an fhttpd module?" (the --with-fhttpd=DIR option to configure) and specify the fhttpd source base directory. The default directory is /usr/local/src/fhttpd. If you are running fhttpd, building PHP as a module will give better performance, more control and remote execution capability.

Note: Support for fhttpd is no longer available as of PHP 4.3.0.

Sun, iPlanet and Netscape servers on Sun Solaris

This section contains notes and hints specific to Sun Java System Web Server, Sun ONE Web Server, iPlanet and Netscape server installs of PHP on Sun Solaris.

From PHP 4.3.3 on you can use PHP scripts with the NSAPI module to generate custom directory listings and error pages. Additional functions for Apache compatibility are also available. For support in current web servers read the note about subrequests.

You can find more information about setting up PHP for the Netscape Enterprise Server (NES) here: » http://benoit.noss.free.fr/php/install-php4.html

To build PHP with Sun JSWS/Sun ONE WS/iPlanet/Netscape web servers, enter the proper install directory for the --with-nsapi=[DIR] option. The default directory is usually /opt/netscape/suitespot/. Please also read /php-xxx-version/sapi/nsapi/nsapi-readme.txt.

1. Install the following packages from » http://www.sunfreeware.com/ or another download site:

   • autoconf-2.13
   • automake-1.4
   • bison-1_25-sol26-sparc-local
   • flex-2_5_4a-sol26-sparc-local
   • gcc-2_95_2-sol26-sparc-local
   • gzip-1.2.4-sol26-sparc-local
   • m4-1_4-sol26-sparc-local
   • make-3_76_1-sol26-sparc-local
   • mysql-3.23.24-beta (if you want mysql support)
   • perl-5_005_03-sol26-sparc-local
   • tar-1.13 (GNU tar)

2. Make sure your path includes the proper directories PATH=.:/usr/local/bin:/usr/sbin:/usr/bin:/usr/ccs/bin and make it available to your system export PATH .
3. gunzip php-x.x.x.tar.gz (if you have a .gz dist, otherwise go to 4).
4. tar xvf php-x.x.x.tar
5. Change to your extracted PHP directory: cd ../php-x.x.x

6. For the following step, make sure /opt/netscape/suitespot/ is where your netscape server is installed. Otherwise, change to the correct path and run:

   ./configure --with-mysql=/usr/local/mysql \
   --with-nsapi=/opt/netscape/suitespot/ \
   --enable-libgcc
   

7. Run make followed by make install.

After performing the base install and reading the appropriate readme file, you may need to perform some additional configuration steps.

Configuration Instructions for Sun/iPlanet/Netscape

Firstly you may need to add some paths to the LD_LIBRARY_PATH environment for the server to find all the shared libs. This can best done in the start script for your web server. The start script is often located in: /path/to/server/https-servername/start. You may also need to edit the configuration files that are located in: /path/to/server/https-servername/config/.

1. Add the following line to mime.types (you can do that by the administration server):

   type=magnus-internal/x-httpd-php exts=php
   
            

2. Edit magnus.conf (for servers >= 6) or obj.conf (for servers < 6) and add the following, shlib will vary depending on your system, it will be something like /opt/netscape/suitespot/bin/libphp4.so. You should place the following lines after mime types init.

   Init fn="load-modules" funcs="php4_init,php4_execute,php4_auth_trans" shlib="/opt/netscape/suitespot/bin/libphp4.so"
   Init fn="php4_init" LateInit="yes" errorString="Failed to initialize PHP!" [php_ini="/path/to/php.ini"]
   

   (PHP >= 4.3.3) The php_ini parameter is optional but with it you can place your php.ini in your web server config directory.

3. Configure the default object in obj.conf (for virtual server classes [version 6.0+] in their vserver.obj.conf):

   <Object name="default">
   .
   .
   .
   .#NOTE this next line should happen after all 'ObjectType' and before all 'AddLog' lines
   Service fn="php4_execute" type="magnus-internal/x-httpd-php" [inikey=value inikey=value ...]
   .
   .
   </Object>
   

   (PHP >= 4.3.3) As additional parameters you can add some special php.ini-values, for example you can set a docroot="/path/to/docroot" specific to the context php4_execute is called. For boolean ini-keys please use 0/1 as value, not "On","Off",... (this will not work correctly), e.g. zlib.output_compression=1 instead of zlib.output_compression="On"

4. This is only needed if you want to configure a directory that only consists of PHP scripts (same like a cgi-bin directory):

   <Object name="x-httpd-php">
   ObjectType fn="force-type" type="magnus-internal/x-httpd-php"
   Service fn=php4_execute [inikey=value inikey=value ...]
   </Object>
   

   After that you can configure a directory in the Administration server and assign it the style x-httpd-php. All files in it will get executed as PHP. This is nice to hide PHP usage by renaming files to .html.

5. Setup of authentication: PHP authentication cannot be used with any other authentication. ALL AUTHENTICATION IS PASSED TO YOUR PHP SCRIPT. To configure PHP Authentication for the entire server, add the following line to your default object:

   <Object name="default">
   AuthTrans fn=php4_auth_trans
   .
   .
   .
   </Object>
   

6. To use PHP Authentication on a single directory, add the following:

   <Object ppath="d:\path\to\authenticated\dir\*">
   AuthTrans fn=php4_auth_trans
   </Object>
   

Note: The stacksize that PHP uses depends on the configuration of the web server. If you get crashes with very large PHP scripts, it is recommended to raise it with the Admin Server (in the section "MAGNUS EDITOR").

variables_order = "GPCS"
register_globals = On

Error fn="php4_execute" code=XXX script="/path/to/script.php" [inikey=value inikey=value...]

Service fn="php4_execute" type="magnus-internal/directory" script="/path/to/script.php" [inikey=value inikey=value...]

CGI and command line setups

The default is to build PHP as a CGI program. This creates a command line interpreter, which can be used for CGI processing, or for non-web-related PHP scripting. If you are running a web server PHP has module support for, you should generally go for that solution for performance reasons. However, the CGI version enables users to run different PHP-enabled pages under different user-ids.

As of PHP 4.3.0, some important additions have happened to PHP. A new SAPI named CLI also exists and it has the same name as the CGI binary. What is installed at {PREFIX}/bin/php depends on your configure line and this is described in detail in the manual section named Using PHP from the command line. For further details please read that section of the manual.

HP-UX specific installation notes

This section contains notes and hints specific to installing PHP on HP-UX systems.

There are two main options for installing PHP on HP-UX systems. Either compile it, or install a pre-compiled binary.

Official pre-compiled packages are located here: » http://software.hp.com/

Until this manual section is rewritten, the documentation about compiling PHP (and related extensions) on HP-UX systems has been removed. For now, consider reading the following external resource: » Building Apache and PHP on HP-UX 11.11

OpenBSD installation notes

This section contains notes and hints specific to installing PHP on » OpenBSD 3.6.

# pkg_add php4-core-4.3.8.tgz
# /usr/local/sbin/phpxs -s
# cp /usr/local/share/doc/php4/php.ini-recommended /var/www/conf/php.ini
  (add in mysql)
# pkg_add php4-mysql-4.3.8.tgz
# /usr/local/sbin/phpxs -a mysql
  (add in imap)
# pkg_add php4-imap-4.3.8.tgz
# /usr/local/sbin/phpxs -a imap
  (remove mysql as a test)
# pkg_delete php4-mysql-4.3.8
# /usr/local/sbin/phpxs -r mysql
  (install the PEAR libraries)
# pkg_add php4-pear-4.3.8.tgz

Solaris specific installation tips

This section contains notes and hints specific to installing PHP on Solaris systems.

Debian GNU/Linux installation notes

This section contains notes and hints specific to installing PHP on » Debian GNU/Linux.

deb http://packages.dotdeb.org stable all
deb-src http://packages.dotdeb.org stable all

# apt-get install libapache-mod-php4

# /etc/init.d/apache stop
# /etc/init.d/apache start

# dpkg -l 'php4-*'

# apt-get install php4-mysql php4-curl php4-gd

extension=mysql.so
extension=curl.so
extension=gd.so

Using Packages

There are a few pre-packaged and pre-compiled versions of PHP for Mac OS X. This can help in setting up a standard configuration, but if you need to have a different set of features (such as a secure server, or a different database driver), you may need to build PHP and/or your web server yourself. If you are unfamiliar with building and compiling your own software, it's worth checking whether somebody has already built a packaged version of PHP with the features you need.

The following resources offer easy to install packages and precompiled binaries for PHP on Mac OS:

• MacPorts: » http://www.macports.org/
• Entropy: » http://www.entropy.ch/software/macosx/php/
• Fink: » http://fink.sourceforge.net/

Using the bundled PHP

PHP has come standard with Macs since OS X version 10.0.0. Enabling PHP with the default web server requires uncommenting a few lines in the Apache configuration file httpd.conf whereas the CGI and/or CLI are enabled by default (easily accessible via the Terminal program).

Enabling PHP using the instructions below is meant for quickly setting up a local development environment. It's highly recommended to always upgrade PHP to the newest version. Like most live software, newer versions are created to fix bugs and add features and PHP being is no different. See the appropriate MAC OS X installation documentation for further details. The following instructions are geared towards a beginner with details provided for getting a default setup to work. All users are encouraged to compile, or install a new packaged version.

The standard installation type is using mod_php, and enabling the bundled mod_php on Mac OS X for the Apache web server (the default web server, that is accessible via System Preferences) involves the following steps:

1. Locate and open the Apache configuration file. By default, the location is as follows: /etc/httpd/httpd.conf Using Finder or Spotlight to find this file may prove difficult as by default it's private and owned by the root user.

   Note: One way to open this is by using a Unix based text editor in the Terminal, for example nano, and because the file is owned by root we'll use the sudo command to open it (as root) so for example type the following into the Terminal Application (after, it will prompt for a password): sudo nano /etc/httpd/httpd.conf Noteworthy nano commands: ^w (search), ^o (save), and ^x (exit) where ^ represents the Ctrl key.

2. With a text editor, uncomment the lines (by removing the #) that look similar to the following (these two lines are often not together, locate them both in the file):

   # LoadModule php4_module libexec/httpd/libphp4.so
   
   # AddModule mod_php4.c
   
        

   Notice the location/path. When building PHP in the future, the above files should be replaced or commented out.

3. Be sure the desired extensions will parse as PHP (examples: .php .html and .inc)

   Due to the following statement already existing in httpd.conf (as of Mac Panther), once PHP is enabled the .php files will automatically parse as PHP.

   <IfModule mod_php4.c>
       # If php is turned on, we respect .php and .phps files.
       AddType application/x-httpd-php .php
       AddType application/x-httpd-php-source .phps
   
       # Since most users will want index.php to work we
       # also automatically enable index.php
       <IfModule mod_dir.c>
           DirectoryIndex index.html index.php
       </IfModule>
   </IfModule>
   
        

4. Be sure the DirectoryIndex loads the desired default index file This is also set in httpd.conf. Typically index.php and index.html are used. By default index.php is enabled because it's also in the PHP check shown above. Adjust accordingly.
5. Set the php.ini location or use the default A typical default location on Mac OS X is /usr/local/php/php.ini and a call to phpinfo() will reveal this information. If a php.ini is not used, PHP will use all default values. See also the related FAQ on finding php.ini.
6. Locate or set the DocumentRoot This is the root directory for all the web files. Files in this directory are served from the web server so the PHP files will parse as PHP before outputting them to the browser. A typical default path is /Library/WebServer/Documents but this can be set to anything in httpd.conf. Alternatively, the default DocumentRoot for individual users is /Users/yourusername/Sites
7. Create a phpinfo() file

   The phpinfo() function will display information about PHP. Consider creating a file in the DocumentRoot with the following PHP code:

   <?php phpinfo(); ?>

8. Restart Apache, and load the PHP file created above To restart, either execute sudo apachectl graceful in the shell or stop/start the "Personal Web Server" option in the OS X System Preferences. By default, loading local files in the browser will have an URL like so: http://localhost/info.php Or using the DocumentRoot in the user directory is another option and would end up looking like: http://localhost/~yourusername/info.php

The CLI (or CGI in older versions) is appropriately named php and likely exists as /usr/bin/php. Open up the terminal, read the command line section of the PHP manual, and execute php -v to check the PHP version of this PHP binary. A call to phpinfo() will also reveal this information.

Compiling for OS X Server

Mac OS X Server install

1. Get the latest distributions of Apache and PHP.

2. Untar them, and run the configure program on Apache like so.

   ./configure --exec-prefix=/usr \
   --localstatedir=/var \
   --mandir=/usr/share/man \
   --libexecdir=/System/Library/Apache/Modules \
   --iconsdir=/System/Library/Apache/Icons \
   --includedir=/System/Library/Frameworks/Apache.framework/Versions/1.3/Headers \
   --enable-shared=max \
   --enable-module=most \
   --target=apache
   

3. If you want the compiler to do some optimization, you may also want to add this line:

   setenv OPTIM=-O2
   

4. Next, go to the PHP 4 source directory and configure it.

   ./configure --prefix=/usr \
       --sysconfdir=/etc \
       --localstatedir=/var \
       --mandir=/usr/share/man \
       --with-xml \
       --with-apache=/src/apache_1.3.12
   

   If you have any other additions (MySQL, GD, etc.), be sure to add them here. For the --with-apache string, put in the path to your apache source directory, for example /src/apache_1.3.12.

5. Type make and make install. This will add a directory to your Apache source directory under src/modules/php4.

6. Now, reconfigure Apache to build in PHP 4.

   ./configure --exec-prefix=/usr \
   --localstatedir=/var \
   --mandir=/usr/share/man \
   --libexecdir=/System/Library/Apache/Modules \
   --iconsdir=/System/Library/Apache/Icons \
   --includedir=/System/Library/Frameworks/Apache.framework/Versions/1.3/Headers \
   --enable-shared=max \
   --enable-module=most \
   --target=apache \
   --activate-module=src/modules/php4/libphp4.a
   

   You may get a message telling you that libmodphp4.a is out of date. If so, go to the src/modules/php4 directory inside your Apache source directory and run this command: ranlib libmodphp4.a. Then go back to the root of the Apache source directory and run the above configure command again. That'll bring the link table up to date. Run make and make install again.

7. Copy and rename the php.ini-dist file to your bin directory from your PHP 4 source directory: cp php.ini-dist /usr/local/bin/php.ini or (if your don't have a local directory) cp php.ini-dist /usr/bin/php.ini .

Compiling for MacOS X Client

The following instructions will help you install a PHP module for the Apache web server included in MacOS X. This version includes support for the MySQL and PostgreSQL databases. These instructions are graciously provided by » Marc Liyanage.

Do this to install:

1. Open a terminal window.
2. Type wget http://www.diax.ch/users/liyanage/software/macosx/libphp4.so.gz , wait for the download to finish.
3. Type gunzip libphp4.so.gz .
4. Type sudo apxs -i -a -n php4 libphp4.so

5. Now type sudo open -a TextEdit /etc/httpd/httpd.conf . TextEdit will open with the web server configuration file. Locate these two lines towards the end of the file: (Use the Find command)

   #AddType application/x-httpd-php .php 
   #AddType application/x-httpd-php-source .phps
   

   Remove the two hash marks (#), then save the file and quit TextEdit.

6. Finally, type sudo apachectl graceful to restart the web server.

PHP should now be up and running. You can test it by dropping a file into your Sites folder which is called test.php. Into that file, write this line: <?php phpinfo() ?>.

Now open up 127.0.0.1/~your_username/test.php in your web browser. You should see a status table with information about the PHP module.

Windows Installer (PHP 5.2 and later)

The Windows PHP installer for later versions of PHP is built using MSI technology using the Wix Toolkit (» http://wix.sourceforge.net/). It will install and configure PHP and all the built-in and PECL extensions, as well as configure many of the popular web servers such as IIS, Apache, and Xitami.

First, install your selected HTTP (web) server on your system, and make sure that it works. Then proceed with one of the following install types.

       
msiexec.exe /i php-VERSION-win32-install.msi /q
     
      

       
msiexec.exe /i php-VERSION-win32-install.msi /q INSTALLDIR=e:\php
     
      

       
msiexec.exe /i php-VERSION-win32-install.msi /q ADDLOCAL=cgi,ext_php_mysqli
     
      

 
MainExecutable - php.exe executable
ScriptExecutable - php-win.exe executable
ext_php_* - the various extensions ( for example: ext_php_mysql for MySQL )
apache13 - Apache 1.3 module
apache20 - Apache 2.0 module
apache22 - Apache 2,2 module
apacheCGI - Apache CGI executable
iis4ISAPI - IIS ISAPI module
iis4CGI - IIS CGI executable
NSAPI - Sun/iPlanet/Netscape server module
Xitami - Xitami CGI executable
Sambar - Sambar Server ISAPI module
CGI - php-cgi.exe executable
PEAR - PEAR installer
Manual - PHP Manual in CHM Format

      

Windows Installer (PHP 5.1.0 and earlier)

The Windows PHP installer is available from the downloads page at » http://www.php.net/downloads.php. This installs the CGI version of PHP and for IIS, PWS, and Xitami, it configures the web server as well. The installer does not include any extra external PHP extensions (php_*.dll) as you'll only find those in the Windows Zip Package and PECL downloads.

Note: While the Windows installer is an easy way to make PHP work, it is restricted in many aspects as, for example, the automatic setup of extensions is not supported. Use of the installer isn't the preferred method for installing PHP.

First, install your selected HTTP (web) server on your system, and make sure that it works.

Run the executable installer and follow the instructions provided by the installation wizard. Two types of installation are supported - standard, which provides sensible defaults for all the settings it can, and advanced, which asks questions as it goes along.

The installation wizard gathers enough information to set up the php.ini file, and configure certain web servers to use PHP. One of the web servers the PHP installer does not configure for is Apache, so you'll need to configure it manually.

Once the installation has completed, the installer will inform you if you need to restart your system, restart the server, or just start using PHP.

Manual Installation Steps

This install guide will help you manually install and configure PHP with a web server on Microsoft Windows. To get started you'll need to download the zip binary distribution from the downloads page at » http://www.php.net/downloads.php.

Although there are many all-in-one installation kits, and we also distribute a PHP installer for Microsoft Windows, we recommend you take the time to setup PHP yourself as this will provide you with a better understanding of the system, and enables you to install PHP extensions easily when needed.

Note: Upgrading from a previous PHP version Previous editions of the manual suggest moving various ini and DLL files into your SYSTEM (i.e. C:\WINDOWS) folder and while this simplifies the installation procedure it makes upgrading difficult. We advise you remove all of these files (like php.ini and PHP related DLLs from the Windows SYSTEM folder) before moving on with a new PHP installation. Be sure to backup these files as you might break the entire system. The old php.ini might be useful in setting up the new PHP as well. And as you'll soon learn, the preferred method for installing PHP is to keep all PHP related files in one directory and have this directory available to your systems PATH.

Note: MDAC requirements If you use Microsoft Windows 98/NT4 download the latest version of the Microsoft Data Access Components (MDAC) for your platform. MDAC is available at » http://msdn.microsoft.com/data/. This requirement exists because ODBC is built into the distributed Windows binaries.

The following steps should be completed on all installations before any server specific instructions are performed:

Extract the distribution file into a directory of your choice. If you are installing PHP 4, extract to C:\, as the zip file expands to a foldername like php-4.3.7-Win32. If you are installing PHP 5, extract to C:\php as the zip file doesn't expand as in PHP 4. You may choose a different location but do not have spaces in the path (like C:\Program Files\PHP) as some web servers will crash if you do.

The directory structure extracted from the zip is different for PHP versions 4 and 5 and look like as follows:

c:\php
   |
   +--cli
   |  |
   |  |-php.exe           -- CLI executable - ONLY for command line scripting
   |
   +--dlls                -- support DLLs required by some extensions
   |  |
   |  |-expat.dll
   |  |
   |  |-fdftk.dll
   |  |
   |  |-...
   |
   +--extensions          -- extension DLLs for PHP
   |  |
   |  |-php_bz2.dll
   |  |
   |  |-php_cpdf.dll
   |  |
   |  |-..
   |
   +--mibs                -- support files for SNMP
   |
   +--openssl             -- support files for Openssl
   |
   +--pdf-related         -- support files for PDF
   |
   +--sapi                -- SAPI (server module support) DLLs
   |  |
   |  |-php4apache.dll
   |  |
   |  |-php4apache2.dll
   |  |
   |  |-..
   |
   +--PEAR                -- initial copy of PEAR
   |
   |
   |-go-pear.bat          -- PEAR setup script
   |
   |-..
   |
   |-php.exe              -- CGI executable
   |
   |-..
   |
   |-php.ini-dist         -- default php.ini settings
   |
   |-php.ini-recommended  -- recommended php.ini settings
   | 
   |-php4ts.dll           -- core PHP DLL
   | 
   |-...

Or:

c:\php
   |
   +--dev
   |  |
   |  |-php5ts.lib
   |
   +--ext                 -- extension DLLs for PHP
   |  |
   |  |-php_bz2.dll
   |  |
   |  |-php_cpdf.dll
   |  |
   |  |-..
   |
   +--extras
   |  |
   |  +--mibs             -- support files for SNMP
   |  |
   |  +--openssl          -- support files for Openssl
   |  |
   |  +--pdf-related      -- support files for PDF
   |  |
   |  |-mime.magic
   |
   +--pear                -- initial copy of PEAR
   |
   |
   |-go-pear.bat          -- PEAR setup script
   |
   |-fdftk.dll
   |
   |-..
   |
   |-php-cgi.exe          -- CGI executable
   |
   |-php-win.exe          -- executes scripts without an opened command prompt
   |
   |-php.exe              -- CLI executable - ONLY for command line scripting
   |
   |-..
   |
   |-php.ini-dist         -- default php.ini settings
   |
   |-php.ini-recommended  -- recommended php.ini settings
   | 
   |-php5activescript.dll
   |
   |-php5apache.dll
   |
   |-php5apache2.dll
   |
   |-..
   |
   |-php5ts.dll           -- core PHP DLL
   | 
   |-...

Notice the differences and similarities. Both PHP 4 and PHP 5 have a CGI executable, a CLI executable, and server modules, but they are located in different folders and/or have different names. While PHP 4 packages have the server modules in the sapi folder, PHP 5 distributions have no such directory and instead they're in the PHP folder root. The supporting DLLs for the PHP 5 extensions are also not in a seperate directory.

Note: In PHP 4, you should move all files located in the dll and sapi folders to the main folder (e.g. C:\php).

Here is a list of server modules shipped with PHP 4 and PHP 5:

• sapi/php4activescript.dll (php5activescript.dll) - ActiveScript engine, allowing you to embed PHP in your Windows applications.

• sapi/php4apache.dll (php5apache.dll) - Apache 1.3.x module.

• sapi/php4apache2.dll (php5apache2.dll) - Apache 2.0.x module.

• sapi/php5apache2_2.dll - Apache 2.2.x module.

• sapi/php4isapi.dll (php5isapi.dll) - ISAPI Module for ISAPI compliant web servers like IIS 4.0/PWS 4.0 or newer.

• sapi/php4nsapi.dll (php5nsapi.dll) - Sun/iPlanet/Netscape server module.

• sapi/php4pi3web.dll (no equivalent in PHP 5) - Pi3Web server module.

Server modules provide significantly better performance and additional functionality compared to the CGI binary. The CLI version is designed to let you use PHP for command line scripting. More information about CLI is available in the chapter about using PHP from the command line.

The CGI and CLI binaries, and the web server modules all require the php4ts.dll (php5ts.dll) file to be available to them. You have to make sure that this file can be found by your PHP installation. The search order for this DLL is as follows:

• The same directory from where php.exe is called, or in case you use a SAPI module, the web server's directory (e.g. C:\Program Files\Apache Group\Apache2\bin).

• Any directory in your Windows PATH environment variable.

To make php4ts.dll / php5ts.dll available you have three options: copy the file to the Windows system directory, copy the file to the web server's directory, or add your PHP directory, C:\php to the PATH. For better maintenance, we advise you to follow the last option, add C:\php to the PATH, because it will be simpler to upgrade PHP in the future. Read more about how to add your PHP directory to PATH in the corresponding FAQ entry (and then don't forget to restart the computer - logoff isn't enough).

The next step is to set up a valid configuration file for PHP, php.ini. There are two ini files distributed in the zip file, php.ini-dist and php.ini-recommended. We advise you to use php.ini-recommended, because we optimized the default settings in this file for performance, and security. Read this well documented file carefully because it has changes from php.ini-dist that will drastically affect your setup. Some examples are display_errors being off and magic_quotes_gpc being off. In addition to reading these, study the ini settings and set every element manually yourself. If you would like to achieve the best security, then this is the way for you, although PHP works fine with these default ini files. Copy your chosen ini-file to a directory that PHP is able to find and rename it to php.ini. PHP searches for php.ini in the locations described in Runtime Configuration section.

If you are running Apache 2, the simpler option is to use the PHPIniDir directive (read the installation on Apache 2 page), otherwise your best option is to set the PHPRC environment variable. This process is explained in the following FAQ entry.

Note: If you're using NTFS on Windows NT, 2000, XP or 2003, make sure that the user running the web server has read permissions to your php.ini (e.g. make it readable by Everyone).

The following steps are optional:

• Edit your new php.ini file. If you plan to use OmniHTTPd, do not follow the next step. Set the doc_root to point to your web servers document_root. For example:

  doc_root = c:\inetpub\wwwroot // for IIS/PWS
  
  doc_root = c:\apache\htdocs // for Apache
  

• Choose the extensions you would like to load when PHP starts. See the section about Windows extensions, about how to set up one, and what is already built in. Note that on a new installation it is advisable to first get PHP working and tested without any extensions before enabling them in php.ini.
• On PWS and IIS, you can set the browscap configuration setting to point to: c:\windows\system\inetsrv\browscap.ini on Windows 9x/Me, c:\winnt\system32\inetsrv\browscap.ini on NT/2000, and c:\windows\system32\inetsrv\browscap.ini on XP. For an up-to-date browscap.ini, read the following FAQ.

PHP is now setup on your system. The next step is to choose a web server, and enable it to run PHP. Choose a web server from the table of contents.

ActiveScript

This section contains notes specific to the ActiveScript installation.

ActiveScript is a Windows only SAPI that enables you to use PHP script in any ActiveScript compliant host, like Windows Script Host, ASP/ASP.NET, Windows Script Components or Microsoft Scriptlet control.

As of PHP 5.0.1, ActiveScript has been moved to the » PECL repository. 可以從 » PHP 下載頁面或者 » http://snaps.php.net/ 下載此 PECL 擴充功能的 DLL 文件。

Note: You should read the manual installation steps first!

After installing PHP, you should download the ActiveScript DLL (php5activescript.dll) and place it in the main PHP folder (e.g. C:\php).

After having all the files needed, you must register the DLL on your system. To achieve this, open a Command Prompt window (located in the Start Menu). Then go to your PHP directory by typing something like cd C:\php. To register the DLL just type regsvr32 php5activescript.dll.

To test if ActiveScript is working, create a new file, named test.wsf (the extension is very important) and type:

<job id="test">
 
 <script language="PHPScript">
  $WScript->Echo("Hello World!");
 </script>
 
</job>

Note: In PHP 4, the engine was named 'ActivePHP', so if you are using PHP 4, you should replace 'PHPScript' with 'ActivePHP' in the above example.

Note: ActiveScript doesn't use the default php.ini file. Instead, it will look only in the same directory as the .exe that caused it to load. You should create php-activescript.ini and place it in that folder, if you wish to load extensions, etc.

Microsoft IIS / PWS

This section contains notes and hints specific to IIS (Microsoft Internet Information Server).

Apache 1.3.x on Microsoft Windows

This section contains notes and hints specific to Apache 1.3.x installs of PHP on Microsoft Windows systems. There are also instructions and notes for Apache 2 on a separate page.

Note: Please read the manual installation steps first!

There are two ways to set up PHP to work with Apache 1.3.x on Windows. One is to use the CGI binary (php.exe for PHP 4 and php-cgi.exe for PHP 5), the other is to use the Apache Module DLL. In either case you need to edit your httpd.conf to configure Apache to work with PHP, and then restart the server.

It is worth noting here that now the SAPI module has been made more stable under Windows, we recommend it's use above the CGI binary, since it is more transparent and secure.

Although there can be a few variations of configuring PHP under Apache, these are simple enough to be used by the newcomer. Please consult the Apache Documentation for further configuration directives.

After changing the configuration file, remember to restart the server, for example, NET STOP APACHE followed by NET START APACHE, if you run Apache as a Windows Service, or use your regular shortcuts.

Note: 記住在 Windows 下給 Apache 的設定檔案中加入路徑值的時候，所有的反斜線例如 c:\directory\file.ext 必須轉換成正斜線，如 c:/directory/file.ext。

# Add to the end of the LoadModule section
# Don't forget to copy this file from the sapi directory!
LoadModule php4_module "C:/php/php4apache.dll"

# Add to the end of the AddModule section
AddModule mod_php4.c

# Add to the end of the LoadModule section
LoadModule php5_module "C:/php/php5apache.dll"

# Add to the end of the AddModule section
AddModule mod_php5.c

# Add this line inside the <IfModule mod_mime.c> conditional brace
AddType application/x-httpd-php .php

# For syntax highlighted .phps files, also add
AddType application/x-httpd-php-source .phps

ScriptAlias /php/ "c:/php/"
AddType application/x-httpd-php .php

# For PHP 4
Action application/x-httpd-php "/php/php.exe"

# For PHP 5
Action application/x-httpd-php "/php/php-cgi.exe"

# specify the directory where php.ini is
SetEnv PHPRC C:/php

Apache 2.0.x on Microsoft Windows

This section contains notes and hints specific to Apache 2.0.x installs of PHP on Microsoft Windows systems. We also have instructions and notes for Apache 1.3.x users on a separate page.

Note: You should read the manual installation steps first!

Note: Apache 2.2.x Support Users of Apache 2.2.x may use the documentation below except the appropriate DLL file is named php5apache2_2.dll and it only exists as of PHP 5.2.0. See also » http://snaps.php.net/

You are highly encouraged to take a look at the » Apache Documentation to get a basic understanding of the Apache 2.0.x Server. Also consider to read the » Windows specific notes for Apache 2.0.x before reading on here.

Note: PHP and Apache 2.0.x compatibility notes The following versions of PHP are known to work with the most recent version of Apache 2.0.x:

• PHP 4.3.0 or later available at » http://www.php.net/downloads.php.
• the latest stable development version. Get the source code » http://snaps.php.net/php5-latest.tar.gz or download binaries for Windows » http://snaps.php.net/win32/php5-win32-latest.zip.
• a prerelease version downloadable from » http://qa.php.net/.
• you have always the option to obtain PHP through » anonymous CVS.

These versions of PHP are compatible to Apache 2.0.40 and later.
Apache 2.0 SAPI-support started with PHP 4.2.0. PHP 4.2.3 works with Apache 2.0.39, don't use any other version of Apache with PHP 4.2.3. However, the recommended setup is to use PHP 4.3.0 or later with the most recent version of Apache2.
All mentioned versions of PHP will work still with Apache 1.3.x.

Download the most recent version of » Apache 2.0.x and a fitting PHP version. Follow the Manual Installation Steps and come back to go on with the integration of PHP and Apache.

There are two ways to set up PHP to work with Apache 2.0.x on Windows. One is to use the CGI binary the other is to use the Apache module DLL. In either case you need to edit your httpd.conf to configure Apache to work with PHP and then restart the server.

Note: 記住在 Windows 下給 Apache 的設定檔案中加入路徑值的時候，所有的反斜線例如 c:\directory\file.ext 必須轉換成正斜線，如 c:/directory/file.ext。

ScriptAlias /php/ "c:/php/"
AddType application/x-httpd-php .php

# For PHP 4
Action application/x-httpd-php "/php/php.exe"

# For PHP 5
Action application/x-httpd-php "/php/php-cgi.exe"

# For PHP 4 do something like this:
LoadModule php4_module "c:/php/php4apache2.dll"
# Don't forget to copy the php4apache2.dll file from the sapi directory!
AddType application/x-httpd-php .php

# For PHP 5 do something like this:
LoadModule php5_module "c:/php/php5apache2.dll"
AddType application/x-httpd-php .php

# configure the path to php.ini
PHPIniDir "C:/php"

Sun, iPlanet and Netscape servers on Microsoft Windows

This section contains notes and hints specific to Sun Java System Web Server, Sun ONE Web Server, iPlanet and Netscape server installs of PHP on Windows.

From PHP 4.3.3 on you can use PHP scripts with the NSAPI module to generate custom directory listings and error pages. Additional functions for Apache compatibility are also available. For support in current web servers read the note about subrequests.

variables_order = "GPCS"
register_globals = On

Error fn="php4_execute" code=XXX script="/path/to/script.php" [inikey=value inikey=value...]

Service fn="php4_execute" type="magnus-internal/directory" script="/path/to/script.php" [inikey=value inikey=value...]

Init fn=php4_init ... server_lib="ns-httpdXX.dll"

OmniHTTPd Server

This section contains notes and hints specific to » OmniHTTPd on Windows.

Note: You should read the manual installation steps first!

You need to complete the following steps to make PHP work with OmniHTTPd. This is a CGI executable setup. SAPI is supported by OmniHTTPd, but some tests have shown that it is not so stable to use PHP as an ISAPI module.

Note: Important for CGI users Read the faq on cgi.force_redirect for important details. This directive needs to be set to 0.

1. Install OmniHTTPd server.

2. Right click on the blue OmniHTTPd icon in the system tray and select Properties

3. Click on Web Server Global Settings

4. On the 'External' tab, enter: virtual = .php | actual = c:\php\php.exe (use php-cgi.exe if installing PHP 5), and use the Add button.

5. On the Mime tab, enter: virtual = wwwserver/stdcgi | actual = .php, and use the Add button.

6. Click OK

Repeat steps 2 - 6 for each extension you want to associate with PHP.

Note: Some OmniHTTPd packages come with built in PHP support. You can choose at setup time to do a custom setup, and uncheck the PHP component. We recommend you to use the latest PHP binaries. Some OmniHTTPd servers come with PHP 4 beta distributions, so you should choose not to set up the built in support, but install your own. If the server is already on your machine, use the Replace button in Step 4 and 5 to set the new, correct information.

Sambar Server on Microsoft Windows

This section contains notes and hints specific to the » Sambar Server for Windows.

Note: You should read the manual installation steps first!

This list describes how to set up the ISAPI module to work with the Sambar server on Windows.

• Find the file called mappings.ini (in the config directory) in the Sambar install directory.

• Open mappings.ini and add the following line under [ISAPI]:

  Example#1 ISAPI configuration of Sambar

  #for PHP 4
  *.php = c:\php\php4isapi.dll
  
  #for PHP 5
  *.php = c:\php\php5isapi.dll
  

  (This line assumes that PHP was installed in c:\php.)

• Now restart the Sambar server for the changes to take effect.

Note: If you intend to use PHP to communicate with resources which are held on a different computer on your network, then you will need to alter the account used by the Sambar Server Service. The default account used for the Sambar Server Service is LocalSystem which will not have access to remote resources. The account can be amended by using the Services option from within the Windows Control Panel Administation Tools.

Xitami on Microsoft Windows

This section contains notes and hints specific to » Xitami on Windows.

Note: You should read the manual installation steps first!

This list describes how to set up the PHP CGI binary to work with Xitami on Windows.

Note: Important for CGI users Read the faq on cgi.force_redirect for important details. This directive needs to be set to 0. If you want to use $_SERVER['PHP_SELF'] you have to enable the cgi.fix_pathinfo directive.

• Make sure the web server is running, and point your browser to xitamis admin console (usually http://127.0.0.1/admin), and click on Configuration.

• Navigate to the Filters, and put the extension which PHP should parse (i.e. .php) into the field File extensions (.xxx).

• In Filter command or script put the path and name of your PHP CGI executable i.e. C:\php\php.exe for PHP 4, or C:\php\php-cgi.exe for PHP 5.

• Press the 'Save' icon.

• Restart the server to reflect changes.

Building from source

This chapter teaches how to compile PHP from sources on windows, using Microsoft's tools. To compile PHP with cygwin, please refer to Installation on Unix systems.

+--C:\work
|  |
|  +--bindlib_w32
|  |  |
|  |  +--arpa
|  |  |
|  |  +--conf
|  |  |
|  |  +--...
|  |
|  +--php-5.x.x
|  |  |
|  |  +--build
|  |  |
|  |  +--...
|  |  |
|  |  +--win32
|  |  |
|  |  +--...
|  |
|  +--win32build
|  |  |
|  |  +--bin
|  |  |
|  |  +--include
|  |  |
|  |  +--lib

   

Installation of extensions on Windows

After installing PHP and a web server on Windows, you will probably want to install some extensions for added functionality. You can choose which extensions you would like to load when PHP starts by modifying your php.ini. You can also load a module dynamically in your script using dl().

The DLLs for PHP extensions are prefixed with php_.

Many extensions are built into the Windows version of PHP. This means additional DLL files, and the extension directive, are not used to load these extensions. The Windows PHP Extensions table lists extensions that require, or used to require, additional PHP DLL files. Here's a list of built in extensions:

In PHP 4 (updated PHP 4.3.11): BCMath, Caledar, COM, Ctype, FTP, MySQL, ODBC, Overload, PCRE, Session, Tokenizer, WDDX, XML 和 Zlib

In PHP 5 (updated PHP 5.0.4), the following changes exist. Built in: DOM, LibXML, Iconv, SimpleXML, SPL 和 SQLite. And the following are no longer built in: MySQL and Overload.

The default location PHP searches for extensions is C:\php4\extensions in PHP 4 and C:\php5 in PHP 5. To change this setting to reflect your setup of PHP edit your php.ini file:

• You will need to change the extension_dir setting to point to the directory where your extensions lives, or where you have placed your php_*.dll files. For example:

  extension_dir = C:\php\extensions
  

• Enable the extension(s) in php.ini you want to use by uncommenting the extension=php_*.dll lines in php.ini. This is done by deleting the leading ; from the extension you want to load.

  Example#1 Enable Bzip2 extension for PHP-Windows

  // change the following line from ...
  ;extension=php_bz2.dll
  
  // ... to
  extension=php_bz2.dll
  

• Some of the extensions need extra DLLs to work. Couple of them can be found in the distribution package, in the C:\php\dlls\ folder in PHP 4 or in the main folder in PHP 5, but some, for example Oracle (php_oci8.dll) require DLLs which are not bundled with the distribution package. If you are installing PHP 4, copy the bundled DLLs from C:\php\dlls folder to the main C:\php folder. Don't forget to include C:\php in the system PATH (this process is explained in a separate FAQ entry).

• Some of these DLLs are not bundled with the PHP distribution. See each extensions documentation page for details. Also, read the manual section titled Installation of PECL extensions for details on PECL. An increasingly large number of PHP extensions are found in PECL, and these extensions require a separate download.

Note: If you are running a server module version of PHP remember to restart your web server to reflect your changes to php.ini.

The following table describes some of the extensions available and required additional dlls.

Introduction to PECL Installations

» PECL is a repository of PHP extensions that are made available to you via the » PEAR packaging system. This section of the manual is intended to demonstrate how to obtain and install PECL extensions.

These instructions assume /your/phpsrcdir/ is the path to the PHP source distribution, and that extname is the name of the PECL extension. Adjust accordingly. These instructions also assume a familiarity with the » pear command. The information in the PEAR manual for the pear command also applies to the pecl command.

To be useful, a shared extension must be built, installed, and loaded. The methods described below provide you with various instructions on how to build and install the extensions, but they do not automatically load them. Extensions can be loaded by adding an extension directive. To this php.ini file, or through the use of the dl() function.

When building PHP modules, it's important to have known-good versions of the required tools (autoconf, automake, libtool, etc.) See the » Anonymous CVS Instructions for details on the required tools, and required versions.

Downloading PECL extensions

There are several options for downloading PECL extensions, such as:

• » http://pecl.php.net/ The PECL web site contains information about the different extensions that are offered by the PHP Development Team. The information available here includes: ChangeLog, release notes, requirements and other similar details.
• pecl download extname PECL extensions that have releases listed on the PECL web site are available for download and installation using the » pecl command. Specific revisions may also be specified.
• CVS Most PECL extensions also reside in CVS. A web-based view may be seen at » http://cvs.php.net/pecl/. To download straight from CVS, the following sequence of commands may be used. Note that phpfi is the password for user cvsread:

  $ cvs -d:pserver:cvsread@cvs.php.net:/repository login 
  $ cvs -d:pserver:cvsread@cvs.php.net:/repository co pecl/extname
       

• Windows downloads Windows users may find compiled PECL binaries by downloading the Collection of PECL modules from the » PHP Downloads page, or by retrieving a » PECL Snapshot or an extension DLL on » PECL4WIN. To compile PHP under Windows, read the appropriate chapter.

PECL for Windows users

As with any other PHP extension DLL, installation is as simple as copying the PECL extension DLLs into the extension_dir folder and loading them from php.ini. For example, add the following line to your php.ini:

extension=php_extname.dll
   

After doing this, restart the web service.

Compiling shared PECL extensions with the pecl command

PECL makes it easy to create shared PHP extensions. Using the » pecl command, do the following:

$ pecl install extname
   

This will download the source for extname, compile, and install extname.so into your extension_dir. extname.so may then be loaded via php.ini

By default, the pecl command will not install packages that are marked with the alpha or beta state. If no stable packages are available, you may install a beta package using the following command:

$ pecl install extname-beta
   

You may also install a specific version using this variant:

$ pecl install extname-0.1
   

Note: After enabling the extension in php.ini, restarting the web service is required for the changes to be picked up.

Compiling shared PECL extensions with phpize

Sometimes, using the pecl installer is not an option. This could be because you're behind a firewall, or it could be because the extension you want to install is not available as a PECL compatible package, such as unreleased extensions from CVS. If you need to build such an extension, you can use the lower-level build tools to perform the build manually.

The phpize command is used to prepare the build environment for a PHP extension. In the following sample, the sources for an extension are in a directory named extname:

$ cd extname
$ phpize
$ ./configure
$ make
# make install

   

A successful install will have created extname.so and put it into the PHP extensions directory. You'll need to and adjust php.ini and add an extension=extname.so line before you can use the extension.

If the system is missing the phpize command, and precompiled packages (like RPM's) are used, be sure to also install the appropriate devel version of the PHP package as they often include the phpize command along with the appropriate header files to build PHP and its extensions.

Execute phpize --help to display additional usage information.

Compiling PECL extensions statically into PHP

You might find that you need to build a PECL extension statically into your PHP binary. To do this, you'll need to place the extension source under the php-src/ext/ directory and tell the PHP build system to regenerate its configure script.

$ cd /your/phpsrcdir/ext
$ pecl download extname
$ gzip -d < extname.tgz | tar -xvf -
$ mv extname-x.x.x extname

   

This will result in the following directory:

    /your/phpsrcdir/ext/extname
   

From here, force PHP to rebuild the configure script, and then build PHP as normal:

$ cd /your/phpsrcdir 
$ rm configure
$ ./buildconf --force
$ ./configure --help
$ ./configure --with-extname --enable-someotherext --with-foobar
$ make
$ make install
   

Note: To run the 'buildconf' script you need autoconf 2.13 and automake 1.4+ (newer versions of autoconf may work, but are not supported).

Whether --enable-extname or --with-extname is used depends on the extension. Typically an extension that does not require external libraries uses --enable. To be sure, run the following after buildconf:

$ ./configure --help | grep extname
   

Read the FAQ

Some problems are more common than others. The most common ones are listed in the PHP FAQ, part of this manual.

Other problems

If you are still stuck, someone on the PHP installation mailing list may be able to help you. You should check out the archive first, in case someone already answered someone else who had the same problem as you. The archives are available from the support page on » http://www.php.net/support.php. To subscribe to the PHP installation mailing list, send an empty mail to » php-install-subscribe@lists.php.net. The mailing list address is » php-install@lists.php.net.

If you want to get help on the mailing list, please try to be precise and give the necessary details about your environment (which operating system, what PHP version, what web server, if you are running PHP as CGI or a server module, 安全模式, etc...), and preferably enough code to make others able to reproduce and test your problem.

Bug reports

If you think you have found a bug in PHP, please report it. The PHP developers probably don't know about it, and unless you report it, chances are it won't be fixed. You can report bugs using the bug-tracking system at » http://bugs.php.net/. Please do not send bug reports in mailing list or personal letters. The bug system is also suitable to submit feature requests.

Read the » How to report a bug document before submitting any bug reports!

The configuration file

The configuration file (called php3.ini in PHP 3, and simply php.ini as of PHP 4) is read when PHP starts up. For the server module versions of PHP, this happens only once when the web server is started. For the CGI and CLI version, it happens on every invocation.

php.ini is searched in these locations (in order):

• SAPI module specific location (PHPIniDir directive in Apache 2, -c command line option in CGI and CLI, php_ini parameter in NSAPI, PHP_INI_PATH environment variable in THTTPD)

• The PHPRC environment variable. Before PHP 5.2.0 this was checked after the registry key mentioned below.

• As of PHP 5.2.0, the following registry locations are searched in order: HKEY_LOCAL_MACHINE\SOFTWARE\PHP\x.y.z\IniFilePath, HKEY_LOCAL_MACHINE\SOFTWARE\PHP\x.y\IniFilePath and HKEY_LOCAL_MACHINE\SOFTWARE\PHP\x\IniFilePath, where x, y and z mean the PHP major, minor and release versions.

• HKEY_LOCAL_MACHINE\SOFTWARE\PHP\IniFilePath (Windows Registry location)

• Current working directory (except CLI)

• The web server's directory (for SAPI modules), or directory of PHP (otherwise in Windows)

• Windows directory (C:\windows or C:\winnt) (for Windows), or --with-config-file-path compile time option

If php-SAPI.ini exists (where SAPI is used SAPI, so the filename is e.g. php-cli.ini or php-apache.ini), it's used instead of php.ini. SAPI name can be determined by php_sapi_name().

Note: The Apache web server changes the directory to root at startup causing PHP to attempt to read php.ini from the root filesystem if it exists.

The php.ini directives handled by extensions are documented respectively on the pages of the extensions themselves. The list of the core directives is available in the appendix. Probably not all PHP directives are documented in the manual though. For a complete list of directives available in your PHP version, please read your well commented php.ini file. Alternatively, you may find the » the latest php.ini from CVS helpful too.

; any text on a line after an unquoted semicolon (;) is ignored
[php] ; section markers (text within square brackets) are also ignored
; Boolean values can be set to either:
;    true, on, yes
; or false, off, no, none
register_globals = off
track_errors = yes

; you can enclose strings in double-quotes
include_path = ".:/usr/local/lib/php"

; backslashes are treated the same as any other character
include_path = ".;c:\php\lib"

Since PHP 5.1.0, it is possible to refer to existing .ini variables from within .ini files. Example: open_basedir = ${open_basedir} ":/new/dir".

How to change configuration settings

<IfModule mod_php5.c>
  php_value include_path ".:/usr/local/lib/php"
  php_admin_flag safe_mode on
</IfModule>
<IfModule mod_php4.c>
  php_value include_path ".:/usr/local/lib/php"
  php_admin_flag safe_mode on
</IfModule>
<IfModule mod_php3.c>
  php3_include_path ".:/usr/local/lib/php"
  php3_safe_mode on
</IfModule>

從 HTML 中跳脫

當 PHP 解析一個文件時，會尋找開始和結束標籤，標籤告訴 PHP 開始和停止解釋其中的代碼。此種方式的解析可以使 PHP 嵌入到各種不同的文件中，凡是在一對開始和結束標籤之外的內容都會被 PHP 解析器忽略。大多數情況下 PHP 都是嵌入在 HTML 文件中的，如下例所示。

還可以用更進階的結構：

可以在 PHP 中使用四對不同的開始和結束標籤。其中兩種，<?php ?> 和 <script language="php"> </script> 總是可用的。另兩種是短標籤和 ASP 風格標籤，可以在 php.ini 配置文件中打開或關閉。儘管有些人覺得短標籤和 ASP 風格標籤很方便，但移植性較差，通常不推薦。

Note: 此外注意如果將 PHP 嵌入到 XML 或 XHTML 中則需要使用 <?php ?> 以保持符合標準。

上例中的 1 和 2 總是可用的，其中 1 是最常用，並建議使用的。

短標籤（上例 3）僅在通過 php.ini 配置文件中的指令 short_open_tag 打開後才可用，或者在 PHP 編譯時加入了 --enable-short-tags 選項。

Note: 如果用 PHP 3 還可以通過 short_tags() 函式使用短標籤。此方法只適用於 PHP 3！

ASP 風格標籤（上例 4）僅在通過 php.ini 設定文件中的指令 asp_tags 打開後才可用。

Note: 對 ASP 風格標籤的支援是 3.0.4 版添加的。

Note: 在以下情況應避免使用短標籤：開發需要發行的程序或者函式庫，或者在用戶不能控制的伺服器上開發。因為目標伺服器可能不支持短標籤。為了代碼的移植及發行，確保不要使用短標籤。

指令分隔符

同 C 或 Perl 一樣，PHP 需要在每個語句後用分號結束指令。一段 PHP 代碼中的結束標籤隱含表示了一個分號；在一個 PHP 代碼段中的最後一行可以不用分號結束。如果後面還有新行，則程式區段的結束標籤包含了行結束標籤。

Note: 文件末尾的 PHP 代碼段結束標籤是選擇性的，有些情況下當使用 include() 或者 require() 時省略掉會更好些，這樣不期望的空格就不會出現在文件末尾，之後仍然可以輸出回覆表頭。在使用輸出緩衝時也很便利，就不會看到由包含文件生成的不期望的空格。

註解

PHP 支持 C，C++ 和 Unix Shell 風格（Perl 風格）的註解。例如:

單行註解僅僅註解到行末或者當前的 PHP 程式區段，看哪個首先出現。這意味著在 // ... ?> 或者 # ... ?> 之後的 HTML 碼將被顯示出來：?> 跳出了 PHP 模式並返回了 HTML 模式，// 或 # 並不能影響到這一點。如果啟用了 asp_tags 設定選項，其行為和 // %> 或 # %> 相同。不過，</script> 標籤在單行註解中不會跳出 PHP 模式。

C 風格的註解在碰到第一個 */ 時結束。要確保不要巢狀使用 C 風格的註解。試圖註解掉一大塊程式碼時很容易出現錯誤。

Introduction

PHP supports eight primitive types.

Four scalar types:

• boolean
• integer
• float (floating-point number, aka 'double')
• string

• array
• object

• resource
• NULL

• mixed
• number
• callback

You may also find some references to the type "double". Consider double the same as float, the two names exist only for historic reasons.

The type of a variable is usually not set by the programmer; rather, it is decided at runtime by PHP depending on the context in which that variable is used.

Note: If you want to check out the type and value of a certain expression, use var_dump(). If you simply want a human-readable representation of the type for debugging, use gettype(). To check for a certain type, do not use gettype(), but use the is_type functions. Some examples:

<?php
$a_bool = TRUE;   // a boolean
$a_str  = "foo";  // a string
$a_str2 = 'foo';  // a string
$an_int = 12;     // an integer

echo gettype($a_bool); // prints out:  boolean
echo gettype($a_str);  // prints out:  string

// If this is an integer, increment it by four
if (is_int($an_int)) {
    $an_int += 4;
}

// If $bool is a string, print it out
// (does not print out anything)
if (is_string($a_bool)) {
    echo "String: $a_bool";
}
?>

If you would like to force a variable to be converted to a certain type, you may either cast the variable or use the settype() function on it.

Note that a variable may be evaluated with different values in certain situations, depending on what type it is at the time. For more information, see the section on Type Juggling. Also, you may be interested in viewing the type comparison tables, as they show examples of various type related comparisons.

Booleans

This is the easiest type. A boolean expresses a truth value. It can be either TRUE or FALSE.

Note: The boolean type was introduced in PHP 4.

Integers

An integer is a number of the set Z = {..., -2, -1, 0, 1, 2, ...}.

See also: Arbitrary length integer / GMP, Floating point numbers, and Arbitrary precision / BCMath

decimal     : [1-9][0-9]*
            | 0

hexadecimal : 0[xX][0-9a-fA-F]+

octal       : 0[0-7]+

integer     : [+-]?decimal
            | [+-]?hexadecimal
            | [+-]?octal

Floating point numbers

Floating point numbers (AKA "floats", "doubles" or "real numbers") can be specified using any of the following syntaxes:

Strings

A string is series of characters. In PHP, a character is the same as a byte, that is, there are exactly 256 different characters possible. This also implies that PHP has no native support of Unicode. See utf8_encode() and utf8_decode() for some Unicode support.

Note: It is no problem for a string to become very large. There is no practical bound to the size of strings imposed by PHP, so there is no reason at all to worry about long strings.

Arrays

An array in PHP is actually an ordered map. A map is a type that maps values to keys. This type is optimized in several ways, so you can use it as a real array, or a list (vector), hashtable (which is an implementation of a map), dictionary, collection, stack, queue and probably more. Because you can have another PHP array as a value, you can also quite easily simulate trees.

Explanation of those data structures is beyond the scope of this manual, but you'll find at least one example for each of them. For more information we refer you to external literature about this broad topic.

array(  key =>  value
     , ...
     )
// key may be an integer or string
// value may be any value
      

$arr[key] = value;
$arr[] = value;
// key may be an integer or string
// value may be any value
      

Do you like red?
Do you like blue?
Do you like green?
Do you like yellow?

     

Array
(
    [0] => RED
    [1] => BLUE
    [2] => GREEN
    [3] => YELLOW
)

      

Array 
(
    [1] => 'January'
    [2] => 'February'
    [3] => 'March'
)
   
      

Objects

Resource

A resource is a special variable, holding a reference to an external resource. Resources are created and used by special functions. See the appendix for a listing of all these functions and the corresponding resource types.

Note: The resource type was introduced in PHP 4

See also get_resource_type().

NULL

The special NULL value represents that a variable has no value. NULL is the only possible value of type NULL.

Note: The null type was introduced in PHP 4.

A variable is considered to be NULL if

• it has been assigned the constant NULL.

• it has not been set to any value yet.

• it has been unset().

Pseudo-types and variables used in this documentation

Type Juggling

PHP does not require (or support) explicit type definition in variable declaration; a variable's type is determined by the context in which that variable is used. That is to say, if you assign a string value to variable $var , $var becomes a string. If you then assign an integer value to $var , it becomes an integer.

An example of PHP's automatic type conversion is the addition operator '+'. If any of the operands is a float, then all operands are evaluated as floats, and the result will be a float. Otherwise, the operands will be interpreted as integers, and the result will also be an integer. Note that this does NOT change the types of the operands themselves; the only change is in how the operands are evaluated.

If the last two examples above seem odd, see String conversion to numbers.

If you wish to force a variable to be evaluated as a certain type, see the section on Type casting. If you wish to change the type of a variable, see settype().

If you would like to test any of the examples in this section, you can use the var_dump() function.

Note: The behaviour of an automatic conversion to array is currently undefined.
Also, because PHP supports indexing into strings via offsets using the same syntax as array indexing, the following example holds true for all PHP versions:

<?php
$a    = 'car'; // $a is a string
$a[0] = 'b';   // $a is still a string
echo $a;       // bar
?>

See the section titled String access by character for more information.

基礎

PHP 中的變數用一個錢字元號後面跟變數名來表示。變數名是區分大小寫的。

變數名與 PHP 中其它的標籤一樣遵循相同的規則。一個有效的變數名由字母或者下劃線開頭，後面跟上任意數量的字母，數字，或者下劃線。按照正常的正則表示式，它將被表述為：'[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*'。

Note: 在此所說的字母是 a-z，A-Z，以及 ASCII 字元從 127 到 255（0x7f-0xff）。

有關變數的函式資訊見變數函式。

PHP 3 中，變數總是傳值指派。那也就是說，當將一個表達式的值賦予一個變數時，整個原始表達式的值被指派到目標變數。這意味著，例如，當一個變數的值賦予另外一個變數時，改變其中一個變數的值，將不會影響到另外一個變數。有關這種類型的指派操作，請參閱表達式一章。

PHP 4 提供了另外一種方式給變數指派：引用指派。這意味著新的變數簡單的引用（換言之，「成為其別名」 或者 「指向」）了原始變數。改動新的變數將影響到原始變數，反之亦然。

使用引用指派，簡單地將一個 & 符號加到將要指派的變數前（源變數）。例如，下列代碼片斷將輸出「My name is Bob」兩次：

有一點重要事項必須指出，那就是只有有名字的變數才可以引用指派。

雖然在 PHP 中並不需要初始化變數，但這是個好習慣。未初始化的變數具有其類型的默認值 - FALSE，零，空字元串或者空數組。

依賴未初始化變數的默認值在某些情況下會有問題，例如把一個文件包含到另一個之中時碰上相同的變數名。另外把 register_globals 打開是一個主要的安全隱患。E_NOTICE 級別的錯誤會在碰上未初始化的變數時發出，但是在向一個未初始化的數組附加單元時不會。isset() 語言結構可以用來檢測一個變數是否已被初始化。

預定義變數

PHP 提供了大量的預定義變數。由於許多變數依賴於運行的服務器的版本和設置，及其它因素，所以並沒有詳細的說明文檔。一些預定義變數在 PHP 以命令行形式運行時並不生效。有關這些變數的詳細列表，請參閱預定義變數一章。

從 PHP 4.1.0 開始，PHP 提供了一套附加的預定數組，這些數組變數包含了來自 web 服務器（如果可用），運行環境，和用戶輸入的數據。這些數組非常特別，它們在全局範圍內自動生效，例如，在任何範圍內自動生效。因此通常被稱為自動全局變數（autoglobals）或者超全局變數（superglobals）。（PHP 中沒有用戶自定義超全局變數的機制。）超全局變數羅列於下文中；但是為了得到它們的內容和關於 PHP 預定義變數的進一步的討論以及它們的本質，請參閱預定義變數。而且，你也將注意到舊的預定義數組（$HTTP_*_VARS）仍舊存在。自 PHP 5.0.0 起，長格式的 PHP 預設變數陣列可以由設置 register_long_arrays 來停用。

Note: 可變變數 超級全局變數不能被用作可變變數。

Note: 儘管超全局變數和 HTTP_*_VARS 同時存在。但是他們並不是同一個變數，所以改變一個的值並不會對另一個產生影響。

如果某些 variables_order 中的變數沒有設定，它們的對應的 PHP 預定義數組也是空的。

PHP 超全局變數

$GLOBALS

包含一個引用指向每個當前腳本的全局範圍內有效的變數。該數組的鍵名為全局變數的名稱。從 PHP 3 開始存在 $GLOBALS 數組。

$_SERVER

變數由 web 服務器設定或者直接與當前腳本的執行環境相關聯。類似於舊數組 $HTTP_SERVER_VARS 數組（依然有效，但反對使用）。

$_GET

經由 URL 請求提交至腳本的變數。類似於舊數組 $HTTP_GET_VARS 數組（依然有效，但反對使用）。

$_POST

經由 HTTP POST 方法提交至腳本的變數。類似於舊數組 $HTTP_POST_VARS 數組（依然有效，但反對使用）。

$_COOKIE

經由 HTTP Cookies 方法提交至腳本的變數。類似於舊數組 $HTTP_COOKIE_VARS 數組（依然有效，但反對使用）。

$_FILES

經由 HTTP POST 文件上傳而提交至腳本的變數。類似於舊數組 $HTTP_POST_FILES 數組（依然有效，但反對使用）。詳細資訊請參閱 POST 方法上傳。

$_ENV

執行環境提交至腳本的變數。類似於舊數組 $HTTP_ENV_VARS 數組（依然有效，但反對使用）。

$_REQUEST

經由 GET，POST 和 COOKIE 機制提交至腳本的變數，因此該數組並不值得信任。所有包含在該數組中的變數的存在與否以及變數的順序均按照 php.ini 中的 variables_order 配置指示來定義。此數組在 PHP 4.1.0 之前沒有直接對應的版本。參見 import_request_variables()。

Caution

自 PHP 4.3.0 起，$_FILES 中的文件資訊不再存在於 $_REQUEST 中。

Note: 當運行於命令行模式時，此數組將不會包含 argv 和 argc 條目；它們已經存在於數組 $_SERVER 中。

$_SESSION

當前註冊給腳本會話的變數。類似於舊數組 $HTTP_SESSION_VARS 數組（依然有效，但反對使用）。詳細資訊，請參照 Session 處理函式章節。

變數範圍

變數的範圍即它定義的上下文背景（也就是它的生效範圍）。大部分的 PHP 變數只有一個單獨的範圍。這個單獨的範圍跨度同樣包含了 include 和 require 引入的文件。例如：

這裡變數 $a 將會在包含文件 b.inc 中生效。但是，在用戶自定義函式中，一個局部函式範圍將被引入。任何用於函式內部的變數按缺省情況將被限制在局部函式範圍內。例如：

這個腳本不會有任何輸出，因為 echo 語句引用了一個局部版本的變數 $a，而且在這個範圍內，它並沒有被指派。你可能注意到 PHP 的全局變數和 C 語言有一點點不同，在 C 語言中，全局變數在函式中自動生效，除非被局部變數覆蓋。這可能引起一些問題，有些人可能漫不經心的改變一個全局變數。PHP 中全局變數在函式中使用時必須申明為全局。

NULL
object(stdClass)(0) {
}