Discuz 插件開發【X3.4】 二次開發 - 在線手冊

admin

驗證插件二次開發

本功能由PHP+MYSQL語言開發，無縫對接新秀網絡驗證系統，采用獨立入口文件、類文件、第三方類文件庫進行調用開發。所有功能實現及控制均采用api接口操作，數據輸出形式為JSON、XML兩種常見形式，達到毫秒級數據快速交換功能。 1、插件開發是結合新秀網絡驗證系統進行的二次開發，不能獨立使用； 2、插件開發遵循Discuz、新秀網絡驗證、PHP語言規范開發； 3、插件開發適用于新秀網絡驗證系統ver6.5版本以后； 4、本功能與新秀網絡驗證系統、擴展框架系統，代碼相互獨立，但功能同時執行； 5、插件開發可使用Discuz內置函數、新秀網絡驗證內置函數、PHP函數。

適用環境：php版本>5.6、Mysql版本>5.5以上、Discuz版本>3.0。

= Discuz資料庫  = Discuz插件開發文檔  = 開發交流  =  BUG反饋  =  QQ客服：3188639  QQ交流群：281079920

接口開發常用函數

1、DB數據庫操作函數    /*常用MYSQL數據庫操作命令，增、減、改、查功能函數。*/

2、新秀網絡驗證數據庫對照表    /*新秀網絡驗證系統內部，所有數據庫表及說明*/

3、Discuz官方數據庫對照表  /*Discuz官方數據庫表，包括discuz、UCente數據庫字典。*/

4、Discuz基礎框架、類、函數    /*包含Discuz官方基礎框架、類、函數、方法使用說明。*/

5、新秀網絡基礎框架類、函數    /*包含新秀網絡驗證基礎框架、類、函數、方法使用說明。*/

驗證插件二次開發示例

1、ip地址查詢   /*用于查詢ip地址接口！*/

使 用 簡 介

1、插件開發演示文件下載（IP地址查詢）

ip_utf8.zip (5.5 KB, 下載次數: 1329) 2022-4-12 15:47 上傳 點擊文件名下載附件 ip_gbk.zip (5.14 KB, 下載次數: 1325) 2022-4-12 15:47 上傳 點擊文件名下載附件

2、插件開發演示文件目錄說明

xinxiu_network_plugin \\新秀網絡驗證應用中心插件主目錄 —extend \\自定義類存放目錄 （用于開發者存放第三方類、自定義類） —function \\自定義方法存放目錄 （用于開發者存放自定義開發接口類和方法） ——function_dev.php \\自定義方法類開發文件 （自定義開發接口方法類） —plugins \\插件數據庫代碼存放目錄 （用于開發者存放插件數據庫執行代碼） ——dev \\插件名目錄 ———extend_network.php \\設置插件數據庫執行代碼文件（數據新增、更新、刪除，接口增加、刪除功能，插件安裝和卸載代碼） —template \\插件前端htm開發存放目錄（根據discuz官方插件前臺開發代碼進行開發） —admin_dev_set.inc.php \\插件后臺設置文件（根據discuz官方插件后臺開發代碼進行開發，并在插件設計頁面自行增加插件設置文件入口） —dev.inc.php \\自定義接口入口開發文件

3、如何安裝、開發、調試？

#1、下載演示文件后，上傳至新秀網絡驗證應用中心插件根目錄。discuz論壇插件根目錄 \source\plugin\xinxiu_network_plugin\ #2、使用PHP代碼編輯軟件，對入口文件 dev.inc.php 和 自定義方法類文件 function_dev.php 等進行開發，注意：UTF8及GBK編碼問題。 #3、如需新增接口文件，請根據演示文件，修改 “dev” 為您想要的文件名，但不能與新秀框架插件內文件名沖突，且開發的接口方法，不能與新秀框架沖突。 #4、如何發布自己開發的插件并獲取一定收益，請聯系客服QQ： #5、功能代碼開發完成，組裝調試接口： //根據演示文件中組裝url接口地址 http://demo.xinxiuvip.com/plugin.php?id=xinxiu_network_plugin:ip&action=ip_cha&key=123456&ip=14.21.97.153 [PHP] 純文本查看 復制代碼 { "code": 200, "result": "ok", "count": 2, "data": { "ip": "14.21.97.153", "dizhi": "- 中國廣東" }, "sqltime": "0.01041s" }

