1. 程式人生 > 程式設計 >php把檔案設定為外掛的技巧方法

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(

    #  'name' => '外掛名稱',#  'directory'=>'外掛安裝目錄'

    #);

    $plugins = get_active_plugins();#這個函式請自行實現

    if($plugins)

    {

      foreach($plugins as $plugin)

      {//假定每個外掛資料夾中包含一個actions.php檔案,它是外掛的具體實現

        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);

          }

        }

      }

    }

    #此處做些日誌記錄方面的東西

  }

   

  /**

   * 註冊需要監聽的外掛方法(鉤子)

   *

   * @param string $hook

   * @param object $reference

   * @param string $method

   */

  function register($hook,&$reference,$method)

  {

    //獲取外掛要實現的方法

    $key = get_class($reference).'->'.$method;

    //將外掛的引用連同方法push進監聽陣列中

    $this->_listeners[$hook][$key] = array(&$reference,$method);

    #此處做些日誌記錄方面的東西

  }

  /**

   * 觸發一個鉤子

   *

   * @param string $hook 鉤子的名稱

   * @param mixed $data 鉤子的入參

   *  @return mixed

   */

  function trigger($hook,$data='')

  {

    $result = '';

    //檢視要實現的鉤子,是否在監聽陣列之中

    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('demo',$this,'say_hello');

  }

   

  function say_hello()

  {

    echo 'Hello World';

  }

}

?>

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

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

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

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

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

總結

本篇文章介紹了外掛機制在PHP中實現的一種方法和思路,以及我本人對外掛機制的理解。初次接觸這個東西,可能會比較生澀,難以理解。但是當你結合真實的 例子,再想想程式的執行流程,思路可能會更清晰一些。如果大家還有任何補充可以聯絡我們小編。