使我的代码易于编写插件

Question

我一直在编写一些创建通用博客的代码。

它的功能很简单，创建帖子，编辑和删除帖子并允许cmets。

我正在尝试编写它以便为它编写插件非常容易，但是我不确定最好的方法。
我的一些想法：

1. 让插件作者编写一个名为“config”的简短脚本，其中他们有一个数组，其中包含应用程序（例如前端、管理等）、模块（例如博客、配置文件等）和操作（例如创建，编辑等），他们的插件会影响，然后在运行正确的操作时包含插件文件。

   //example array in config.php:
   array(
     'application' => 'admin',
     'module'      => 'blog',
     'action'      => array('create','edit')
   );
   

2. 将字符串添加到视图代码中，例如“{form-extras}”，并让插件作者说出代码将替换哪个字符串。然后使用 str_replace 将 {xxx} 替换为插件代码。

   #example code in blog_form.php
   <input type="text" name="blog_title" />
   <input type="text" name="blog_text" />
   {form-extras}
   
   #example code in plugins config.php
   array(
     'replace' => array('form-extras')
   );
   

这两个想法都非常垃圾，而且它们的使用非常有限，但我正在努力想出更好的想法。

我不确定人们需要多少关于我的代码的信息，但基本的目录结构很简单，下面是一个示例：

apps //applications
  frontend  //app name
    modules
      blog
        views
          index.php  //list blogs
          new.php //create new blog post
        actions.class.php
  admin
    modules
      blog
        views
          index.php  //list blogs
          new.php //create new blog post
        actions.class.php
lib //library of classes like database class
plugins //where plugins will hopefully be installed
web //where the site runs e.g index.php, all the css and js

问题

是否有人知道任何关于使代码易于编写插件的教程/文章，或者是否有人有任何我可以应用的经过测试的方法？

问候

卢克

Answer 1

在您开始考虑如何制作插件系统之前，您必须定义插件对您的应用程序而言究竟是什么，插件可以做什么以及插件可以访问哪些数据（例如，posts 表而不是 users 表）。

然后，看看 Drupal，我想它基于 hooks 的模块系统对于开发人员来说非常强大且“简单”。

基本上，这个想法是，当安装模块或插件时，您在“核心”代码上所做的一切，都会搜索是否有一些模块/插件与该操作挂钩。

例子：

//your code
$modules_enabled = array('foo', 'bar');
//example action, lets say insert a new blog post. Obviously, nothings prevent you
//to do that in OOP style (i'd never really understood why drupal is almost all procedural).
function create_new_post($modules_enabled, $other_args){
    //looks if some modules need to be called before create the blog post
    foreach($modules_enables AS $module){
        if(function_exists("after_create_new_post_$module")){
            $func = "before_create_new_post_$module";
            $func($params);
        }
    }
    //do your stuff here
    //looks if some modules need to be called after the post is been created
    foreach($modules_enables AS $module){
        if(function_exists("after_create_new_post_$module")){
            $func = "after_create_new_post_$module";
            $func($params);
        }
    }
}

//the module file should look like $hooks_name . $module_name:
function after_create_new_post_foo($args){
    //do your job
}

这是一个非常简单的例子（而且不起作用！），但应该给你这个想法。

这里唯一的问题是您传递给每个 hook_function 的参数，必须记录得非常好，但是无论您选择什么路径，文档都很重要。

一些参考：Drupal hooks，hook_insert

Answer 2

您正在寻找的是有关插件架构的示例和/或信息。使用这个词，Google 会发现很多资源。

检查在 WordPress、Drupal 或 Joomla 等现有成熟应用程序中如何实现这一点。

同时考虑这个现有问题：Plugin Architecture in PHP