ip.inc.php入口文件代碼實例

[PHP] 純文本查看 復制代碼 <?php /* 技術支持 QQ：3188639 QQ交流群：281079920 官方網站 [url=http://www.5566wy.com/]http://www.5566wy.com/[/url] 獲取授權 [url=http://www.5566wy.com/plugin.php?id=xinxiu_license:accredit]http://www.5566wy.com/plugin.php?id=xinxiu_license:accredit[/url] 接口開發手冊 [url=http://www.5566wy.com/forum.php?mod=viewthread&tid=394]http://www.5566wy.com/forum.php?mod=viewthread&tid=394[/url] 嚴禁反編譯、逆向等任何形式的侵權行為，違者將追究法律責任！ */ #======================================== #以下兩行代碼，用于開發環境下代碼錯誤提示，可根據提示信息進行代碼檢查，無誤后即可注釋掉！ //ini_set("display_errors", "on"); //error_reporting(E_ALL); #======================================== #======================================== #防止游客直接輸入網址進行訪問，權限檢測，勿動！！！ if (! defined('IN_DISCUZ')) { exit('Access Denied'); } #======================================== #======================================== #引入自定義開發類文件，此文件保存位置 'function/dev' 代表 function/function_dev.php 如需修改請按格式進行！ C::import('function/ip', 'plugin/xinxiu_network_plugin', false);//注意這里插件開發和接口二次開發不同！ $api = new function_ip();//實例化function_dev.php類操作，實例化后可用$api->調用function_dev.php中的類方法！ #======================================== #此處為入口文件，根據接口方法，調用對應類方法。 switch ($api->action) { //$api->action 獲取入口方法，勿動！！！ #======================================== case 'ip_cha': // 判斷是否是此方法，如果是則進入下一步！ $ip = xx_client::safe_check('ip', true); //判斷參數傳輸，params為參數名稱，iscore為是否是必填項（true為必填，false為可空） $api->ip_cha($ip);//調用function_dev.php實例化后類方法，根據類方法設置傳入參數。 break; #此處代碼根據接口開發需求，可以無限添加循環。 #======================================== #======================================== case 'ip_demo': // 判斷是否是此方法，如果是則進入下一步！ $ip = xx_client::safe_check('ip', true); //判斷參數傳輸，params為參數名稱，iscore為是否是必填項（true為必填，false為可空） $api->ip_demo($ip);//調用function_dev.php實例化后類方法，根據類方法設置傳入參數。 break; #此處代碼根據接口開發需求，可以無限添加循環。 #======================================== #======================================== #此處代碼是判斷接口輸入是否正確。勿刪！！！ default: xx_client::json_output(400,'error010'); break; #======================================== }

function_ip.php自定義方法類代碼實例

