php怎么把文件設(shè)置為插件?PHP中插件機制的一種實現(xiàn)方案
插件,亦即Plug-in,是指一類特定的功能模塊(通常由第三方開發(fā)者實現(xiàn)),它的特點是:當你需要它的時候激活它,不需要它的時候禁用/刪除它;且無 論是激活還是禁用都不影響系統(tǒng)核心模塊的運行,也就是說插件是一種非侵入式的模塊化設(shè)計,實現(xiàn)了核心程序與插件程序的松散耦合。一個典型的例子就是 Wordpress中眾多的第三方插件,比如Akimet插件用于對用戶的評論進行Spam過濾。
一個健壯的插件機制,我認為必須具備以下特點:
- 插件的動態(tài)監(jiān)聽和加載(Lookup)
- 插件的動態(tài)觸發(fā)
以上兩點的實現(xiàn)均不影響核心程序的運行
要在程序中實現(xiàn)插件,我們首先應(yīng)該想到的就是定義不同的鉤子(Hooks);“鉤子”是一個很形象的邏輯概念,你可以認為它是系統(tǒng)預(yù)留的插件觸發(fā)條件。它 的邏輯原理如下:當系統(tǒng)執(zhí)行到某個鉤子時,會判斷這個鉤子的條件是否滿足;如果滿足,會轉(zhuǎn)而先去調(diào)用鉤子所制定的功能,然后返回繼續(xù)執(zhí)行余下的程序;如果 不滿足,跳過即可。這有點像匯編中的“中斷保護”邏輯。
某些鉤子可能是系統(tǒng)事先就設(shè)計好的,比如之前我舉的關(guān)于評論Spam過濾的鉤子,通常它已經(jīng)由核心系統(tǒng)開發(fā)人員設(shè)計進了評論的處理邏輯中;另外一類鉤子則 可能是由用戶自行定制的(由第三方開發(fā)人員制定),通常存在于表現(xiàn)層,比如一個普通的PHP表單顯示頁面中。
可能你感覺上面的話比較無聊,讓人昏昏欲睡;但是要看懂下面我寫的代碼,理解以上的原理是必不可少的。
下面進行PHP中插件機制的核心實現(xiàn),整個機制核心分為三大塊:
一個插件經(jīng)理類:這是核心之核心。它是一個應(yīng)用程序全局Global對象。它主要有三個職責:
- 負責監(jiān)聽已經(jīng)注冊了的所有插件,并實例化這些插件對象。
- 負責注冊所有插件。
- 當鉤子條件滿足時,觸發(fā)對應(yīng)的對象方法。
插件的功能實現(xiàn):這大多由第三方開發(fā)人員完成,但需要遵循一定的規(guī)則,這個規(guī)則是插件機制所規(guī)定的,因插件機制的不同而不同,下面的顯 示代碼你會看到這個規(guī)則。
插件的觸發(fā):也就是鉤子的觸發(fā)條件。具體來說這是一小段代碼,放置在你需要插件實現(xiàn)的地方,用于觸發(fā)這個鉤子。
原理講了一大堆,下面看看我的實現(xiàn)方案:
插件經(jīng)理PluginManager類:
?
/**
* STBLOG PluginManager Class
*
* 插件機制的實現(xiàn)核心類
*
* @package STBLOG
* @subpackage Libraries
* @category Libraries
* @author Saturn
*/
class PluginManager
{
/**
* 監(jiān)聽已注冊的插件
*
* @access private
* @var array
*/
private $_listeners = array();
/**
* 構(gòu)造函數(shù)
*
* @access public
* @return void
*/
public function __construct()
{
#這里$plugin數(shù)組包含我們獲取已經(jīng)由用戶激活的插件信息
#為演示方便,我們假定$plugin中至少包含
#$plugin = array(
# 'name' => '插件名稱',
# 'directory'=>'插件安裝目錄'
#);
$plugins = get_active_plugins();#這個函數(shù)請自行實現(xiàn)
if($plugins)
{
foreach($plugins as $plugin)
{//假定每個插件文件夾中包含一個actions.php文件,它是插件的具體實現(xiàn)
if (@file_exists(STPATH .'plugins/'.$plugin['directory'].'/actions.php'))
{
include_once(STPATH .'plugins/'.$plugin['directory'].'/actions.php');
$class = $plugin['name'].'_actions';
if (class_exists($class))
{
//初始化所有插件
new $class($this);
}
}
}
}
#此處做些日志記錄方面的東西
}
/**
* 注冊需要監(jiān)聽的插件方法(鉤子)
*
* @param string $hook
* @param object $reference
* @param string $method
*/
function register($hook, $reference, $method)
{
//獲取插件要實現(xiàn)的方法
$key = get_class($reference).'->'.$method;
//將插件的引用連同方法push進監(jiān)聽數(shù)組中
$this->_listeners[$hook][$key] = array($reference, $method);
#此處做些日志記錄方面的東西
}
/**
* 觸發(fā)一個鉤子
*
* @param string $hook 鉤子的名稱
* @param mixed $data 鉤子的入?yún)?
* @return mixed
*/
function trigger($hook, $data='')
{
$result = '';
//查看要實現(xiàn)的鉤子,是否在監(jiān)聽數(shù)組之中
if (isset($this->_listeners[$hook]) is_array($this->_listeners[$hook]) count($this->_listeners[$hook]) > 0)
{
// 循環(huán)調(diào)用開始
foreach ($this->_listeners[$hook] as $listener)
{
// 取出插件對象的引用和方法
$class = $listener[0];
$method = $listener[1];
if(method_exists($class,$method))
{
// 動態(tài)調(diào)用插件的方法
$result .= $class->$method($data);
}
}
}
#此處做些日志記錄方面的東西
return $result;
}
}
?>
以上代碼加上注釋不超過100行,就完成了整個插件機制的核心。需要再次說明的是,你必須將它設(shè)置成全局類,在所有 需要用到插件的地方,優(yōu)先加載。用#注釋的地方是你需要自行完成的部分,包括插件的獲取和日志記錄等等。
下面是一個簡單插件的實現(xiàn)。
?
/**
* 這是一個Hello World簡單插件的實現(xiàn)
*
* @package DEMO
* @subpackage DEMO
* @category Plugins
* @author Saturn
*/
/**
*需要注意的幾個默認規(guī)則:
* 1. 本插件類的文件名必須是action
* 2. 插件類的名稱必須是{插件名_actions}
*/
class DEMO_actions
{
//解析函數(shù)的參數(shù)是pluginManager的引用
function __construct($pluginManager)
{
//注冊這個插件
//第一個參數(shù)是鉤子的名稱
//第二個參數(shù)是pluginManager的引用
//第三個是插件所執(zhí)行的方法
$pluginManager->register('demo', $this, 'say_hello');
}
function say_hello()
{
echo 'Hello World';
}
}
?>
這是一個簡單的Hello World插件,用于輸出一句話。在實際情況中,say_hello可能包括對數(shù)據(jù)庫的操作,或者是其他一些特定的邏輯,比如調(diào)用Akimet API。
插件實現(xiàn)的默認規(guī)則由核心系統(tǒng)開發(fā)者自行確定。比如本例的一些默認規(guī)則我在注釋中已經(jīng)寫的很清楚,在此不在贅述。需要特別注意的是鉤子名稱不要重復(fù)。
最后一步,就是定義鉤子的觸發(fā),你將鉤子放在哪里,上面這個插件的方法就會在哪里出發(fā)。比如我要將say_hello放到我博客首頁Index.php, 那么你在index.php中的某個位置寫下:
$pluginManager->trigger('demo','');
第一個參數(shù)表示鉤子的名字,在本例中它是demo;第二個參數(shù)是插件對應(yīng)方法的入口參數(shù),由于這個例子中沒有輸入?yún)?shù),所以為空。
總結(jié)
本篇文章介紹了插件機制在PHP中實現(xiàn)的一種方法和思路,以及我本人對插件機制的理解。初次接觸這個東西,可能會比較生澀,難以理解。但是當你結(jié)合真實的 例子,再想想程序的運行流程,思路可能會更清晰一些。如果大家還有任何補充可以聯(lián)系腳本之家小編。
您可能感興趣的文章:- 分享五個PHP7性能優(yōu)化提升技巧
- PHP后門隱藏的一些技巧總結(jié)
- php提高腳本性能的4個技巧
- PHP學習的技巧和學習的要素總結(jié)
- PHP實用小技巧之調(diào)用錄像的方法
- php探針使用原理和技巧講解
- php和vue配合使用技巧和方法
- php技巧小結(jié)【推薦】
- 淺談PHP7中的一些小技巧