插件,亦即Plug-in,是指一类特定的功能模块(通常由第三方开发者实现)
它的特点:
1. 随时安装、卸载、激活、禁用
2. 无论什么状态都不影响系统核心模块的运行,
3. 是一种非侵入式的模块化设计,实现了核心程序与插件程序的松散耦合。
一个健壮的PHP插件机制,我认为必须具备以下特点:
1. 插件的动态监听和加载(Lookup)
2. 插件的动态触发
以上两点的PHP插件机制实现均不影响核心程序的运行
钩子(Hooks)
要在程序中实现插件,我们首先应该想到的就是定义不同的钩子(Hooks);“钩子”是一个很形象的逻辑概念,你可以认为它是系统预留的插件触发条件。
它的逻辑原理如下:
当系统执行到某个钩子时,会判断这个钩子的条件是否满足;
如果满足,会转而先去调用钩子所制定的功能,然后返回继续执行余下的程序;
如果不满足,跳过即可。这有点像汇编中的“中断保护”逻辑。
某些钩子可能是系统事先就设计好的,比如之前我举的关于评论Spam过滤的钩子,通常它已经由核心系统开发人员设计进了评论的处理逻辑中;另外一类钩子则可能是由用户自行定制的(由第三方开发人员制定),通常存在于表现层,比如一个普通的PHP表单显示页面中。
整个机制核心分为三大块:
1.一个插件经理类:
这是核心之核心。它是一个应用程序全局Global对象。它主要有三个职责:
负责监听已经注册了的所有插件,并实例化这些插件对象。
负责注册所有插件。
当钩子条件满足时,触发对应的对象方法。
2.插件的功能实现:
这大多由第三方开发人员完成,但需要遵循一定的规则,这个规则是插件机制所规定的,因插件机制的不同而不同,下面的显示代码你会看到这个规则。
3.插件的触发:
也就是钩子的触发条件。具体来说这是一小段代码,放置在你需要插件实现的地方,用于触发这个钩子。
插件经理PluginManager类:
1 <?php 2 3 class PluginManager { 4 5 private $_listeners = array(); 6 7 public function __construct() { 8 //这里$plugin数组包含我们获取已经由用户 9 //激活的插件信息 10 //为演示方便,我们假定$plugin中至少包含 11 //$plugin = array( 12 // 'name' => '插件名称', 13 // 'directory'=>'插件安装目录' 14 //); 15 $plugins = array( 16 array( 17 'name' => '插件名称', 18 'directory' => '插件安装目录' 19 ) 20 ); 21 //这个函数请自行实现 22 if ($plugins) { 23 foreach ($plugins as $plugin) { 24 ////假定每个插件文件夹中包含一个actions. 25 //php文件,它是插件的具体实现 26 if (@file_exists(STPATH . 'plugins/' . $plugin['directory'] . '/actions.php')) { 27 include_once(STPATH . 'plugins/' . $plugin['directory'] . '/actions.php'); 28 $class = $plugin['name'] . '_actions'; 29 if (class_exists($class)) { 30 //初始化所有插件 31 new $class($this); 32 } 33 } 34 } 35 } 36 //此处做些日志记录方面的东西 37 } 38 39 function register($hook, &$reference, $method) { 40 //获取插件要实现的方法 41 $key = get_class($reference) . '->' . $method; 42 //将插件的引用连同方法push进监听数组中 43 $this->_listeners[$hook][$key] = 44 array(&$reference, $method); 45 //此处做些日志记录方面的东西 46 } 47 48 function trigger($hook, $data = '') { 49 $result = ''; 50 //查看要实现的钩子,是否在监听数组之中 51 if (isset($this->_listeners[$hook]) && is_array($this->_listeners[$hook]) && count($this->_listeners[$hook]) > 0) { 52 // 循环调用开始 53 foreach ($this->_listeners[$hook] as $listener) { 54 // 取出插件对象的引用和方法 55 $class = & $listener[0]; 56 $method = $listener[1]; 57 if (method_exists($class, $method)) { 58 // 动态调用插件的方法 59 $result .= $class->$method($data); 60 } 61 } 62 } 63 //此处做些日志记录方面的东西 64 return $result; 65 } 66 67 } 68 69 ?>