[PHP] 純文本查看 復制代碼 <?php /* 技術支持 QQ：3188639 QQ交流群：281079920 官方網站 [url=http://www.5566wy.com/]http://www.5566wy.com/[/url] 獲取授權 [url=http://www.5566wy.com/plugin.php?id=xinxiu_license:accredit]http://www.5566wy.com/plugin.php?id=xinxiu_license:accredit[/url] 接口開發手冊 [url=http://www.5566wy.com/forum.php?mod=viewthread&tid=394]http://www.5566wy.com/forum.php?mod=viewthread&tid=394[/url] 嚴禁反編譯、逆向等任何形式的侵權行為，違者將追究法律責任！ */ #======================================== #以下兩行代碼，用于開發環境下代碼錯誤提示，可根據提示信息進行代碼檢查，無誤后即可注釋掉！ //ini_set("display_errors", "on"); //error_reporting(E_ALL); #======================================== #======================================== #防止游客直接輸入網址進行訪問，權限檢測，勿動！！！ if (! defined('IN_DISCUZ')) { exit('Access Denied'); } #======================================== #======================================== #引入核心系統類，勿刪！！！ C::import('class/plugin','plugin/xinxiu_network_plugin',false); require_once DISCUZ_ROOT.'./config/config_ucenter.php'; require_once DISCUZ_ROOT.'./uc_client/client.php'; #======================================== #======================================== #如何引入自定義系統類？ #1、將自定義核心類、第三方核心類上傳至extend文件夾下； #2、通過 C::import 、 require_once 兩種引入形式引入第三方核心類； #3、在下方 public function dev_demo1($demo1,$demo2) 方法中實例化后使用 $new-> 進行調用。 #======================================== class function_ip extends class_plugin { public $action_all = array('ip_cha','ip_demo');//所有接口必填，用逗號隔開！！！除以下key、adminkey所包含以外，未包含的接口都是通過token令牌進行訪問。 public $function_action_key = array('ip_cha','ip_demo');//使用key密鑰訪問的接口 public $function_action_adminkey = array();//使用管理密鑰adminkey訪問的接口 /** * 構造方法 __construct() 是在實例化對象時被自動調用 * 用途：可以用于初始化程序(可以給成員屬性賦值，也可以調用成員方法) */ public function __construct(){ $this->plugin_status();//判斷插件后臺開啟狀態，勿刪！ parent::__construct();//注意這里和接口二次開發不同 } #======================================== #此處為標準類方法，可根據DISCUZ、新秀網絡驗證內置函數進行調用，也可使用PHP官方函數進行操作。 public function ip_cha($ip){ #-具體DISCUZ內置函數、新秀網絡驗證內置函數、PHP函數，論壇相應帖子有專門介紹。 $tinyipfile = DISCUZ_ROOT.'./data/ipdata/tinyipdata.dat'; $data = $this->convertip_tiny($ip,$tinyipfile); $data_array = array( 'ip'=>$ip, 'dizhi'=>$data, ); $data ? xx_client::json_output(200,'ok',$data_array): $this->json_output(400,'請檢查IP地址是否正確！'); #-具體DISCUZ內置函數、新秀網絡驗證內置函數、PHP函數，論壇相應帖子有專門介紹。 } #======================================== #======================================== #演示方法設置鉤子 public function ip_demo($ip){ #======================================== #嵌入插件開發鉤子，注意：此擴展方法在應用中心擴展文件中使用‘extend_plugin.php’； xx_client::class_hook('hook_ip_ip_cha',array('ip'=>$ip)); /* * 下面是插件拓展對應的方法 * 注意class_hook中的'hook_ip_ip_cha' 就是擴展文件中的方法名！ * public function hook_ip_ip_cha($data){ var_dump($data,'plugin'); } */ #======================================== } #======================================== function convertip_tiny($ip, $ipdatafile) {//獲取ip地址的方法類 static $fp = NULL, $offset = array(), $index = NULL; $ipdot = explode('.', $ip); $ip = pack('N', ip2long($ip)); $ipdot[0] = (int)$ipdot[0]; $ipdot[1] = (int)$ipdot[1]; if($fp === NULL && $fp = @fopen($ipdatafile, 'rb')) { $offset = @unpack('Nlen', @fread($fp, 4)); $index = @fread($fp, $offset['len'] - 4); } elseif($fp == FALSE) { return '- Invalid IP data file'; } $length = $offset['len'] - 1028; $start = @unpack('Vlen', $index[$ipdot[0] * 4] . $index[$ipdot[0] * 4 + 1] . $index[$ipdot[0] * 4 + 2] . $index[$ipdot[0] * 4 + 3]); for ($start = $start['len'] * 8 + 1024; $start < $length; $start += 8) { if ($index[$start] . $index[$start + 1] . $index[$start + 2] . $index[$start + 3] >= $ip) { $index_offset = @unpack('Vlen', $index[$start + 4] . $index[$start + 5] . $index[$start + 6] . "\x0"); $index_length = @unpack('Clen', $index[$start + 7]); break; } } @fseek($fp, $offset['len'] + $index_offset['len'] - 1024); if($index_length['len']) { return '- '.@fread($fp, $index_length['len']); } else { return '- Unknown'; } } /** * 析構方法 __destruct() 是在對象被銷毀時自動調用 * 用途：可以進行資源的釋放操作或文件的關閉操作或信息保存操作 */ public function __destruct() { return parent::__destruct(); // TODO: Change the autogenerated stub } }

