PEAR簡介:用PEAR來寫你的下一個php程序

pear簡介:用pear來寫你的下一個php程序

內容:

什麽是pear

爲什麽要使用pear?

pear能給我帶來什麽好處?

pear的編碼規則

開始使用pear

總結

相關資源

作者簡介

潘凡(night sailer) (nightsailer@hotmail.com)

北京賽迪網信息技術有限公司

2001 年 6 月

你可能已經是個php的老手了,寫了很多非常棒的代碼。但是,如果你現在要把它們加入到你現在的項目中去,是否有些吃力?你的朋友想使用你的代碼作爲他的項目中的一個模塊,但是你發現你們使用了截然不同的編碼風格,讓他適應,甚至不如重寫一個!

請跟我來,使用pear標准編寫你的php程序吧,你的程序將會擁有更大的活力,你的程序和代碼將會很方便地和其他高手的代碼融合在一起,pear就象cpan對于perl一樣,會讓php産生更高的能量。

什麽是pear

pear是php擴展與應用庫(the php extension and application repository)的縮寫。它是一個php擴展及應用的一個代碼倉庫,簡單地說,pear就是php的cpan。

爲什麽要使用pear?

php是一個非常優秀的腳本語言,簡潔、高效,隨著4.0的發布,越來越多的人使用它來進行動態網站的開發,可以說,php已經成爲最優秀的internet開發語言之一,尤其對于那些需要能夠快速、高效地開發中小規模的商業應用的網站開發人員,php是其首選的語言。但是隨著php的應用的不斷增多,對于這些應用缺乏統一的標准和有效的管理,因此,php社區很難象perl社區的人們那樣方便的共享彼此的代碼和應用,因爲php缺乏象cpan那樣的統一的代碼庫來分類管理應用的代碼模塊(熟悉perl的人都知道,cpan是一個巨大的perl的擴展模塊倉庫,編寫的應用模塊可以放在cpan下面的適當的分類目錄下面,其他的人可以很方便地複用,當然,你編寫應用模塊時候也需要遵守其中的准則。)

爲此,pear就應運而生了,並且從4.04開始,隨著php核心一起被分發。

pear能給我帶來什麽好處?

1.如前所述,pear按照一定的分類來管理pear應用代碼庫,你的pear代碼可以組織到其中適當的目錄中,其他的人可以方便地檢索並分享到你的成果。

2.pear不僅僅是一個代碼倉庫,它同時也是一個標准,使用這個標准來書寫你的php代碼,將會增強你的程序的可讀性,複用性,減少出錯的幾率。

3.pear通過提供2個類爲你搭建了一個框架,實現了諸如析構函數,錯誤捕獲功能,你通過繼承就可以使用這些功能。

pear的編碼規則

pear的編碼規則包括縮進規則,控制結構,函數調用,函數定義,注釋,包含代碼,php標記,文件頭的注釋塊,cvs標記,url樣例,常量的命名這11方面。下面簡要地介紹一下:

縮進規則:

pear中需要使用4個空格來縮排代碼,並且不使用tab。如果你使用vim,將下列設置放入你的~/.vimrc中:

set expandtab

set shiftwidth=4

set tabstop=4

如果,你使用emacs/xemacs,需要把indent-tabs-mode 設置成nil。

不過你象我一樣喜歡用(x)emacs編輯php文件,我強烈推薦你安裝php-mode,這樣當你編寫pear代碼的時候,它會自動調整你的縮排風格,當然php-mode還有許多很優秀的特性,你可以從資源列表中的地方下載最新版的php-mode。

控制結構:

這裏所說的控制結構包括: if for while switch 等。對于控制結構,在關鍵字(如if for ..)後面要空一個格,然後再跟控制的圓括號,這樣,不至于和函數調用混淆,此外,你應該盡量完整的使用花括號{},即使從語法上來說是可選的。這樣可以防止你以後需添加新的代碼行時産生邏輯上的疑惑或者錯誤。這裏是一個樣例:

if ((條件1) && (條件2)) {

語句1;

}esleif ((條件3) || (條件4)) {

語句2;

}else {

語句3;

}

函數調用:

