我正在用 PHP 启动一个新的 Web 应用程序，这一次我想创建一些人们可以通过使用插件接口进行扩展的东西。
如何在他们的代码中编写“钩子”以便插件可以附加到特定事件？
问问题
39495 次
8 回答
167
您可以使用观察者模式。实现此目的的简单功能方法：
<?php
/** Plugin system **/
$listeners = array();
/* Create an entry point for plugins */
function hook() {
global $listeners;
$num_args = func_num_args();
$args = func_get_args();
if($num_args < 2)
trigger_error("Insufficient arguments", E_USER_ERROR);
// Hook name should always be first argument
$hook_name = array_shift($args);
if(!isset($listeners[$hook_name]))
return; // No plugins have registered this hook
foreach($listeners[$hook_name] as $func) {
$args = $func($args);
}
return $args;
}
/* Attach a function to a hook */
function add_listener($hook, $function_name) {
global $listeners;
$listeners[$hook][] = $function_name;
}
/////////////////////////
/** Sample Plugin **/
add_listener('a_b', 'my_plugin_func1');
add_listener('str', 'my_plugin_func2');
function my_plugin_func1($args) {
return array(4, 5);
}
function my_plugin_func2($args) {
return str_replace('sample', 'CRAZY', $args[0]);
}
/////////////////////////
/** Sample Application **/
$a = 1;
$b = 2;
list($a, $b) = hook('a_b', $a, $b);
$str = "This is my sample application\n";
$str .= "$a + $b = ".($a+$b)."\n";
$str .= "$a * $b = ".($a*$b)."\n";
$str = hook('str', $str);
echo $str;
?>
输出：
This is my CRAZY application
4 + 5 = 9
4 * 5 = 20
笔记：
对于此示例源代码，您必须在要扩展的实际源代码之前声明所有插件。我已经包含了一个如何处理传递给插件的单个或多个值的示例。最困难的部分是编写实际文档，其中列出了传递给每个钩子的参数。
这只是在 PHP 中完成插件系统的一种方法。还有更好的选择，我建议您查看 WordPress 文档以获取更多信息。
于 2008-08-01T13:46:00.097 回答
61
所以假设你不想要观察者模式，因为它要求你改变你的类方法来处理监听任务，并且想要一些通用的东西。假设您不想使用extends继承，因为您可能已经在您的类中从其他类继承。有一种通用的方法可以不费力地使任何类可插入，这不是很好吗？就是这样：
<?php
////////////////////
// PART 1
////////////////////
class Plugin {
private $_RefObject;
private $_Class = '';
public function __construct(&$RefObject) {
$this->_Class = get_class(&$RefObject);
$this->_RefObject = $RefObject;
}
public function __set($sProperty,$mixed) {
$sPlugin = $this->_Class . '_' . $sProperty . '_setEvent';
if (is_callable($sPlugin)) {
$mixed = call_user_func_array($sPlugin, $mixed);
}
$this->_RefObject->$sProperty = $mixed;
}
public function __get($sProperty) {
$asItems = (array) $this->_RefObject;
$mixed = $asItems[$sProperty];
$sPlugin = $this->_Class . '_' . $sProperty . '_getEvent';
if (is_callable($sPlugin)) {
$mixed = call_user_func_array($sPlugin, $mixed);
}
return $mixed;
}
public function __call($sMethod,$mixed) {
$sPlugin = $this->_Class . '_' . $sMethod . '_beforeEvent';
if (is_callable($sPlugin)) {
$mixed = call_user_func_array($sPlugin, $mixed);
}
if ($mixed != 'BLOCK_EVENT') {
call_user_func_array(array(&$this->_RefObject, $sMethod), $mixed);
$sPlugin = $this->_Class . '_' . $sMethod . '_afterEvent';
if (is_callable($sPlugin)) {
call_user_func_array($sPlugin, $mixed);
}
}
}
} //end class Plugin
class Pluggable extends Plugin {
} //end class Pluggable
////////////////////
// PART 2
////////////////////
class Dog {
public $Name = '';
public function bark(&$sHow) {
echo "$sHow<br />\n";
}
public function sayName() {
echo "<br />\nMy Name is: " . $this->Name . "<br />\n";
}
} //end class Dog
$Dog = new Dog();
////////////////////
// PART 3
////////////////////
$PDog = new Pluggable($Dog);
function Dog_bark_beforeEvent(&$mixed) {
$mixed = 'Woof'; // Override saying 'meow' with 'Woof'
//$mixed = 'BLOCK_EVENT'; // if you want to block the event
return $mixed;
}
function Dog_bark_afterEvent(&$mixed) {
echo $mixed; // show the override
}
function Dog_Name_setEvent(&$mixed) {
$mixed = 'Coco'; // override 'Fido' with 'Coco'
return $mixed;
}
function Dog_Name_getEvent(&$mixed) {
$mixed = 'Different'; // override 'Coco' with 'Different'
return $mixed;
}
////////////////////
// PART 4
////////////////////
$PDog->Name = 'Fido';
$PDog->Bark('meow');
$PDog->SayName();
echo 'My New Name is: ' . $PDog->Name;
在第 1 部分中，您可能会require_once()在 PHP 脚本顶部的调用中包含这些内容。它加载类以使某些东西可插入。
在第 2 部分中，我们加载了一个类。注意我不需要对这个类做任何特别的事情，这与观察者模式有很大的不同。
在第 3 部分中，我们将类转换为“可插入的”（即支持让我们覆盖类方法和属性的插件）。因此，例如，如果您有一个网络应用程序，您可能有一个插件注册表，您可以在此处激活插件。还要注意Dog_bark_beforeEvent()函数。如果我$mixed = 'BLOCK_EVENT'在 return 语句之前设置，它会阻止狗吠，也会阻止 Dog_bark_afterEvent，因为不会有任何事件。
在第 4 部分中，这是正常的操作代码，但请注意，您可能认为会运行的代码根本不会这样运行。例如，这只狗并没有宣布它的名字是“Fido”，而是“Coco”。狗不叫“喵”，而是“汪”。当你事后想看狗的名字时，你会发现它是“不同”而不是“可可”。所有这些覆盖都在第 3 部分中提供。
那么这是如何工作的呢？好吧，让我们排除eval()（每个人都说它是“邪恶的”）并排除它不是观察者模式。因此，它的工作方式是一个名为 Pluggable 的偷偷摸摸的空类，它不包含 Dog 类使用的方法和属性。因此，既然发生了这种情况，魔法方法就会为我们服务。这就是为什么在第 3 部分和第 4 部分中，我们混淆了从 Pluggable 类派生的对象，而不是 Dog 类本身。相反，我们让 Plugin 类为我们对 Dog 对象进行“触摸”。（如果这是我不知道的某种设计模式——请告诉我。）
于 2009-06-01T05:59:16.400 回答
36
钩子和侦听器方法是最常用的，但您还可以做其他事情。根据您的应用程序的大小，以及您将允许谁查看代码（这将是 FOSS 脚本还是内部的东西）将极大地影响您希望如何允许插件。
kdeloach 有一个很好的例子，但是他的实现和钩子函数有点不安全。我会要求你提供更多关于你写作的 php 应用程序性质的信息，以及你如何看待插件的适合性。
+1 向我发送 kdeloach。
于 2008-08-01T17:23:43.777 回答
26
这是我使用过的一种方法，它试图从 Qt 信号/插槽机制中复制，一种观察者模式。对象可以发出信号。每个信号在系统中都有一个 ID - 它由发送者的 id + 对象名称组成 每个信号都可以绑定到接收者，这只是一个“可调用” 您使用总线类将信号传递给任何有兴趣接收它们的人 当某事发生时，你“发送”一个信号。下面是示例实现
<?php
class SignalsHandler {
/**
* hash of senders/signals to slots
*
* @var array
*/
private static $connections = array();
/**
* current sender
*
* @var class|object
*/
private static $sender;
/**
* connects an object/signal with a slot
*
* @param class|object $sender
* @param string $signal
* @param callable $slot
*/
public static function connect($sender, $signal, $slot) {
if (is_object($sender)) {
self::$connections[spl_object_hash($sender)][$signal][] = $slot;
}
else {
self::$connections[md5($sender)][$signal][] = $slot;
}
}
/**
* sends a signal, so all connected slots are called
*
* @param class|object $sender
* @param string $signal
* @param array $params
*/
public static function signal($sender, $signal, $params = array()) {
self::$sender = $sender;
if (is_object($sender)) {
if ( ! isset(self::$connections[spl_object_hash($sender)][$signal])) {
return;
}
foreach (self::$connections[spl_object_hash($sender)][$signal] as $slot) {
call_user_func_array($slot, (array)$params);
}
}
else {
if ( ! isset(self::$connections[md5($sender)][$signal])) {
return;
}
foreach (self::$connections[md5($sender)][$signal] as $slot) {
call_user_func_array($slot, (array)$params);
}
}
self::$sender = null;
}
/**
* returns a current signal sender
*
* @return class|object
*/
public static function sender() {
return self::$sender;
}
}
class User {
public function login() {
/**
* try to login
*/
if ( ! $logged ) {
SignalsHandler::signal(this, 'loginFailed', 'login failed - username not valid' );
}
}
}
class App {
public static function onFailedLogin($message) {
print $message;
}
}
$user = new User();
SignalsHandler::connect($user, 'loginFailed', array($Log, 'writeLog'));
SignalsHandler::connect($user, 'loginFailed', array('App', 'onFailedLogin'));
$user->login();
?>
于 2008-09-25T21:29:22.613 回答
19
我相信最简单的方法是遵循 Jeff 自己的建议并查看现有代码。尝试查看 WordPress、Drupal、Joomla 和其他著名的基于 PHP 的 CMS，以了解他们的 API 挂钩的外观和感觉。通过这种方式，您甚至可以获得以前可能没有想到的想法，从而使事情变得更加强大。
一个更直接的答案是将他们将“include_once”写入他们的文件中的通用文件，这将提供他们需要的可用性。这将被分成几类，而不是在一个 MASSIVE “hooks.php”文件中提供。不过要小心，因为最终会发生的是它们包含的文件最终具有越来越多的依赖关系和功能改进。尽量保持 API 依赖性低。IE 更少的文件供他们包含。
于 2008-08-01T13:44:35.843 回答
16
雅虎的 Matt Zandstra 有一个名为Stickleback的简洁项目，它处理 PHP 中处理插件的大部分工作。
它强制执行插件类的接口，支持命令行接口，并且启动和运行并不难——尤其是如果您在PHP 架构师杂志中阅读了关于它的封面故事。
于 2008-09-17T19:00:33.390 回答
9
我很惊讶这里的大多数答案似乎都是针对 Web 应用程序本地的插件，即在本地 Web 服务器上运行的插件。
如果您希望插件在不同的远程服务器上运行怎么办？最好的方法是提供一个表单，允许您定义在应用程序中发生特定事件时将调用的不同 URL。
不同的事件会根据刚刚发生的事件发送不同的信息。
这样，您只需对已提供给您的应用程序（例如通过 https）的 URL 执行 cURL 调用，远程服务器可以根据您的应用程序发送的信息执行任务。
这提供了两个好处：
- 您不必在本地服务器上托管任何代码（安全性）
- 代码可以在远程服务器上（可扩展性），使用 PHP 以外的其他语言（可移植性）
于 2013-04-22T07:41:24.147 回答