php怎麼把檔案設定為插件

php怎麼把檔案設定為外掛？ PHP中插件機制的實作方案

插件，亦即Plug-in，是指一類特定的功能模組（通常由第三方開發者實現），它的特點是：當你需要它的時候啟動它，不需要它的時候禁用/刪除它；且無論是激活還是禁用都不影響系統核心模組的運行，也就是說插件是一種非侵入式的模組化設計，實現了核心程式與插件程式的鬆散耦合。一個典型的例子就是 Wordpress中眾多的第三方插件，例如Akimet插件用於對用戶的評論進行Spam過濾。

一個健壯的外掛機制，我認為必須具備以下特點：

● 外掛程式的動態監聽和載入（Lookup） 

● 外掛程式的動態觸發 

以上兩點的實現都不會影響核心程式的運行

 

要在程式中實作插件，我們首先應該想到的就是定義不同的鉤子（Hooks）；“鉤子”是一個很形象的邏輯概念，你可以認為它是系統預留的插件觸發條件。它的邏輯原理如下：當系統執行到某個鉤子時，會判斷這個鉤子的條件是否滿足；如果滿足，會轉而先去調用鉤子所製定的功能，然後返回繼續執行餘下的程序；如果不滿足，跳過即可。這有點像是彙編中的「中斷保護」邏輯。

某些鉤子可能是系統事先就設計好的，例如之前我舉的關於評論Spam過濾的鉤子，通常它已經由核心系統開發人員設計進了評論的處理邏輯中；另外一類鉤子則可能是由使用者自行自訂的（由第三方開發人員制定），通常存在於表現層，例如普通的PHP表單顯示頁面中。

可能你覺得上面的話比較無聊，讓人昏昏欲睡；但是要看懂下面我寫的程式碼，理解以上的原理是不可或缺的。

下面進行PHP中外掛機制的核心實現，整個機制核心分為三大塊：

一個外掛程式經理類別：這是核心之核心。它是一個應用程式全域Global物件。它主要有三個職責： 

● 負責監聽所有已經註冊了的插件，並實例化這些插件物件。 

● 負責註冊所有外掛程式。 

● 當鉤子條件滿足時，觸發對應的物件方法。

外掛程式的功能實作：這大多由第三方開發人員完成，但需要遵循一定的規則，這個規則是外掛機制所規定的，因外掛機制的不同而不同，下面的顯示程式碼你會看到這個規則。 

外掛程式的觸發：也就是鉤子的觸發條件。具體來說這是一小段程式碼，放置在你需要插件實現的地方，用於觸發這個鉤子。

 

原則講了一大堆，下面來看看我的實作方案：

外掛程式經理PluginManager類別：