對于函數調用,函數名和左括號( 之間不應該有空格,對于函數參數,在分隔的逗號和下一個參數之間要有相同的空格分離,最後一個參數和右括號之間不能有空格。下面是一個標准的函數調用;

$result = foo($param1, $param2, $param3);

不規範的寫法:

$result=foo ($param1,$param2,$param3);

$result=foo( $param1,$param2, $param3 );

此外,如果要將函數的返回結果賦值,那麽在等號和所賦值的變量之間要有空格,同時,如果是一系列相關的賦值語句,你添加適當的空格,使它們對齊,就象這樣:

$result1 = $foo($param1, $param2, $param3);

$var2 = $foo($param3);

$var3 = $foo($param4, $param5);

函數定義:

函數定義遵循"one true brace"習俗:

function connect(&$dsn, $persistent = false)

{

if (is_array($dsn)) {

$dsninfo = &$dsn;

} else {

$dsninfo = db::parsedsn($dsn);

}

if (!$dsninfo || !$dsninfo['phptype']) {

return $this->raiseerror();

}

return true;

}

如上所示,可選參數要在參數表的末端,並且總是盡量返回有意義的函數值。

關于注釋:

對于類的在線文檔,應該能夠被phpdoc轉換,就象javadoc那樣。phpdoc也是一個pear的應用程序,更詳細的介紹你可以去http://www.phpdoc.de/查看。除了類的在線文檔,建議你應該使用非文檔性質的注釋來诠釋你的代碼,當你看到一段代碼時想:哦,我想不需要在文檔裏去仔細描述它吧。那麽你最好給這段代碼作一個簡單的注釋,這樣防止你會忘記它們是如何工作的。對于注釋的形式,c的 /* */和c++的//都不錯,不過,不要使用perl或者shell的#注釋方式。

包含代碼:

無論什麽時候,當你需要無條件包含進一個class文件,你必須使用requre_once;當你需要條件包含進一個class文件,你必須使用include_once;這樣可以保證你要包含的文件只會包含一次,並且這2個語句共用同一個文件列表,所以你無須擔心二者會混淆,一旦require_once 包含了一個文件,include_once不會再重複包含相同的文件,反之亦然。

php代碼標記:

任何時候都要使用<?php ?>定義你的php代碼,而不要簡單地使用<? ?>,這樣可以保證pear的兼容性,也利于跨平台的移植。

文件頭的注釋聲明:

所有需要包含在pear核心發布的php代碼文件,在文件開始的時候,你必須加入以下的注釋聲明:

/* vim: set expandtab tabstop=4 shiftwidth=4: */

// +----------------------------------------------------------------------+

// | php version 4.0 |

// +----------------------------------------------------------------------+

// | copyright (c) 1997, 1998, 1999, 2000, 2001 the php group |

// +----------------------------------------------------------------------+

// | this source file is subject to version 2.0 of the php license, |

// | that is bundled with this package in the file license, and is |

// | available at through the world-wide-web at |

// |http://www.php.net/license/2_02.txt. |

// | if you did not receive a copy of the php license and are unable to |

// | obtain it through the world-wide-web, please send a note to |

// |license@php.netso we can mail you a copy immediately. |

// +----------------------------------------------------------------------+

// | authors: original author |

// | your name |

// +----------------------------------------------------------------------+

//

// $id$

對于不在pear核心代碼庫中的文件,建議你也在文件的開始處有這樣一個類似的注釋塊,標明版權,協議,作者等等。同時也在第一行加入vim的modeline,這樣在vim中能夠保持pear的代碼風格。

cvs標記:

如上面所展示那樣,在每個文件中加入cvs的id標記,如果你編輯或修改的文件中沒有這個標記,那麽請加入,或者是替換原文件中相類似的表現形式(如"last modified"等等)

url樣本:

你可以參照rfc 2606,使用"http://www.example.com"作爲所有的url樣本。

常量命名:

常量應該盡量使用大寫,爲了便于理解,使用下劃線分割每個單詞。同時,你應該常量所在的包名或者是類名作爲前綴。比如,對于bug類中常量應該以bug_開始。以上是pear的編碼規則,詳細的編碼規則可以參考pear中的coding_standdard文件的說明。爲了更好地理解這些編碼規則,你也可以參考一下現有pear核心模塊的代碼。

開始使用pear

pear

使用pear很簡單,你只需這樣定義你自己的pear程序:

require_once "pear.php";

class your_class_name extends pear{

你的類定義...

}

當然,你需要遵守前面說的pear的編碼規則,之後你就可以在你的類內部實現你要做的事情了。下面,我們展開討論一下,實際上pear爲我們提供了2個預定義類:

pear:這是pear的基類,所有的pear擴展都要從它繼承派生出來。

pear_error:pear的錯誤處理的基類,你可以選擇派生出自己的錯誤處理的類。

一般來說,你不應該直接創建pear的實例,而是要自己派生出一個新的類,然後再創建這個新類的實例。作爲基類,pear給我們提供了一些有用的功能,最主要的就是析構函數和錯誤處理

析構函數

php支持構造函數,但是並不支持析構函數,不過,php提供register_shutdown_function()這個函數,從而能夠在腳本終止前回調注冊的函數,因此pear利用這個特性,提供了析構函數的仿真。假如你有一個pear的子類,叫做mypear,那麽在mypear類中,你可以定義一個函數,函數名是下劃線加上你的類名,_mypear(),這個函數就是這個類的析構函數。不過這個析構函數和c++中的析構函數不太一樣,它不會在對象被刪除的時候執行,而是在腳本結束的時候,畢竟這只是一個仿真。由于是使用了register_shutdown_function(),所以在你的析構函數裏,打印的信息將不會返回浏覽器中。此外,在你的構造函數中,需要調用一下它的父類的構造函數,因爲php不會自動調用父類的構造函數,而析構函數需要在pear的構造函數中注冊,我們可以看看pear的源代碼:

<code>

function pear() {

if (method_exists($this, "_".get_class($this))) {

global $_pear_destructor_object_list;

$_pear_destructor_object_list[] = &$this;

}

if ($this->_debug) {

printf("pear constructor called, class=%s\n",

get_class($this));

}

.....

function _pear_call_destructors() {

global $_pear_destructor_object_list;

if (is_array($_pear_destructor_object_list) && sizeof($_pear_destructor_object_list)) {

reset($_pear_destructor_object_list);

while (list($k, $objref) = each($_pear_destructor_object_list)) {

$destructor = "_".get_class($objref);

if (method_exists($objref, $destructor)) {

$objref->$destructor();

}

}

//清空已注冊的對象列表,

//防止重複調用

$_pear_destructor_object_list = array();

}

}

....

register_shutdown_function("_pear_call_destructors");

</code>

上面這段代碼展示了pear是如何實現析構函數的,在構件函數中,將檢查當前類中是否有析構函數,如果有,那麽將把當前類的引用放入一個全局列表中,在_pear_call_destructors中,則檢查這個全局列表中的每個元素是否存在相應的析構函數,如果有,則調用它,最後將全局列表清空。

在pear.php的最後一行代碼,則調用register_shutdown_function("_pear_call_destructors"),注冊_pear_call_destructors,這樣,當腳本執行完畢的時候,php會回調這個函數。使用析構函數,你可以在處理完用戶的請求,退出之前做一些必要的"善後"工作,典型的例子是,你可以關閉打開的文件,斷開數據庫的連接,將某些數據存入磁盤等等。

錯誤處理

pear中可以讓你有很多的方式來處理錯誤,你不僅僅是簡單地返回一個錯誤代碼,或者錯誤的信息,而是可以返回一個pear_error對象,或者是由pear_error派生出來的新的錯誤對象。

pear中的錯誤對象的並沒有限定具體的輸出形式,它可以僅僅是捕獲錯誤,不給用戶返回太多的信息,也可以是去回調一個特殊錯誤處理函數,同時,即使輸出錯誤信息,它也強迫你必須要是html形式,你可以輸出xml,csv形式,或者是其他你自己定義的形式,你只需要從pear_error派生一個新的類,然後在適當的時候創建並"抛出"這個新類的對象就可以了。

簡單的錯誤處理:

在pear中,最簡單的錯誤處理是"抛出"這個錯誤,你只要簡單地創建並返回一個pear_error的對象就可以了。下面是一個簡單的例子:

<code>

function myconnect($host = "localhost", $port = 1080)

{

$fp = fsockopen($host, $port, $errno, $errstr);

if (!is_resource($fp)) {

return new pear_error($errstr, $errno);

}

return $fp;

}

$sock = myconnect();

if (pear::iserror($sock)) {

print "connect error: ".$sock->getmessage()."<br>\n"

}

</code>

如上面代碼所展示的,在執行一段可能産生錯誤的代碼後,你需要使用pear的iserror來檢測是否存在錯誤,並且可以使用pear_error的getmessage來取得最近一次的錯誤信息。注意:一定要在關鍵的地方使用使用pear::iserror

使用raiseerror

php4.0.5以後,pear多了2個函數:

seterrorhandling($mode, $options = null)

raiseerror($message = null, $code = null, $mode = null,$options = null, $userinfo = null)

前者可以設置pear缺省的錯誤處理模式,後者是一個包裝函數,返回一個pear_error的對象,和直接創建並返回pear_error的對象略有不同的是,如果省略$mode,$options等參數,它會使用缺省值來創建這個pear_error的對象,這些缺省值你可以使用seterrorhandling()來定制。

pear_error

pear_error是pear的錯誤對象的一個基類,和pear不同,一般來說,你可以直接創建pear_error的實例,創建方式:

$error = new pear_error($message, $code, $mode, $options, $userinfo);

$message是你的錯誤信息,$code是該錯誤的錯誤號,後3個參數是緊密聯系的:

$mode:是這個錯誤的處理模式,可以下列常量:

pear_error_return:僅僅返回該錯誤對象(缺省方式)

pear_error_print:在構建函數中打印這個錯誤信息,但是當前程序會繼續運行。

pear_error_trigger:使用php的trigger_error() 觸發一個錯誤,如果你已經設置了錯誤處理函數,或者你把php的錯誤處理級別設置爲e_user_error,那麽當前程序將會被終止。

pear_error_die:打印錯誤並退出,程序終止。

pear_error_callback:使用一個回調函數或者方法來處理當前錯誤,程序終止。

$options:這個參數只有在$mode是pear_error_trigger和pear_error_callback的時候才起作用,如果是pear_error_trigger,$options必須是e_user_notice, e_user_warning 或 e_user_error這3個常量的一個,同php中trigger_error的值一致。如果$mode是pear_error_callback,$options可以是一個字符串,內容是要回調的函數名,也可以是一個2元素的數組,分別是一個對象變量,和一個字符串(標明要調用的方法)。

$userinfo:存放附加的用戶信息,你可以把相關的調試信息放在這裏。

pear_error中有一些常用的方法,這些方法在php文擋沒有描述,這裏一一列出:

int getmode:返回當前的錯誤處理模式,整型。

string getmessage:返回當前完整的錯誤信息,字符串。

mixed getcallback:返回當前的回調信息,可能是所回調的函數名,或者是(對象,方法)的數組。

int getcode:返回整型的錯誤代碼。

string gettype:返回錯誤的類型,也就是當前的類名,字符串。

string getuserinfo:返回附加的用戶信息,字符串。

string getdebuginfo:內容同上。

string tostring:返回當前對象的詳細字符串描述,內容包括錯誤處理的模式,級別,錯誤信息,錯誤代碼,相關回調函數等等。

總結

至此,對于pear的介紹就結束了。概括地說,如果你要做一個pear的擴展應用,需要這麽做:

require_once "pear.php"

使用class your_pear_extend extends pear{}定義你的新類。

在你的類的構造函數中,調用父類pear的構造函數:

function your_pear_extend{

$this->pear();

...

}

如果需要,定義你的析構函數 _your_pear_extend

如果需要,從pear_error派生出你自己的錯誤處理類

設置你的錯誤處理模式,並在適當的時候觸發錯誤。

在執行可能産生錯誤的代碼後,用pear::iserror($obj)捕獲相應的錯誤。

實現你自己的功能。

在最新的php4.05的pear核心發布裏,已經有不少優秀的應用模塊了,比如:phpdoc,cache,html...當然,相對于cpan來說,pear只是剛剛起步,需要php社區的人們的共同努力,來完善它,增強它,php才會越來越強大。

相關資源

pear主頁

php主頁

phpdoc主頁,可以從你的pear應用源碼産生類似javadoc的api文檔

php-mode for xemacs/emacs,爲emacs/xemacs提供php的語法支持,能夠很好支持pear代碼風格

vim主頁,非常優秀的一個編輯器,對php的支持也很好

 
PEAR簡介:用PEAR來寫你的下一個php程序
pear簡介:用pear來寫你的下一個php程序 內容:什麽是pear爲什麽要使用pear?pear能給我帶來什麽好處?pear的編碼規則開始使用pear總結相關資源作者簡介潘凡(night sailer) ()北京賽迪網信息技...查看完整版>>PEAR簡介:用PEAR來寫你的下一個php程序
 
用PEAR來寫你的下一個php程序
你可能已經是個PHP的老手了,寫了很多非常棒的代碼。但是,如果你現在要把它們加入到你現在的項目中去,是否有些吃力?你的朋友想使用你的代碼作爲他的項目中的一個模塊,但是你發現你們使用了截然不同的編碼風格,讓...查看完整版>>用PEAR來寫你的下一個php程序
 
用PEAR來寫你的下一個php程序
用PEAR來寫你的下一個php程序作者:潘凡 來源:IBM中國 你可能已經是個PHP的老手了,寫了很多非常棒的代碼。但是,如果你現在要把它們加入到你現在的項目中去,是否有些吃力?你的朋友想使用你的代碼作爲他的項目中的一...查看完整版>>用PEAR來寫你的下一個php程序