本文舉例說明了創建可配置 php 應用程序的幾種方法。文中也探討了應用程序中理想的配置點，并在應用程序過分可配置和過分封閉之間尋求一個平衡點。
如果計劃讓其他人或公司可以使用您的 php 應用程序，需要確保該程序是可配置的。至少，要允許用戶以一種安全的方式設置數據庫登錄及密碼，從而使其中的材料不會對外公開。
本文展示了幾種用于存儲配置設置及編輯這些設置的技術。另外，文中也為哪些元素需要設為可配置以及如何避免陷入配置過度或者配置不足的困境提供了指導。
使用 ini 文件進行配置
php 內建了對配置文件的支持。這是通過 php.ini 文件這樣的初始化文件（ini）機制實現的，在 php.ini 文件中定義了數據庫連接超時或會話如何存儲等常量。如果愿意的話，可以在這個 php.ini 文件中為應用程序定制配置。為了說明，我將下列代碼行添加到 php.ini 文件中。
myapptempdir=foo
然后，我編寫了一個小 php 腳本來讀取這個配置項，如清單 1 所示。
清單 1. ini1.php
＜?php
function get_template_directory()
{
$v = get_cfg_var( "myapptempdir" );
return ( $v == null ) ? "tempdir" : $v;
}
echo( get_template_directory()."/n" );
?＞
當在命令行中運行這段代碼時，得到如下結果：
% php ini1.php
foo
%
太棒了。但為什么不能用標準的 ini 函數來獲取 myapptempdir 配置項的值呢？我研究了一下，發現在大多數情況下，定制配置項不能使用這些方法來獲取。然而，使用 get_cfg_var 函數卻是可以訪問的。
為使這個方法更加簡單，將對變量的訪問封裝在第二個函數中，該函數使用配置鍵名及一個缺省值作為參數，如下所示。
清單 2. ini2.php
function get_ini_value( $n, $dv )
{
$c = get_cfg_var( $n );
return ( $c == null ) ? $dv : $c;
}
function get_template_directory()
{
return get_ini_value( "myapptempdir", "tempdir" );
}
這是對如何訪問 ini 文件的一個很好的概括，所以，如果要使用一個不同的機制或將這個 ini 文件存儲到其他位置，就不需要為更改大量的函數而大費周折。
我不推薦使用 ini 文件作為應用程序的配置，這有兩個理由。首先，雖然這樣做較容易讀取 ini 文件，但卻幾乎不可能安全地寫 ini 文件。所以這樣做只適合于只讀配置項。第二，php.ini 文件在服務器的所有應用程序上共享，所以我認為特定于應用程序的配置項不應該寫在該文件中。
需要對 ini 文件了解什么呢？最重要的是如何重置 include 路徑來添加配置項，如下所示。
清單 3. ini3.php
＜?php
echo( ini_get("include_path")."/n" );
ini_set("include_path",
ini_get("include_path").":./mylib" );
echo( ini_get("include_path")."/n" );
?＞
在本例中，我將我的本地 mylib 目錄添加到了 include 路徑中，所以能夠從該目錄中 require php 文件，而不需要將該路徑添加到 require 語句中。
php 中的配置
通常對于在 ini 文件中存儲配置條目的一個替代辦法是使用一個簡單的 php 腳本來保持數據。如下是一個樣例。
清單 4. config.php
＜?php
# specify the location of the temporary directory
#
$template_directory = "tempdir";
?＞
使用該常量的代碼如下所示。
清單 5. php.php
＜?php
require_once 'config.php';
function get_template_directory()
{
global $template_directory;
return $template_directory;
}
echo( get_template_directory()."/n" );
?＞
該代碼首先包含配置文件（config.php），接著就可以直接使用這些常量了。
使用這項技術有很多優勢。首先，如果某些人僅僅瀏覽 config.php 文件，該頁面是空白的。所以可以將 config.php 放到相同的文件中，并作為 web 應用程序的根。第二，在任何編輯器中都可編輯，并且在一些編輯器中甚至具備語法著色及語法檢查功能。
這項技術的缺點是，這是一個像 ini 文件一樣的只讀技術。將數據從此文件中提取出來是輕而易舉的，但在該 php 文件中調整數據卻很困難，在一些情況下甚至是不可能的。
下面的替代方法顯示了如何編寫在本質上既可讀又可寫的配置系統。 文本文件
前面的兩個例子對于只讀配置條目都是合適的，但對于既讀又寫的配置參數來說又如何呢？首先，看看清單 6 中的文本配置文件。
清單 6. config.txt
# my application's configuration file
title=my app
templatedirectory=tempdir
這是同 ini 文件相同的文件格式，但我自己編寫了輔助工具。為此，我創建了自己的 configuration 類，如下所示。
清單 7. text1.php
＜?php
class configuration
{
private $configfile = 'config.txt';
private $items = array();
function __construct() { $this-＞parse(); }
function __get($id) { return $this-＞items[ $id ]; }
function parse()
{
$fh = fopen( $this-＞configfile, 'r' );
while( $l = fgets( $fh ) )
{
if ( preg_match( '/^#/', $l ) == false )
{
preg_match( '/^(.*?)=(.*?)$/', $l, $found );
$this-＞items[ $found[1] ] = $found[2];
}
}
fclose( $fh );
}
}
$c = new configuration();
echo( $c-＞templatedirectory."/n" );
?＞
該代碼首先創建了一個 configuration 對象。該構造函數接下來讀取 config.txt 并用解析過的文件內容來設置局部變量 $items。
該腳本隨后尋找 templatedirectory，這并沒有在對象中直接定義。因此，使用設置成 'templatedirectory' 的 $id 來調用神奇的 __get 方法，__get 方法針對該鍵返回 $items 數組中的值。
這個 __get 方法特定于 php v5 環境，所以此腳本必須在 php v5 下運行。實際上，本文中所有的腳本都需要在 php v5 下運行。
當在命令行運行此腳本時，能看到下列結果：
% php text1.php
tempdir
%
一切都在預料之中，該對象讀取 config.txt 文件，然后為 templatedirectory 配置項獲得正確的值。
但對于設置一個配置值，應該怎么做呢？在此類中建立一個新方法及一些新的測試代碼，就能夠得到這個功能，如下所示。
清單 8. text2.php
＜?php
class configuration
{
...
function __get($id) { return $this-＞items[ $id ]; }
function __set($id,$v) { $this-＞items[ $id ] = $v; }
function parse() { ... }
}
$c = new configuration();
echo( $c-＞templatedirectory."/n" );
$c-＞templatedirectory = 'foobar';
echo( $c-＞templatedirectory."/n" );
?＞
現在，有了一個 __set 函數，它是 __get 函數的 “堂兄弟”。該函數并不為一個成員變量獲取值，當要設置一個成員變量時，才調用這個函數。底部的測試代碼設置值并打印出新值。
下面是在命令行中運行此代碼時出現的結果：
% php text2.php
tempdir
foobar
%
太好了！但如何能將它存儲到文件中，從而將使這個改動固定下來呢？為此，需要寫文件并讀取它。用于寫文件的新函數，如下所示。
清單 9. text3.php
＜?php
class configuration
{
...
function save()
{
$nf = '';
$fh = fopen( $this-＞configfile, 'r' );
while( $l = fgets( $fh ) )
{
if ( preg_match( '/^#/', $l ) == false )
{
preg_match( '/^(.*?)=(.*?)$/', $l, $found );
$nf .= $found[1]."=".$this-＞items[$found[1]]."/n";
}
else
{
$nf .= $l;
}
}
fclose( $fh );
copy( $this-＞configfile, $this-＞configfile.'.bak' );
$fh = fopen( $this-＞configfile, 'w' );
fwrite( $fh, $nf );
fclose( $fh );
}
}
$c = new configuration();
echo( $c-＞templatedirectory."/n" );
$c-＞templatedirectory = 'foobar';
echo( $c-＞templatedirectory."/n" );
$c-＞save();
?＞
新的 save 函數巧妙地操作 config.txt。我并沒有僅用更新過的配置項重寫文件（這樣會移除掉注釋），而是讀取了這個文件并靈活地重寫了 $items 數組中的內容。這樣的話，就保留了文件中的注釋。
在命令行運行該腳本并輸出文本配置文件中的內容，能夠看到下列輸出。
清單 10. 保存函數輸出
% php text3.php
tempdir
foobar
% cat config.txt
# my application's configuration file
title=my app
templatedirectory=foobar
%
原始的 config.txt 文件現在被新值更新了。 xml 配置文件
盡管文本文件易于閱讀及編輯，但卻不如 xml 文件流行。另外，xml 有眾多適用的編輯器，這些編輯器能夠理解標記、特殊符號轉義等等。所以配置文件的 xml 版本會是什么樣的呢？清單 11 顯示了 xml 格式的配置文件。
清單 11. config.xml
＜?xml version="1.0"?＞
＜config＞
＜title＞my app＜/title＞
＜templatedirectory＞tempdir＜/templatedirectory＞
＜/config＞
清單 12 顯示了使用 xml 來裝載配置設置的 configuration 類的更新版。
清單 12. xml1.php
＜?php
class configuration
{
private $configfile = 'config.xml';
private $items = array();
function __construct() { $this-＞parse(); }
function __get($id) { return $this-＞items[ $id ]; }
function parse()
{
$doc = new domdocument();
$doc-＞load( $this-＞configfile );
$cn = $doc-＞getelementsbytagname( "config" );
$nodes = $cn-＞item(0)-＞getelementsbytagname( "*" );
foreach( $nodes as $node )
$this-＞items[ $node-＞nodename ] = $node-＞nodevalue;
}
}
$c = new configuration();
echo( $c-＞templatedirectory."/n" );
?＞
看起來 xml 還有另一個好處：代碼比文本版的代碼更為簡潔、容易。為保存這個 xml，需要另一個版本的 save 函數，將結果保存為 xml 格式，而不是文本格式。
清單 13. xml2.php
...
function save()
{
$doc = new domdocument();
$doc-＞formatoutput = true;
$r = $doc-＞createelement( "config" );
$doc-＞appendchild( $r );
foreach( $this-＞items as $k =＞ $v )
{
$kn = $doc-＞createelement( $k );
$kn-＞appendchild( $doc-＞createtextnode( $v ) );
$r-＞appendchild( $kn );
}
copy( $this-＞configfile, $this-＞configfile.'.bak' );
$doc-＞save( $this-＞configfile );
}
...
這段代碼創建了一個新的 xml 文檔對象模型（document object model ，dom），然后將 $items 數組中的所有數據都保存到這個模型中。完成這些以后，使用 save 方法將 xml 保存為一個文件。 使用數據庫
最后的替代方式是使用一個數據庫保存配置元素的值。那首先要用一個簡單的模式來存儲配置數據。下面是一個簡單的模式。
清單 14. schema.sql
drop table if exists settings;
create table settings (
id mediumint not null auto_increment,
name text,
value text,
primary key ( id )
);
這要求進行一些基于應用程序需求的調整。例如，如果想讓配置元素按照每個用戶進行存儲，就需要添加用戶 id 作為額外的一列。
為了讀取及寫入數據，我編寫了如圖 15 所示的更新過的 configuration 類。
清單 15. db1.php
＜?php
require_once( 'db.php' );
$dsn = 'mysql://root:
[email protected]/config';
$db =& db::connect( $dsn, array() );
if (pear::iserror($db)) { die($db-＞getmessage()); }
class configuration
{
private $configfile = 'config.xml';
private $items = array();
function __construct() { $this-＞parse(); }
function __get($id) { return $this-＞items[ $id ]; }
function __set($id,$v)
{
global $db;
$this-＞items[ $id ] = $v;
$sth1 = $db-＞prepare( 'delete from settings where name=?' );
$db-＞execute( $sth1, $id );
if (pear::iserror($db)) { die($db-＞getmessage()); }
$sth2 = $db-＞prepare('insert into settings ( id, name, value ) values ( 0, ?, ? )' );
$db-＞execute( $sth2, array( $id, $v ) );
if (pear::iserror($db)) { die($db-＞getmessage()); }
}
function parse()
{
global $db;
$doc = new domdocument();
$doc-＞load( $this-＞configfile );
$cn = $doc-＞getelementsbytagname( "config" );
$nodes = $cn-＞item(0)-＞getelementsbytagname( "*" );
foreach( $nodes as $node )
$this-＞items[ $node-＞nodename ] = $node-＞nodevalue;
$res = $db-＞query( 'select name,value from settings' );
if (pear::iserror($db)) { die($db-＞getmessage()); }
while( $res-＞fetchinto( $row ) ) {
$this-＞items[ $row[0] ] = $row[1];
}
}
}
$c = new configuration();
echo( $c-＞templatedirectory."/n" );
$c-＞templatedirectory = 'new foo';
echo( $c-＞templatedirectory."/n" );
?＞
這實際上是一個混合的文本/數據庫解決方案。請仔細觀察 parse 方法。該類首先讀取文本文件來獲取初始值，然后讀取數據庫，進而將鍵更新為最新的值。在設置一個值后，鍵就從數據庫中移除掉，并添加一條具有更新過的值的新記錄。
觀察 configuration 類如何通過本文的多個版本來發揮作用是一件有趣的事，該類能從文本文件、xml 及數據庫中讀取數據，并一直保持相同的接口。我鼓勵您在開發中也使用具有相同穩定性的接口。對于對象的客戶機來說，這項工作具體是如何運行的是不明確的。關鍵的是對象與客戶機之間的契約。
什么是配置及怎樣配置
在配置過多的配置選項與配置不足間找一個適當的中間點是一件困難的事。可以肯定的是，任何數據庫配置（例如，數據庫名稱、數據庫用戶用及密碼）都應該是可配置的。除此之外，我還有一些基本的推薦配置項。
在高級設置中，每一個特性都應該有一個獨立的啟用/禁用選項。根據其對應用程序的重要性來允許或禁用這些選項。例如，在一個 web 論壇應用程序中，延時特性在缺省狀態下是啟用的。但電子郵件通知在缺省狀態下卻是禁用的，因為這似乎需要定制。
用戶界面（ui）選項全應該設置到一個位置上。界面的結構（例如，菜單位置、額外的菜單項、鏈接到界面特定元素的 url、使用的 logo，諸如此類）全應該設置到一個單一位置上。我強烈地建議不要將字體、顏色或樣式條目指定為配置項。這些都應該通過層疊樣式表（cascading style sheets，css）來設置，且配置系統應該指定使用哪個 css 文件。css 是設置字體、樣式、顏色等等的一種有效且靈活的方式。有許多出色的 css 工具，您的應用程序應該很好地利用 css，而不是試圖自行設置標準。
在每一個特性中，我推薦設置 3 到 10 個配置選項。這些配置選項應該以一種意義明顯的方式命名。如果配置選項能夠通過 ui 設置，在文本文件、xml 文件及數據庫中的選項名稱應該直接同界面元素的標題相關。另外，這些選項全應該有明確的缺省值。
總的來說，下面這些選項應該是可配置的：電子郵件地址、css 所使用的東西、從文件中引用的系統資源的位置以及圖形元素的文件名。
對于圖形元素，您也許想要創建一個名為皮膚 的獨立的配置文件類型，該類型中包含了對配置文件的設置，包括 css 文件的位置、圖形的位置及這些類型的東西。然后，讓用戶在多種皮膚文件中進行挑選。這使得對應用程序外觀和感覺的大規模更改變得簡單。這也同樣為用戶提供了一個機會，使應用程序能夠在不同的產品安裝間更換皮膚。本文并不涵蓋這些皮膚文件，但您在這里學到的基礎知識將會使對皮膚文件的支持變得更加簡單。
結束語
可配置性對于任何 php 應用程序來說都是至關重要的一個部分，一開始就應該成為設計的中心部分。我希望本文能夠對您實現配置架構提供一些幫助，并對應該允許什么樣的配置選項有所指導。
