PHP的寶庫目錄之PEAR

這篇文章跟大家介紹的內容是PHP的寶庫目錄之PEAR，在這裡分享給大家，有需要的朋友可以參考一下

           



#                        你可能已經是個PHP的老手了，並寫了很多非常棒的程式碼。但是，如果你現在要把它們加入到你現在的專案中去，是否有些吃力？你的朋友想使用你的程式碼作為他的專案中的一個模組，但是你發現你們使用了截然不同的編碼風格，讓他適應，甚至不如重寫一個！
請跟我來，使用PEAR標準來寫你的PHP程式吧，你​​的程式將會擁有更大的活力，你的程式和程式碼將會很方便地和其他高手的程式碼融合在一起，PEAR就象CPAN對於PERL一樣，會讓PHP產生更高的能量。

什麼是ＰＥＡＲ
ＰＥＡＲ是ＰＨＰ擴充與應用程式庫（the PHP Extension and Application Repository）的縮寫。它是一個ＰＨＰ擴展及應用的一個代碼倉庫，簡單地說，ＰＥＡＲ就是ＰＨＰ的ＣＰＡＮ。

為什麼要用ＰＥＡＲ？
PHP是一個非常優秀的腳本語言，簡潔、高效，隨著4.0的發布，越來越多的人使用它來進行動態網站的開發，可以說，PHP已經成為最優秀的INTERNET開發語言之一，尤其對於需要能夠快速、有效率地開發中小規模的商業應用的網站開發人員，PHP是其首選的語言。但是隨著PHP的應用的不斷增多，對於這些應用缺乏統一的標準和有效的管理，因此，PHP社區很難象PERL社區的人們那樣方便的共享彼此的代碼和應用，因為PHP缺乏像CPAN那樣的統一的程式碼庫來分類管理應用的程式碼模組（熟悉PERL的人都知道，CPAN是一個巨大的PERL的擴展模組倉庫，編寫的應用模組可以放在CPAN下面的適當的分類目錄下面，其他的人可以很方便地復用，當然，你編寫應用模組時候也需要遵守其中的準則。

ＰＥＡＲ能為我帶來什麼好處？
1.如前所述，PEAR按照一定的分類來管理PEAR應用程式碼庫，你的PEAR程式碼可以組織到其中適當的目錄中，其他的人可以方便地檢索並分享到你的成果。

2.PEAR不只是一個代碼倉庫，它同時也是一個標準，使用這個標準來書寫你的PHP代碼，將會增強你的程序的可讀性，復用性，減少出錯的幾率。

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

ＰＥＡＲ的編碼規則
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程式碼，而不要簡單地使用,這樣可以保證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.net so 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,使用"www.example.com"作為所有的URL樣本。

常數命名：
常數應該盡量使用大寫，為了便於理解，使用底線分割每個單字。同時，你應該常數所在的包名或是類別名稱作為前綴。例如，對於Bug類別中常數應該以Bug_開始。以上是PEAR的編碼規則，詳細的編碼規則可以參考PEAR中的CODING_STANDDARD文件的說明。為了更好地理解這些編碼規則，你也可以參考一下現有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才会越来越强大。

以上是PHP的寶庫目錄之PEAR的詳細內容。更多資訊請關注PHP中文網其他相關文章！