使脚本可插件化

Question

我正在编写一个脚本，我需要让它可插入。现在我提供的并且应该对我有用的语法是让它使用类。例如，为了创建一个在达到某个点（钩子）时运行的新插件，您将声明一个新类。我不确定如何在该语法中指定钩子，所以我正在寻找建议。

语法示例：

<?php
class ScriptPlugin
{
    function runPlugin() {} // would be run when the time has to come to execute this plugin
}
?>

另外，如果那个语法不起作用，如果你们能给我一个很好的语法示例，那就太好了。

Answer 1

我想到了观察者模式。插件会自行注册并在调用钩子时收到通知。

想到的另一件事是 PHP 中的回调。我想到了similar question already 和an answer。它显示基于回调的钩子。

观察者模式 运行起来有点短，因为使用钩子时，您经常希望提供参数和返回值之类的东西。使用回调的链接答案也没有这个，所以我写了一个小Hooks 示例类，为注册的回调提供命名的钩子/事件，以及注册你自己的类的方法，例如一个插件。

这个想法很基本：

• 挂钩有一个名称和零个或多个附加回调。
• 所有挂钩都在 Hooks 类中进行管理。
• 主代码通过调用Hooks 对象上的函数来调用挂钩。
• 插件（和其他类）可以注册自己的回调，这是在Registerable 接口的帮助下完成的。

一个插件和两个钩子的一些示例代码：

<?php
Namespace Addon;

class Hooks
{
    private $hooks = array();
    private $arguments;
    private $name;
    private $return;
    public function __call($name, array $arguments)
    {
        $name = (string) $name;
        $this->name = $name;
        $this->arguments = $arguments;
        $this->return  = NULL;
        foreach($this->getHooks($name) as $hook)
        {
            $this->return = call_user_func($hook, $this);
        }
        return $this->return;
    }
    public function getHooks($name)
    {
        return isset($this->hooks[$name]) ? $this->hooks[$name] : array();
    }
    public function getArguments()
    {
        return $this->arguments;
    }
    public function getName()
    {
        return $this->name;
    }
    public function getReturn()
    {
        return $this->return;
    }
    public function setReturn($return)
    {
        $this->return = $return;
    }
    public function attach($name, $callback)
    {
        $this->hooks[(string) $name][] = $callback;
    }
    public function register(Registerable $plugin)
    {
        $plugin->register($this);
    }
}

interface Registerable
{
    public function register(Hooks $hooks);
}

class MyPlugin implements Registerable
{
    public function register(Hooks $hooks)
    {
        $hooks->attach('postPublished', array($this, 'postPublished'));
        $hooks->attach('postDisplayFilter', array($this, 'filterToUpper'));
    }
    public function postPublished()
    {
        echo "MyPlugin: postPublished.\n";
    }
    public function filterToUpper(Hooks $context)
    {
        list($post) = $context->getArguments();
        return strtoupper($post);
    }
}

$hooks = new Hooks();

$plugin = new MyPlugin();
$hooks->register($plugin);  

$hooks->postPublished();

echo $hooks->postDisplayFilter("Some post text\n");

我这样做是为了防止每个插件必须只有一个具体的基类，因为它想使用钩子。此外，一切都可以注册钩子，唯一需要的是回调。例如一个匿名函数：

$hooks->attach('hookName', function() {echo "Hook was called\n";});

您可以自己创建一个插件基类，例如实现register 函数并自动注册具有特定文档块标签或函数名称的函数

class MyNewPlugin extends PluginSuper
{
    /**
     * @hook postPublished
     */
    public function justAnotherFunction() {}

    public hookPostPublished() {}
}

超类可以利用Reflection 在运行时添加挂钩。然而，反射会减慢速度，并可能使调试变得更加困难。

Answer 2

假设一个插件是这样的：

class NewsPlugin extends Plugin
{
  function onCreate($title)
  {
    # Do some stuff
  }
}

然后，当您创建新闻时，您可以在所有注册的插件上调用 onCreate。

Answer 3

我会为所有可能被调用的钩子创建一个包含函数的基本抽象类。

abstract class Plugin {
    abstract function yourHook();
}

所有插件类都应该继承这个基类，并且会用自己的覆盖这些基函数。

class SomePlugin extends Plugin {
    function yourHook() {
        echo 'yourHook() Called!';
    }
}

现在，当您的程序运行时，您需要找到所有要包含的插件文件，并以某种方式将它们放入一个数组中，例如$plugins。见这篇文章：https://stackoverflow.com/a/599694/362536

foreach (glob("classes/*.php") as $filename)
{
    include $filename;
}

（来自卡斯滕）

定义一个可以从任何东西访问的函数，例如registerPlugin()：

function registerPlugin($classname) {
    $plugins[] = new $classname();
}

使每个插件文件的顶行像这样（在类之前）：

registerPlugin('SomePlugin');

如果您这样做，您将在 $plugins 中拥有一个数组，其中包含每个插件的实例。在适当的时候，你可以这样做：

foreach ($plugins as $plugin) {
    $plugin->yourHook();
}

作为替代方案，在您的情况下使用interfaces 可能更合适。您应该决定哪种方法最适合您的应用程序。