php把文件设置为插件的技巧方法
发布:smiling 来源: PHP粉丝网 添加日期:2022-02-09 12:13:44 浏览: 评论:0
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;第二个参数是插件对应方法的入口参数,由于这个例子中没有输入参数,所以为空。
Tags: php文件设置为插件
- 上一篇:PHP如何使用JWT做Api接口身份认证的实现
- 下一篇:最后一页
推荐文章
热门文章
最新评论文章
- 写给考虑创业的年轻程序员(10)
- PHP新手上路(一)(7)
- 惹恼程序员的十件事(5)
- PHP邮件发送例子,已测试成功(5)
- 致初学者:PHP比ASP优秀的七个理由(4)
- PHP会被淘汰吗?(4)
- PHP新手上路(四)(4)
- 如何去学习PHP?(2)
- 简单入门级php分页代码(2)
- php中邮箱email 电话等格式的验证(2)