在 Joomla! 1.5 中创建插件

如何创建自己的插件

本文将展示开发你自己的插件所需的基本知识。大部分插件仅包含一个单独的代码文件，但为了正确地安装插件，必须将它打包成 Joomla! 安装程序(installer)能够识别和处理的安装文件。

创建安装文件

同 Joomla! 的其他扩展附件一样，打包成 .zip 文件(或 .tar.gz 文件)的插件安装起来十分容易，不过安装包中必须包含一个格式正确的 XML 文件。这里有一个例子，是目录搜索机器人(categories searchbot)插件的 XML 安装文件：

<?xml version="1.0" encoding="iso-8859-1"?>
<install version="1.5" type="plugin" group="search">
    <name>Categories searchbot</name>
    <author>Joomla! Project</author>
    <creationDate>November 2005</creationDate>
    <copyright>(C) 2005 Open Source Matters. All rights reserved.</copyright>
    <license>GNU/GPL</license>
    <authorEmail> 为防备电子邮件地址收集器，这个 E-mail 地址被隐藏，你的浏览器必须支持 Javascript 才可看到这个邮件地址 </authorEmail>
    <authorUrl>www.joomla.org</authorUrl>
    <version>1.1</version>
    <description>Allows searching of Categories information</description>
    <files>
        <filename plugin="categories.searchbot">categories.searchbot.php</filename>
    </files>
    <params>
        <param name="search_limit" type="text" size="5" default="50" label="Search Limit" description="Number of search items to return"/>
    </params>
</install>

正如你所看到的，它与其他 Joomla! XML 安装文件非常相似。你只需找到 <install> 标签中的属性 group=”xxx”，以及 <filename> 标签中的信息。这些信息告诉 Joomla! 这个插件属于哪一个类别(group)，及应当把文件复制到哪个文件夹下。

创建插件

Joomla! 1.5 提供了一种新的、更符合对象思想的方式来编写插件。为了向前兼容，旧的方式仍然可以使用(见下一小节)。

<?php
// 禁止直接访问
defined( '_JEXEC' ) or die( 'Restricted access' );

// 导入所需的库文件
jimport('joomla.event.plugin');

class plg<PluginGroup><PluginName> extends JPlugin
{
    /**
    * 构造函数
* 为兼容 php4，我们不能直接使用 __constructor 作为插件的构架函数，因为 func_get_args ( void )
* 返回的是所有参数的拷贝，而不是引用，在交叉引用——这在观察者(observer)设计模式中是必须的——
* 将导致错误。
*/
    function plg<PluginGroup><PluginName>( &$subject )
    {
            parent::__construct( $subject );

            // load plugin parameters
            $this->_plugin = > JPluginHelper::getPlugin( '<GroupName>', '<PluginName>' );
            $this->_params = new JParameter( $this->_plugin->params );
    }

    /**
    * 与事件同名的插件方法将被自动调用。
    */
    function <EventName>()
    {
        global $mainframe;

// Plugin code goes here.

return true;
}

}

创建插件(兼容模式)

这一节中将介绍 Joomla! 1.5 之前的版本中使用的插件编写方法，出于向前兼容的目的，这种方法目前仍然受支持。部分 Joomla! 核心插件可能仍然使用这种方式编写，不过随着时间推移，这些插件将逐步被重写。
你希望在事件触发时执行的代码应该被写成 PHP 函数的形式。在函数定义之前，你应当调用 registerEvent() 方法，以使 Joomla! 事件系统能将你的函数和相应的事件关联起来。
请看以下的代码框架示意：

<?php
// no direct access
defined( '_JEXEC' ) or die( 'Restricted access' );

$mainframe->registerEvent( '<EventName>', '<FunctionName>' );

function <FunctionName>( <ParameterList> ) {

//Plugin code goes here

}

通过函数 $mainframe→registerEvent()，你的插件在 Joomla! 事件系统中通过注册。这意味着在此之后，当名为 ‘<EventName>’ 的事件被触发时，函数 ‘<FunctionName>’ 将被调用。
现在，你可以编写任何你想要的插件函数了。如果你想给函数添加参数，没问题，就像平常一样使用它们。你可以在一个文件里注册任意多个事件和插件函数。完成之后，你的插件就可用了。