PHP項目中很多用到插件的地方,更尤其是基礎程序寫成之后很多功能由第三方完善開發的時候,更能用到插件機制,現在說一下插件的實現。特點是無論你是否激活,都不影響主程序的運行,即使是刪除也不會影響。
從一個插件安裝到運行過程的角度來說,主要是三個步驟:
1.插件安裝(把插件信息收集進行采集和記憶的過程,比如放到數據庫中或者XML中)
2.插件激活(打開插件,讓監聽插件的地方開始進行調用)
3.插件運行(插件功能的實現)
從一個插件的運行上來說主要以下幾點:
1.插件的動態監聽和加載(插件的信息獲取)
2.插件的動態觸發(插件的運行)
一個完善的插件系統主要包括以下:
1.插件安裝及卸載
2.插件打開與關閉
3.插件信息獲取
4.插件調度(插件經理)
5.插件主體
在程序的編寫上主要實現以下:
1.插件的注冊和初始化
2.判斷激活條件
3.鉤子激活
4.運行插件
實例代碼:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
|
<?php /** * PluginManager Class * * 插件機制的實現核心類 * * @link http://www.ythuaji.com.cn/ */ 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();#這個函數請自行實現 //函數實現后的最終數據結構效果如下 $plugins = array ( array ( "directory" => "demo" , "name" => "DEMO" )); 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 )) { //初始化所有插件 //$this 是本類的引用 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 ; } } define(STPATH, "./" ); $pluginManager = new PluginManager(); $pluginManager ->trigger( "demo" ); |
demo插件文件:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
|
<?php /** * 這是一個Hello World簡單插件的實現 * * @link http://www.ythuaji.com.cn/ */ /** *需要注意的幾個默認規則: * 1. 本插件類的文件名必須是action * 2. 插件類的名稱必須是{插件名_actions} */ class DEMO_actions { //解析函數的參數是pluginManager的引用 function __construct(& $pluginManager ) { //注冊這個插件 //第一個參數是鉤子的名稱 //第二個參數是pluginManager的引用 //第三個是插件所執行的方法 $pluginManager ->register( 'demo' , $this , 'say_hello' ); } function say_hello() { echo 'Hello World' ; } } |