discuzX2插件制作教程__最菜鸟级别的入门坎

2021-03-21 1316 0条评论

一、开发插件所需资料与工具
      1、DiscuzX2 插件机制   http://dev.discuz.org/wiki/#.E6.8F.92.E4.BB.B6.E6.9C.BA.E5.88.B6
      2、语言包编码转换工具 convertz  【百度一下】（专门用来处理多种编码的插件安装）
      3、数据库管理工具 navicat 【百度一下】（方便数据库的查看与操作）
      4、网站的基本数据，这些数据包括：系统常量、全局变量、系统调用，首先从系统常量说起
         4.1、系统常量

DISCUZ_ROOT //网站根目录

TIMESTAMP //程序执行的时间戳

CHARSET //程序的语言编码类型

               IS_ROBOT          //是否是机器访问
               FORMHASH       //HASH值
               其余的可直接打印出来查看，如：

<?php
require_once './source/class/class_core.php';
$discuz = & discuz_core::instance();
$discuz->init();
print_r(get_defined_constants());
?>

复制代码

4.2、全局变量
直接打印$_G即可得知，如：

<?php
require_once './source/class/class_core.php';
$discuz = & discuz_core::instance();
$discuz->init();
print_r($_G);
?>

复制代码

4.3、数据库配置参数
直接打印$_G['config']['db']即可，如：

<?php
require_once './source/class/class_core.php';
$discuz = & discuz_core::instance();
$discuz->init();
print_r($_G['config']['db']);
?>

复制代码

         4.4、数据库操作
               DB::table()          //增加了pre的数据库表名
               DB::delete()          //删除表中数据
               DB::insert()          //向表中插入数据
               DB::update()          //更新表中数据
               DB::fetch()          //配合DB::query来实现数据资源数据的获取
               DB::query()          //执行一条数据库语句
               DB::fetch_first()  //获取结果集的第一条记录

               更多操作请查看文档： http://dev.discuz.org/wiki/index.php?title=Discuz%E6%95%B0%E6%8D%AE%E5%BA%93%E7%B1%BB

      5、熟悉 ./source/function/function_admincp.php 管理后台文件里的函数，知道具体函数是实现什么功能效果
      6、了解和掌握基础通用的类、函数   http://dev.discuz.org/wiki/#.E5.9F.BA.E7.A1.80.E6.A1.86.E6.9E.B6.E3.80.81.E7.B1.BB.E3.80.81.E5.87.BD.E6.95.B0

      二、安全性处理
         1、文件的安全性
         所有与插件有关的程序，包括全部的前后台程序，因全部使用外壳调用，请务必在第一行加入
            if(!defined('IN_DISCUZ')) {
                     exit('Access Denied');
            }
         以免其被 URL 直接请求调用，产生安全问题。

         2、对数值处理
         2.1、 intval(); //处理非负整数，如：$uid=intval($uid);
              注意，使用intval后，一定要想一想，自己这个变量是不是应该非负的？如果是的话，得加个判断语句，或者用abs,max等函数处理下
         2.2、 trim();    //去除左右空格，如：$username=trim($username);
         2.3、对于文字内容，记得使用htmlspecialchars（dhtmlspecialchars）
         2.4、写入数据库时的注意事项
               要进数据库的变量一定得addslashes(DZ内为daddslashes,如用DZ无须再次过滤,DZ已将所有$_POST和$_GET过滤)，当然，如果你进的是数字（比如uid，并且已经intval过），或者是其他一些肯定不会出错的，那么你可以不做这一步。
         2.5、在写sql语句时，变量一定得记得用’框起来。如果变量是字符串，不这么做会出错。如果是数字不这么做不会提示出错，但是有可能有注入的危险。
         2.6、数组在运用前记得写$xxx = array();  原因很简单,防止用户提交恶意的值。

         3、语句查询优化
            在写SQL语句是尽量符合SQL规则，语句查询要相应的优化，有先有后；数据表要相应的创建索引，加快查询速度，这里不多说。

   三、实例讲解之插件的前兆
         1、最先清楚需要开发什么功能的插件，插件机制是否能够开发，最后能否达到预期效果，否则一切都免谈了
         2、需要使用什么菜单、什么参数，配置哪些选项、数据结构如何设计、前后台实现哪些功能等等
         3、需要哪些函数，discuz内部是否有这功能的函数，尽量用内部的函数来达到预期效果
         4、最好不要改动discuz原有的布局，宁愿Coty一段代码出来也不要在原有的函数上添加功能，防止以后的升级问题
         5、尽最大能力去开发智能的插件，多用变量代替常量，增强程序的移植性，可维护性

      四、实例讲解之基本配置
         1、安装全新的DiscuzX2
         2、打开 config/config_global.php 文件，在文件结尾添加以下代码开启插件设计者模式