<?
/**
* STBLOG PluginManager Class
*
* 插件机制的实现核心类
*
* @package        STBLOG
* @subpackage    Libraries
* @category    Libraries
* @author        Saturn
*/
class PluginManager
{
    /**
     * 监听已注册的插件
     *
     * @access private
     * @var array
     */
    private $_listeners = array();
     /**
     * 构造函数
     *  
     * @access public
     * @return void
     */
    public function __construct()
    {
        #这里$plugin数组包含我们获取已经由用户激活的插件信息
     #为演示方便，我们假定$plugin中至少包含
     #$plugin = array(
        #    &#39;name&#39; => &#39;插件名称&#39;,
        #    &#39;directory&#39;=>&#39;插件安装目录&#39;
        #);
        $plugins = get_active_plugins();#这个函数请自行实现
        if($plugins)
        {
            foreach($plugins as $plugin)
            {//假定每个插件文件夹中包含一个actions.php文件，它是插件的具体实现
                if (@file_exists(STPATH .&#39;plugins/&#39;.$plugin[&#39;directory&#39;].&#39;/actions.php&#39;))
                {
                    include_once(STPATH .&#39;plugins/&#39;.$plugin[&#39;directory&#39;].&#39;/actions.php&#39;);
                    $class = $plugin[&#39;name&#39;].&#39;_actions&#39;;
                    if (class_exists($class))  
                    {
                        //初始化所有插件
                        new $class($this);
                    }
                }
            }
        }
        #此处做些日志记录方面的东西
    }
     
    /**
     * 注册需要监听的插件方法（钩子）
     *
     * @param string $hook
     * @param object $reference
     * @param string $method
     */
    function register($hook, &$reference, $method)
    {
        //获取插件要实现的方法
        $key = get_class($reference).&#39;->&#39;.$method;
        //将插件的引用连同方法push进监听数组中
        $this->_listeners[$hook][$key] = array(&$reference, $method);
        #此处做些日志记录方面的东西
    }
    /**
     * 触发一个钩子
     *
     * @param string $hook 钩子的名称
     * @param mixed $data 钩子的入参
     *    @return mixed
     */
    function trigger($hook, $data=&#39;&#39;)
    {
        $result = &#39;&#39;;
        //查看要实现的钩子，是否在监听数组之中
        if (isset($this->_listeners[$hook]) && is_array($this->_listeners[$hook]) && count($this->_listeners[$hook]) > 0)
        {
            // 循环调用开始
            foreach ($this->_listeners[$hook] as $listener)
            {
                // 取出插件对象的引用和方法
                $class =& $listener[0];
                $method = $listener[1];
                if(method_exists($class,$method))
                {
                    // 动态调用插件的方法
                    $result .= $class->$method($data);
                }
            }
        }
        #此处做些日志记录方面的东西
        return $result;
    }
}
?>

 

#以上程式碼加上註解不超過100行，就完成了整個插件機制的核心。需要再次說明的是，你必須將它設定成全域類，在所有 需要用到插件的地方，優先載入。用#註解的地方是你需要自行完成的部分，包括插件的取得和日誌記錄等等。

下面是一個簡單外掛的實作。　　　　

<?
/**
* 这是一个Hello World简单插件的实现
*
* @package        DEMO
* @subpackage    DEMO
* @category    Plugins
* @author        Saturn
*/
/**
*需要注意的几个默认规则：
*    1. 本插件类的文件名必须是action
*    2. 插件类的名称必须是{插件名_actions}
*/
class DEMO_actions
{
    //解析函数的参数是pluginManager的引用
    function __construct(&$pluginManager)
    {
        //注册这个插件
        //第一个参数是钩子的名称
        //第二个参数是pluginManager的引用
        //第三个是插件所执行的方法
        $pluginManager->register(&#39;demo&#39;, $this, &#39;say_hello&#39;);
    }
     
    function say_hello()
    {
        echo &#39;Hello World&#39;;
    }
}
?>

 

這是一個簡單的Hello World插件，用於輸出一句話。在實際情況中，say_hello可能包含對資料庫的操作，或是其他一些特定的邏輯，例如呼叫Akimet API。

外掛實作的預設規則由核心系統開發者自行決定。例如本例的一些預設規則我在註解中已經寫的很清楚，在此不在贅述。需要特別注意的是鉤子名稱不要重複。

最後一步，就是定義鉤子的觸發，你將鉤子放在哪裡，上面這個插件的方法就會在哪裡出發。例如我要將say_hello放到我部落格首頁Index.php， 那你在index.php中的某個位置寫下：

$pluginManager->trigger('demo','');

第一個參數表示鉤子的名字，在本例中它是demo;第二個參數是插件對應方法的入口參數，由於這個例子中沒有輸入參數，所以為空。

總結 

這篇文章介紹了外掛程式機制在PHP中實現的一種方法和思路，以及我自己對外掛機制的理解。初次接觸這個東西，可能會比較生澀，難以理解。但當你結合真實的 例子，再想想程式的運作流程，想法可能會更清晰一些。效果圖：

 

#

以上是php怎麼把檔案設定為插件的詳細內容。更多資訊請關注PHP中文網其他相關文章！