admin_qq_set.inc.php插件后臺設置文件（以QQ登錄插件為例）

[PHP] 純文本查看 復制代碼 <?php if (! defined('IN_DISCUZ') || ! defined('IN_ADMINCP')) { exit('Access Denied'); } global $_G; C::import('class/xinxiu','plugin/xinxiu_network',false); //判斷接收go參數 $go = $_GET['go']; $formhash= $_G['formhash']; $identifier = 'xinxiu_network_plugin'; //判斷接收go參數 if (submitcheck('qqsubmit')){ $data = array( //'open' => $_GET['open'], 'appid' => $_GET['appid'], 'appkey' => $_GET['appkey'], 'callback' => $_GET['callback'], 'scope' =>$_GET['like'], ); xx_cache::set_cache('plugin/set/qq_set',$data,true); cpmsg('更新數據成功！', 'action=plugins&operation=config&do='.$_GET['do'].'&identifier=xinxiu_network_plugin&pmod=admin_qq_set', 'succeed'); }else{ //QQ登錄配置信息獲取 $data = xx_cache::get_cache('plugin/set/qq_set','',true); $appid = $data['appid']; $appkey = $data['appkey']; $callback = $data['callback']; //$open = $data['open']; $get_user_info = $data['scope']['get_user_info'] == 'on' ? 'checked' : ''; //QQ登錄配置信息獲取 } showtableheader('QQ登錄設置'); showformheader('plugins&operation=config&do='.$pluginid.'&identifier='. $identifier .'&pmod=admin_qq_set'); //showsetting('QQ登錄開關', 'open',$open, 'radio','','','是否開啟QQ登錄！'); showsetting('appid:', 'appid',$appid, 'text','','','請輸入appid'); showsetting('appkey:', 'appkey',$appkey, 'password','','','請輸入appkey'); showsetting('callback:', 'callback',$callback, 'text','','','請輸入callback回調地址'); showtips('', 'tips', true, '<h2 style="color: red">提示：首先要進行QQ賬號綁定接口成功后，才能使用其他功能。</h2>'); showsubmit('qqsubmit','提交配置'); showformfooter(); showtablefooter();

extend_network.php插件安裝卸載配置實例

[PHP] 純文本查看 復制代碼 <?php if(!defined('IN_DISCUZ')) { exit('Access Denied'); } C::import('class/plugin','plugin/xinxiu_network_plugin',false);//引入系統核心類 class extend_network extends class_plugin { public function __construct()//構造方法 { parent::__construct(false); } public function hook_plugin_install(){//插件安裝代碼 $sql = <<<EOF CREATE TABLE IF NOT EXISTS `pre_xinxiu_plugin_ip` ( `id` BIGINT(16) unsigned NOT NULL AUTO_INCREMENT, `text1` longtext NOT NULL, PRIMARY KEY (`id`) ) ENGINE=MyISAM DEFAULT CHARSET=utf8 ; EOF; return $sql; } public function hook_plugin_upgrade(){//插件更新代碼 $sql = <<<EOF CREATE TABLE IF NOT EXISTS `pre_xinxiu_plugin_ip` ( `id` BIGINT(16) unsigned NOT NULL AUTO_INCREMENT, `text1` longtext NOT NULL, PRIMARY KEY (`id`) ) ENGINE=MyISAM DEFAULT CHARSET=utf8 ; EOF; return $sql; } public function hook_plugin_uninstall(){//插件卸載代碼 $sql = <<<EOF DROP TABLE IF EXISTS `pre_xinxiu_plugin_ip`; EOF; return $sql; } public function hook_plugin_actions_install(){//插件安裝接口代碼 $actions_array = array( array( 'type'=>'ip模塊', 'name'=>'查詢ip地址', 'actions'=>'ip_cha', 'url'=>'http://www.5566wy.com/forum.php?mod=viewthread&tid=424', ), ); return $actions_array; } public function hook_plugin_actions_upgrade(){//插件接口更新代碼 } }