$_config['plugindeveloper'] = 2; //1 表示开启插件设计者模式；2 表示开启插件设计者模式且显示前台页面的潜入点

         3、更新缓存（为了显示潜入点），刷新前台页面看看就知道什么叫嵌入点了，有嵌入点得地方就可以顺便输出内容，包括源码


      五、实例讲解之管理中心
           1、这里以“会员注册后自动送100个金币”为例（主要传授对数据库的操作）
         2、填写插件最基本信息


         3、选择插件语言包




         4、添加插件变量配置

               具体可以点最后面的"详细"进入编辑

         5、在插件列表中找到"新注册会员送100个金币"插件并启用


六、实例讲解之页面嵌入
      1、插件页面嵌入-普通版

      2、在 ./source/plugin/send_jinbi/ 目录下建立 send_jinbi.class.php 文件，目的为了页面嵌入

<?php
if(!defined('IN_DISCUZ')) {
        exit('Access Denied');
}
class plugin_send_jinbi { 
       function global_header() {
            global $_G;
            $sendConfig = array();
            $sendConfig = $_G['cache']['plugin']['send_jinbi'];  //缓存插件变量值
            if( intval($sendConfig['status']) == 1 ) {  //是否启动插件
                 if( isset($_POST['regsubmit']) ) { //会员注册后
                      $uid = intval($_G['member']['uid']);
                      if( $uid ){
                         $jinbi_num = intval($sendConfig['jinbi_num']);  //送金币数量
                         updatemembercount($uid,array("extcredits2" => $jinbi_num)); //更新金币数 （这个是function_core.php的现成函数）
                        //这里可以进行任何数据库的操作
                      }
                 }
             }
      }
}
?>

复制代码

      3、基本上已经完成一大半了，你只要开启插件，然后更新缓存（可靠点），然后到前台去注册一个会员，则会自动送上100金币。

     七、实例讲解之安装、卸载及升级
         1、安装（install.php）、卸载（uninstall.php）程序中可随意设计页面的跳转，只要在插件安装、卸载结束时候输出添加 $finish = TRUE; 即可，脚本中可用 runquery() 函数执行 SQL 语句。

<?php
if(!defined('IN_DISCUZ')) {
       exit('Access Denied');
}
/*任意执行代码：开始*/
//..........
//..........
/*任意执行代码：结束*/
$finish = TRUE;
?>

2、升级（upg rade.php）程序中可通过 $fromversion 和 $toversion 变量判断升级的具体版本号，并随意设计页面的跳转，只要在插件升级结束时候输出添加 $finish = TRUE; 即可，脚本中可用 runquery() 函数执行 SQL 语句。

<?php
if(!defined('IN_DISCUZ')) {
        exit('Access Denied');
}
/*任意执行代码：开始*/
//..........
//..........
/*任意执行代码：结束*/
$finish = TRUE;
?>

3、其他功能请参考其他插件

八、实例讲解之插件语言包
         1、打开之前所创建的语言包文件（data/plugindata/send_jinbi.lang.php），添加以下代码，红色部分为插件的唯一标识符：
<?php
//程序脚本文件的语言包
$scriptlang[' send_jinbi '] = array(
   'info' => '程序脚本文件的语言包'
);

//模版文件的语言包
$templatelang[' send_jinbi '] = array(
   'info' => '模板文件的语言包'
);

//安装、升级、卸载脚本用的语言包
$installlang[' send_jinbi '] = array(
   'info' => '安装、升级、卸载脚本用的语言包'
);
?>

2、调用语言包
            模版中调用模板文件语言包，通过 {lang send_jinbi:info} 方式调用。
            程序脚本中调用脚本文件语言包，通过 lang('plugin/send_jinbi', 'info') 方式调用。
            安装脚本中调用安装脚本文件语言包，通过 $installlang 变量直接获取。如 $installlang['info']。

      3、语言包的导出

            导出后的语言包是：discuz_plugin_send_jinbi.xml
            接下来我们用编码转换工具 convertz  对discuz_plugin_send_jinbi.xml 分别转为：
            discuz_plugin_send_jinbi_SC_GBK.xml（简体中文GBK）
            discuz_plugin_send_jinbi_SC_UTF8.xml（简体中文UTF8）
            discuz_plugin_send_jinbi_TC_BIG5.xml（繁体中文BIG5）
            discuz_plugin_send_jinbi_TC_UTF8.xml（繁体中文UTF8）
            把这四个文件放到该插件 ./source/plugin/send_jinbi/  目录下

         4、安装时的效果图：


   九、实例讲解之增加页面功能

         1、在原有的页面上添加功能（这里以注册页面为例）


         2、在之前那个 ./source/plugin/send_jinbi/send_jinbi.class.php 的最后添加以下代码：

class plugin_send_jinbi_member extends plugin_send_jinbi {//类名称plugin_send_jinbi_member 最后面的 member 应该是相应的模块名称吧！具体本人不怎么清楚，还望高人指点！总之它是会改变的，如果是论坛，则是 forum
        function register_input() {  //函数名称其实就是前台页面嵌入点的名称
                $lang = lang('plugin/send_jinbi');  //获取此插件的语言包
                $bind = "<a href='javascript:void(0);' onClick=\"alert('别点我');\">".$lang['info']."</a>";  //调用语言包显示
                return $bind;
        }
}

3、更新下缓存，再到前台注册页面看看效果