首页 > 代码库 > discuz核心函数库function_core的函数注释

discuz核心函数库function_core的函数注释

转:http://jancy.iteye.com/blog/1260834

Php代码  收藏代码
  1. /** 
  2.  * 系统错误处理 
  3.  * @param <type> $message 错误信息 
  4.  * @param <type> $show 是否显示信息 
  5.  * @param <type> $save 是否存入日志 
  6.  * @param <type> $halt 是否中断访问 
  7.  */  
  8. function system_error($message, $show = true, $save = true, $halt = true) {  
  9.     ......      
  10. }  
  11.   
  12. /** 
  13.  * 更新 session 
  14.  * @global <type> $_G 
  15.  * @staticvar boolean $updated 
  16.  * @param boolean $force 
  17.  * @return boolean 
  18.  */  
  19. function updatesession($force = false) {  
  20.     ......      
  21. }  
  22.   
  23. /** 
  24.  * 获取 microtime float 数值,为了兼容php4 
  25.  * @return <float> 
  26.  */  
  27. function dmicrotime() {  
  28.     ......      
  29. }  
  30.   
  31. /** 
  32.  * 设置全局 $_G 中的变量 
  33.  * @global <array> $_G 
  34.  * @param <string> $key 键 
  35.  * @param <string> $value 值 
  36.  * @param <mix> $group 组(准备废弃,尽量不用) 
  37.  * @return true 
  38.  * 
  39.  * @example 
  40.  * setglobal(‘test‘, 1); // $_G[‘test‘] = 1; 
  41.  * setglobal(‘config/test/abc‘) = 2; //$_G[‘config‘][‘test‘][‘abc‘] = 2; 
  42.  * 
  43.  */  
  44. function setglobal($key , $value, $group = null) {  
  45.     ......      
  46. }  
  47.   
  48. /** 
  49.  * 获取全局变量 $_G 当中的某个数值 
  50.  * @global  $_G 
  51.  * @param <type> $key 
  52.  * @param <type> $group 计划废弃的参数,不建议使用 
  53.  * @return <mix> 
  54.  * 
  55.  * $v = getglobal(‘test‘); // $v = $_G[‘test‘] 
  56.  * $v = getglobal(‘test/hello/ok‘);  // $v = $_G[‘test‘][‘hello‘][‘ok‘] 
  57.  */  
  58. function getglobal($key, $group = null) {  
  59.     ......      
  60. }  
  61.   
  62. /** 
  63.  * 取出 get, post, cookie 当中的某个变量 
  64.  * 
  65.  * @param string $k  key 值 
  66.  * @param string $type 类型 
  67.  * @return mix 
  68.  */  
  69. function getgpc($k, $type=‘GP‘) {  
  70.     ......      
  71. }  
  72.   
  73. /** 
  74.  * 根据uid 获取用户基本数据 
  75.  * @staticvar array $users 存放已经获取的用户的信息,避免重复查库 
  76.  * @param <int> $uid 
  77.  * @return <array> 
  78.  */  
  79. function getuserbyuid($uid) {  
  80.     ......      
  81. }  
  82.   
  83. /** 
  84. * 获取当前用户的扩展资料 
  85. * @param $field 字段 
  86. */  
  87. function getuserprofile($field) {  
  88.     ......      
  89. }  
  90.   
  91. /** 
  92.  * 对字符串或者输入进行 addslashes 操作 
  93.  * @param <mix> $string 
  94.  * @param <int> $force 
  95.  * @return <mix> 
  96.  */  
  97. function daddslashes($string, $force = 1) {  
  98.     ......      
  99. }  
  100.   
  101. /** 
  102.  * 对字符串进行加密和解密 
  103.  * @param <string> $string 
  104.  * @param <string> $operation  DECODE 解密 | ENCODE  加密 
  105.  * @param <string> $key 当为空的时候,取全局密钥 
  106.  * @param <int> $expiry 有效期,单位秒 
  107.  * @return <string> 
  108.  */  
  109. function authcode($string, $operation = ‘DECODE‘, $key = ‘‘, $expiry = 0) {  
  110.     ......      
  111. }  
  112.   
  113. /** 
  114.  * 远程文件文件请求兼容函数 
  115.  */  
  116. function dfsockopen($url, $limit = 0, $post = ‘‘, $cookie = ‘‘, $bysocket = FALSE, $ip = ‘‘, $timeout = 15, $block = TRUE) {  
  117.     ......      
  118. }  
  119.   
  120. /** 
  121. * HTML转义字符 
  122. * @param $string - 字符串 
  123. * @return 返回转义好的字符串 
  124. */  
  125. function dhtmlspecialchars($string) {  
  126.     ......      
  127. }  
  128.   
  129. /** 
  130.  * 退出程序 同 exit 的区别, 对输出数据会进行 重新加工和处理 
  131.  * 通常情况下,我们建议使用本函数终止程序, 除非有特别需求 
  132.  * @param <type> $message 
  133.  */  
  134. function dexit($message = ‘‘) {  
  135.     ......      
  136. }  
  137.   
  138. /** 
  139.  * 同 php header函数, 针对 location 跳转做了特殊处理 
  140.  * @param <type> $string 
  141.  * @param <type> $replace 
  142.  * @param <type> $http_response_code 
  143.  */  
  144. function dheader($string, $replace = true, $http_response_code = 0) {  
  145.     ......      
  146. }  
  147.   
  148. /** 
  149. * 设置cookie 
  150. * @param $var - 变量名 
  151. * @param $value - 变量值 
  152. * @param $life - 生命期 
  153. * @param $prefix - 前缀 
  154. * @param $httponly - 安全属性 
  155. */  
  156. function dsetcookie($var, $value = ‘‘, $life = 0, $prefix = 1, $httponly = false) {  
  157.     ......      
  158. }  
  159.   
  160. /** 
  161.  * 获取cookie 
  162.  * @param $key - cookie名称,不需要带前缀 
  163.  */  
  164. function getcookie($key) {  
  165.     ......      
  166. }  
  167.   
  168. /** 
  169.  * 获取文件扩展名 
  170.  * @param $filename 文件名 
  171.  */  
  172. function fileext($filename) {  
  173.     ......      
  174. }  
  175.   
  176. /** 
  177. * 检查是否是以手机浏览器进入(IN_MOBILE) 
  178. */  
  179. function checkmobile() {  
  180.     ......      
  181. }  
  182.   
  183. /** 
  184.  * 字符串方式实现 preg_match("/(s1|s2|s3)/", $string, $match) 
  185.  * @param string $string 源字符串 
  186.  * @param array $arr 要查找的字符串 如array(‘s1‘, ‘s2‘, ‘s3‘) 
  187.  * @param bool $returnvalue 是否返回找到的值 
  188.  * @return bool 
  189.  */  
  190. function dstrpos($string, &$arr, $returnvalue = false) {  
  191.     ......      
  192. }  
  193.   
  194. /** 
  195. * 检查邮箱是否有效 
  196. * @param $email 要检查的邮箱 
  197. * @param 返回结果 
  198. */  
  199. function isemail($email) {  
  200.     ......      
  201. }  
  202.   
  203. /** 
  204. * 问题答案加密 
  205. * @param $questionid - 问题 
  206. * @param $answer - 答案 
  207. * @return 返回加密的字串 
  208. */  
  209. function quescrypt($questionid, $answer) {  
  210.     ......      
  211. }  
  212.   
  213. /** 
  214. * 产生随机码 
  215. * @param $length - 要多长 
  216. * @param $numberic - 数字还是字符串 
  217. * @return 返回字符串 
  218. */  
  219. function random($length, $numeric = 0) {  
  220.     ......      
  221. }  
  222.   
  223. /** 
  224.  * 判断一个字符串是否在另一个字符串中存在 
  225.  * 
  226.  * @param string 原始字串 $string 
  227.  * @param string 查找 $find 
  228.  * @return boolean 
  229.  */  
  230. function strexists($string, $find) {  
  231.     ......      
  232. }  
  233.   
  234. /** 
  235.  * 获取头像 
  236.  * 
  237.  * @param int $uid 需要获取的用户UID值 
  238.  * @param string $size 获取尺寸 ‘small‘, ‘middle‘, ‘big‘ 
  239.  * @param boolean $returnsrc 是否直接返回图片src 
  240.  * @param boolean $real 是否返回真实图片 
  241.  * @param boolean $static 是否返回真实路径 
  242.  * @param string $ucenterurl 强制uc路径 
  243.  */  
  244. function avatar($uid, $size = ‘middle‘, $returnsrc = FALSE, $real = FALSE, $static = FALSE, $ucenterurl = ‘‘) {  
  245.     ......      
  246. }  
  247.   
  248. /** 
  249. * 加载语言 
  250. * 语言文件统一为 $lang = array(); 
  251. * @param $file - 语言文件,可包含路径如 forum/xxx home/xxx 
  252. * @param $langvar - 语言文字索引 
  253. * @param $vars - 变量替换数组 
  254. * @param $default - 指定默认值,当找不到对应言包时生效 
  255. * @return 语言文字 
  256. */  
  257. function lang($file, $langvar = null, $vars = array(), $default = null) {  
  258.     ......      
  259. }  
  260.   
  261. /** 
  262. * 检查模板源文件是否更新 
  263. * 当编译文件不存时强制重新编译 
  264. * 当 tplrefresh = 1 时检查文件 
  265. * 当 tplrefresh > 1 时,则根据 tplrefresh 取余,无余时则检查更新 
  266. */  
  267. function checktplrefresh($maintpl, $subtpl, $timecompare, $templateid, $cachefile, $tpldir, $file) {  
  268.     ......      
  269. }  
  270.   
  271. /** 
  272. * 解析模板 
  273. * @return 返回域名 
  274. */  
  275. function template($file, $templateid = 0, $tpldir = ‘‘, $gettplfile = 0, $primaltpl=‘‘) {  
  276.     ......      
  277. }  
  278.   
  279. /** 
  280.  * 对某id进行个性化md5 
  281.  */  
  282. function modauthkey($id) {  
  283.     ......      
  284. }  
  285.   
  286. /** 
  287.  * 获得当前应用页面选中的导航id 
  288.  */  
  289. function getcurrentnav() {  
  290.     ......      
  291. }  
  292.   
  293. /** 
  294. * 读取缓存 
  295. * @param $cachenames - 缓存名称数组或字串 
  296. */  
  297. function loadcache($cachenames, $force = false) {  
  298.     ......      
  299. }  
  300.   
  301. /** 
  302.  * 通过memcache\mysql\file等几种手段读缓存 
  303.  * @param mixed $cachenames 缓存名的数组或字串 
  304.  */  
  305. function cachedata($cachenames) {  
  306.     ......      
  307. }  
  308.   
  309. /** 
  310. * 格式化时间 
  311. * @param $timestamp - 时间戳 
  312. * @param $format - dt=日期时间 d=日期 t=时间 u=个性化 其他=自定义 
  313. * @param $timeoffset - 时区 
  314. * @return string 
  315. */  
  316. function dgmdate($timestamp, $format = ‘dt‘, $timeoffset = ‘9999‘, $uformat = ‘‘) {  
  317.     ......      
  318. }  
  319.   
  320. /** 
  321.     得到时间戳 
  322. */  
  323. function dmktime($date) {  
  324.     ......      
  325. }  
  326.   
  327. /** 
  328. * 更新缓存 
  329. * @param $cachename - 缓存名称 
  330. * @param $data - 缓存数据 
  331. */  
  332. function save_syscache($cachename, $data) {  
  333.     ......      
  334. }  
  335.   
  336. /** 
  337. * Portal模块 
  338. * @param $parameter - 参数集合 
  339. */  
  340. function block_get($parameter) {  
  341.     ......      
  342. }  
  343.   
  344. /** 
  345. * Portal 模块显示 
  346. * @param $parameter - 参数集合 
  347. */  
  348. function block_display($bid) {  
  349.     ......      
  350. }  
  351.   
  352. /** 
  353. * 返回库文件的全路径 
  354. * @param string $libname 库文件分类及名称 
  355. * @param string $folder 模块目录‘module‘,‘include‘,‘class‘ 
  356. * @return string 
  357. * @example require DISCUZ_ROOT.‘./source/function/function_cache.php‘ 
  358. * @example 我们可以利用此函数简写为:require libfile(‘function/cache‘); 
  359. */  
  360. function libfile($libname, $folder = ‘‘) {  
  361.     ......      
  362. }  
  363.   
  364. /** 
  365.  * 针对uft-8进行特殊处理的strlen 
  366.  * @param string $str 
  367.  * @return int 
  368.  */  
  369. function dstrlen($str) {  
  370.     ......      
  371. }  
  372.   
  373. /** 
  374. * 根据中文裁减字符串 
  375. * @param $string - 字符串 
  376. * @param $length - 长度 
  377. * @param $doc - 缩略后缀 
  378. * @return 返回带省略号被裁减好的字符串 
  379. */  
  380. function cutstr($string, $length, $dot = ‘ ...‘) {  
  381.     ......      
  382. }  
  383.   
  384. /** 
  385. * 论坛 aid url 生成 
  386. */  
  387. function aidencode($aid, $type = 0, $tid = 0) {  
  388.     ......      
  389. }  
  390.   
  391. /** 
  392.  * 返回论坛缩放附件图片的地址 url 
  393.  */  
  394. function getforumimg($aid, $nocache = 0, $w = 140, $h = 140, $type = ‘‘) {  
  395.     ......      
  396. }  
  397.   
  398.   
  399. /** 
  400.  * 获取rewrite字符串 
  401.  * @param string $type 需要获取的rewite 
  402.  * @param boolean $returntype true:直接返回href, false:返回a标签 
  403.  * @param string $host 可选网站域名 
  404.  * @return string 
  405.  */  
  406. function rewriteoutput($type, $returntype, $host) {  
  407.     ......      
  408. }  
  409.   
  410. /** 
  411. * 手机模式下替换所有链接为mobile=yes形式 
  412. * @param $file - 正则匹配到的文件字符串 
  413. * @param $file - 要被替换的字符串 
  414. * @$replace 替换后字符串 
  415. */  
  416. function mobilereplace($file, $replace) {  
  417.     ......      
  418. }  
  419.   
  420. /** 
  421. * 手机的output函数 
  422. */  
  423. function mobileoutput() {  
  424.     ......      
  425. }  
  426.   
  427. /** 
  428. * 系统输出 
  429. * @return 返回内容 
  430. */  
  431. function output() {  
  432.     ......      
  433. }  
  434.   
  435. /** 
  436.  * ajax footer使用输出页面内容 
  437.  */  
  438. function output_ajax() {  
  439.     ......      
  440. }  
  441.   
  442. /** 
  443.  * 运行钩子 
  444.  */  
  445. function runhooks() {  
  446.     ......      
  447. }  
  448.   
  449. /** 
  450.  * 执行插件脚本 
  451.  */  
  452. function hookscript($script, $hscript, $type = ‘funcs‘, $param = array(), $func = ‘‘) {  
  453.     ......      
  454. }  
  455.   
  456. /** 
  457.  * 获取插件模块 
  458.  */  
  459. function pluginmodule($pluginid, $type) {  
  460.     ......      
  461. }  
  462.   
  463. /** 
  464.  * 执行积分规则 
  465.  * @param String $action:  规则action名称 
  466.  * @param Integer $uid: 操作用户 
  467.  * @param array $extrasql: common_member_count的额外操作字段数组格式为 array(‘extcredits1‘ => ‘1‘) 
  468.  * @param String $needle: 防重字符串 
  469.  * @param Integer $coef: 积分放大倍数 
  470.  * @param Integer $update: 是否执行更新操作 
  471.  * @param Integer $fid: 版块ID 
  472.  * @return 返回积分策略 
  473.  */  
  474. function updatecreditbyaction($action, $uid = 0, $extrasql = array(), $needle = ‘‘, $coef = 1, $update = 1, $fid = 0) {  
  475.     ......      
  476. }  
  477.   
  478. /** 
  479. * 检查积分下限 
  480. * @param string $action: 策略动作Action或者需要检测的操作积分值使如extcredits1积分进行减1操作检测array(‘extcredits1‘ => -1) 
  481. * @param Integer $uid: 用户UID 
  482. * @param Integer $coef: 积分放大倍数/负数为减分操作 
  483. * @param Integer $returnonly: 只要返回结果,不用中断程序运行 
  484. */  
  485. function checklowerlimit($action, $uid = 0, $coef = 1, $fid = 0, $returnonly = 0) {  
  486.     ......      
  487. }  
  488.   
  489. /** 
  490.  * 批量执行某一条策略规则 
  491.  * @param String $action:  规则action名称 
  492.  * @param Integer $uids: 操作用户可以为单个uid或uid数组 
  493.  * @param array $extrasql: common_member_count的额外操作字段数组格式为 array(‘extcredits1‘ => ‘1‘) 
  494.  * @param Integer $coef: 积分放大倍数,当为负数时为反转操作 
  495.  * @param Integer $fid: 版块ID 
  496.  */  
  497. function batchupdatecredit($action, $uids = 0, $extrasql = array(), $coef = 1, $fid = 0) {  
  498.     ......      
  499. }  
  500.   
  501. /** 
  502.  * 添加积分 
  503.  * @param Integer $uids: 用户uid或者uid数组 
  504.  * @param String $dataarr: member count相关操作数组,例: array(‘threads‘ => 1, ‘doings‘ => -1) 
  505.  * @param Boolean $checkgroup: 是否检查用户组 true or false 
  506.  * @param String $operation: 操作类型 
  507.  * @param Integer $relatedid: 
  508.  * @param String $ruletxt: 积分规则文本 
  509.  */  
  510.   
  511. function updatemembercount($uids, $dataarr = array(), $checkgroup = true, $operation = ‘‘, $relatedid = 0, $ruletxt = ‘‘) {  
  512.     if(!emptyempty($uids) && (is_array($dataarr) && $dataarr)) {  
  513.         require_once libfile(‘function/credit‘);  
  514.         return _updatemembercount($uids, $dataarr, $checkgroup, $operation, $relatedid, $ruletxt);  
  515.     }  
  516.     return true;  
  517. }  
  518.   
  519. /** 
  520.  * 校验用户组 
  521.  * @param $uid 
  522.  */  
  523. function checkusergroup($uid = 0) {  
  524.     ......      
  525. }  
  526.   
  527. /** 
  528. * 调试信息 
  529. */  
  530. function debuginfo() {  
  531.     ......      
  532. }  
  533.   
  534. /** 
  535.  * 随机取出一个站长推荐的条目 
  536.  * @param $module 当前模块 
  537.  * @return array 
  538. */  
  539. function getfocus_rand($module) {  
  540.     ......      
  541. }  
  542.   
  543. /** 
  544.  * 检查验证码正确性 
  545.  * @param $value 验证码变量值 
  546.  */  
  547. function check_seccode($value, $idhash) {  
  548.     ......      
  549. }  
  550.   
  551. /** 
  552.  * 检查验证问答正确性 
  553.  * @param $value 验证问答变量值 
  554.  */  
  555. function check_secqaa($value, $idhash) {  
  556.     ......      
  557. }  
  558.   
  559. /** 
  560.  * 获取广告 
  561.  */  
  562. function adshow($parameter) {  
  563.     ......      
  564. }  
  565.   
  566. /** 
  567.  * 显示提示信息 
  568.  * @param $message - 提示信息,可中文也可以是 lang_message.php 中的数组 key 值 
  569.  * @param $url_forward - 提示后跳转的 url 
  570.  * @param $values - 提示信息中可替换的变量值 array(key => value ...) 形式 
  571.  * @param $extraparam - 扩展参数 array(key => value ...) 形式 
  572.  *  跳转控制 
  573.         header      header跳转 
  574.         location    location JS 跳转,限于 msgtype = 2、3 
  575.         timeout     定时跳转 
  576.         refreshtime 自定义跳转时间 
  577.         closetime   自定义关闭时间,限于 msgtype = 2,值为 true 时为默认 
  578.         locationtime    自定义跳转时间,限于 msgtype = 2,值为 true 时为默认 
  579.     内容控制 
  580.         alert       alert 图标样式 right/info/error 
  581.         return      显示请返回 
  582.         redirectmsg 下载时用的提示信息,当跳转时显示的信息样式 
  583.                     0:如果您的浏览器没有自动跳转,请点击此链接 
  584.                     1:如果 n 秒后下载仍未开始,请点击此链接 
  585.         msgtype     信息样式 
  586.                     1:非 Ajax 
  587.                     2:Ajax 弹出框 
  588.                     3:Ajax 只显示信息文本 
  589.         showmsg     显示信息文本 
  590.         showdialog  关闭原弹出框显示 showDialog 信息,限于 msgtype = 2 
  591.         login       未登录时显示登录链接 
  592.         extrajs     扩展 js 
  593.         striptags   过滤 HTML 标记 
  594.     Ajax 控制 
  595.         handle      执行 js 回调函数 
  596.         showid      控制显示的对象 ID 
  597.  */  
  598. function showmessage($message, $url_forward = ‘‘, $values = array(), $extraparam = array(), $custom = 0) {  
  599.     ......      
  600. }  
  601.   
  602. /** 
  603. * 检查是否正确提交了表单 
  604. * @param $var 需要检查的变量 
  605. * @param $allowget 是否允许GET方式 
  606. * @param $seccodecheck 验证码检测是否开启 
  607. * @return 返回是否正确提交了表单 
  608. */  
  609. function submitcheck($var, $allowget = 0, $seccodecheck = 0, $secqaacheck = 0) {  
  610.     ......      
  611. }  
  612.   
  613. /** 
  614. * 分页 
  615. * @param $num - 总数 
  616. * @param $perpage - 每页数 
  617. * @param $curpage - 当前页 
  618. * @param $mpurl - 跳转的路径 
  619. * @param $maxpages - 允许显示的最大页数 
  620. * @param $page - 最多显示多少页码 
  621. * @param $autogoto - 最后一页,自动跳转 
  622. * @param $simple - 是否简洁模式(简洁模式不显示上一页、下一页和页码跳转) 
  623. * @return 返回分页代码 
  624. */  
  625. function multi($num, $perpage, $curpage, $mpurl, $maxpages = 0, $page = 10, $autogoto = FALSE, $simple = FALSE) {  
  626.     ......      
  627. }  
  628.   
  629. /** 
  630. * 只有上一页下一页的分页(无需知道数据总数) 
  631. * @param $num - 本次所取数据条数 
  632. * @param $perpage - 每页数 
  633. * @param $curpage - 当前页 
  634. * @param $mpurl - 跳转的路径 
  635. * @return 返回分页代码 
  636. */  
  637. function simplepage($num, $perpage, $curpage, $mpurl) {  
  638.     ......      
  639. }  
  640.   
  641. /** 
  642.  * 词语过滤 
  643.  * @param $message - 词语过滤文本 
  644.  * @return 成功返回原始文本,否则提示错误或被替换 
  645.  */  
  646. function censor($message, $modword = NULL, $return = FALSE) {  
  647.     ......      
  648. }  
  649.   
  650. /** 
  651.     词语过滤,检测是否含有需要审核的词 
  652. */  
  653. function censormod($message) {  
  654.     ......      
  655. }  
  656.   
  657. /** 
  658. * 刷新重定向 
  659. */  
  660. function dreferer($default = ‘‘) {  
  661.     ......      
  662. }  
  663.   
  664. /** 
  665.  * 远程FTP使用 
  666.  */  
  667. function ftpcmd($cmd, $arg1 = ‘‘) {  
  668.     ......      
  669. }  
  670.   
  671. /** 
  672.  * 编码转换 
  673.  * @param <string> $str 要转码的字符 
  674.  * @param <string> $in_charset 输入字符集 
  675.  * @param <string> $out_charset 输出字符集(默认当前) 
  676.  * @param <boolean> $ForceTable 强制使用码表(默认不强制) 
  677.  * 
  678.  */  
  679. function diconv($str, $in_charset, $out_charset = CHARSET, $ForceTable = FALSE) {  
  680.     ......      
  681. }  
  682.   
  683. /** 
  684.  * 重建数组 
  685.  * @param <string> $array 需要反转的数组 
  686.  * @return array 原数组与的反转后的数组 
  687.  */  
  688. function renum($array) {  
  689.     ......      
  690. }  
  691.   
  692. /** 
  693.  * 获取当前脚本在线人数 
  694.  * @param <int> $fid 分类 ID,版块、群组 的 id, 
  695.  * @param <int> $tid 内容 ID,帖子 的 id 
  696.  */  
  697. function getonlinenum($fid = 0, $tid = 0) {  
  698.     ......      
  699. }  
  700.   
  701. /** 
  702. * 字节格式化单位 
  703. * @param $filesize - 大小(字节) 
  704. * @return 返回格式化后的文本 
  705. */  
  706. function sizecount($size) {  
  707.     ......      
  708. }  
  709.   
  710. /** 
  711.  * 写入运行日志 
  712.  */  
  713. function writelog($file, $log) {  
  714.     ......      
  715. }  
  716.   
  717. /** 
  718.  * 调色板 
  719.  * @param <type> $colorid 
  720.  * @param <type> $id 
  721.  * @param <type> $background 
  722.  * @return <type> 
  723.  */  
  724. function getcolorpalette($colorid, $id, $background, $fun = ‘‘) {  
  725.     ......      
  726. }  
  727.   
  728. /** 
  729.  * 取得某标志位的数值 (0|1) 
  730.  * 
  731.  * @param 数值 $status 
  732.  * @param 位置 $position 
  733.  * @return 0 | 1 
  734.  */  
  735. function getstatus($status, $position) {  
  736.     ......      
  737. }  
  738.   
  739. /** 
  740.  * 设置某一bit位的数值 0 or 1 
  741.  * 
  742.  * @param int $position  1-16 
  743.  * @param int $value  0|1 
  744.  * @param 原始数值 $baseon  0x0000-0xffff 
  745.  * @return int 
  746.  */  
  747. function setstatus($position, $value, $baseon = null) {  
  748.     ......      
  749. }  
  750.   
  751. /** 
  752.  * 通知 
  753.  * @param Integer $touid: 通知给谁 
  754.  * @param String $type: 通知类型 
  755.  * @param String $note: 语言key 
  756.  * @param Array $notevars: 语言变量对应的值 
  757.  * @param Integer $system: 是否为系统通知 0:非系统通知; 1:系统通知 
  758.  */  
  759. function notification_add($touid, $type, $note, $notevars = array(), $system = 0) {  
  760.     ......      
  761. }  
  762.   
  763. /** 
  764. * 发送管理通知 
  765. * @param $type - 通知类型 
  766. */  
  767. function manage_addnotify($type, $from_num = 0, $langvar = array()) {  
  768.     ......      
  769. }  
  770.   
  771. /** 
  772. * 发送短消息(兼容提醒) 
  773. * @param $toid - 接收方id 
  774. * @param $subject - 标题 
  775. * @param $message - 内容 
  776. * @param $fromid - 发送方id 
  777. */  
  778. function sendpm($toid, $subject, $message, $fromid = ‘‘, $replypmid = 0, $isusername = 0, $type = 0) {  
  779.     ......      
  780. }  
  781.   
  782. /** 
  783.  * 
  784.  * 通过tid得到相应的单一post表名或post表集合 
  785.  * @param <mix> $tids: 允许传进单个tid,也可以是tid集合 
  786.  * @param $primary: 是否只查主题表 0:遍历所有表;1:只查主表 
  787.  * @return 当传进来的是单一的tid将直接返回表名,否则返回表集合的二维数组例:array(‘forum_post‘ => array(tids),‘forum_post_1‘ => array(tids)) 
  788.  * @TODO tid传进来的是字符串的,返回单个表名,传进来的是数组的,不管是不是一个数组,返回的还是数组,保证进出值对应 
  789.  */  
  790. function getposttablebytid($tids, $primary = 0) {  
  791.     ......      
  792. }  
  793.   
  794. /** 
  795.  * 获取论坛帖子表名 
  796.  * @param <int> $tableid: 分表ID,默认为:fourm_post表 
  797.  * @param <boolean> $prefix: 是否默认带有表前缀 
  798.  * @return forum_post or forum_post_* 
  799.  */  
  800. function getposttable($tableid = 0, $prefix = false) {  
  801.     ......      
  802. }  
  803.   
  804. /** 
  805.  * 内存读写接口函数 
  806.  * 
  807.  * @param 命令 $cmd (set|get|rm|check) 
  808.  * @param 键值 $key 
  809.  * @param 数据 $value 
  810.  * @param 有效期 $ttl 
  811.  * @return mix 
  812.  * 
  813.  * @example set : 写入内存 $ret = memory(‘set‘, ‘test‘, ‘ok‘) 
  814.  * @example get : 读取内存 $data = memory(‘get‘, ‘test‘) 
  815.  * @example rm : 删除内存  $ret = memory(‘rm‘, ‘test‘) 
  816.  * @example check : 检查内存功能是否可用 $allow = memory(‘check‘) 
  817.  */  
  818. function memory($cmd, $key=‘‘, $value=http://www.mamicode.com/‘‘, $ttl = 0) {  
  819.     ......      
  820. }  
  821.   
  822. /** 
  823. * ip允许访问 
  824. * @param $ip 要检查的ip地址 
  825. * @param - $accesslist 允许访问的ip地址 
  826. * @param 返回结果 
  827. */  
  828. function ipaccess($ip, $accesslist) {  
  829.     ......      
  830. }  
  831.   
  832. /** 
  833. * ip限制访问 
  834. * @param $ip 要检查的ip地址 
  835. * @param 返回结果 
  836. */  
  837. function ipbanned($onlineip) {  
  838.     ......      
  839. }  
  840.   
  841. /** 
  842.  * 系统级消息 
  843.  */  
  844. function sysmessage($message) {  
  845.     ......      
  846. }  
  847.   
  848. /** 
  849. * 论坛权限 
  850. * @param $permstr - 权限信息 
  851. * @param $groupid - 只判断用户组 
  852. * @return 0 无权限 > 0 有权限 
  853. */  
  854. function forumperm($permstr, $groupid = 0) {  
  855.     ......      
  856. }  
  857.   
  858. /** 
  859.  * PHP 兼容性函数 
  860.  */  
  861. if(!function_exists(‘file_put_contents‘)) {  
  862.     if(!defined(‘FILE_APPEND‘)) define(‘FILE_APPEND‘, 8);  
  863.     function file_put_contents($filename, $data, $flag = 0) {  
  864.         $return = false;  
  865.         if($fp = @fopen($filename, $flag != FILE_APPEND ? ‘w‘ : ‘a‘)) {  
  866.             if($flag == LOCK_EX) @flock($fp, LOCK_EX);  
  867.             $return = fwrite($fp, is_array($data) ? implode(‘‘, $data) : $data);  
  868.             fclose($fp);  
  869.         }  
  870.         return $return;  
  871.     }  
  872. }  
  873.   
  874. //检查权限  
  875. function checkperm($perm) {  
  876.     global $_G;  
  877.     return (emptyempty($_G[‘group‘][$perm])?‘‘:$_G[‘group‘][$perm]);  
  878. }  
  879.   
  880. /** 
  881. * 时间段设置检测 
  882. * @param $periods - 那种时间段 $settings[$periods]  $settings[‘postbanperiods‘] $settings[‘postmodperiods‘] 
  883. * @param $showmessage - 是否提示信息 
  884. * @return 返回检查结果 
  885. */  
  886. function periodscheck($periods, $showmessage = 1) {  
  887.     ......      
  888. }  
  889.   
  890. /** 
  891.  * 用户操作日志 
  892.  * @param int $uid 用户ID 
  893.  * @param string $action 操作类型 tid=thread pid=post blogid=blog picid=picture doid=doing sid=share aid=article uid_cid/blogid_cid/sid_cid/picid_cid/aid_cid/topicid_cid=comment 
  894.  * @return bool 
  895.  */  
  896. function useractionlog($uid, $action) {  
  897.     ......      
  898. }  
  899.   
  900. /** 
  901.  * 得到用户操作的代码或代表字符,参数为数字返回字符串,参数为字符串返回数字 
  902.  * @param string/int $var 
  903.  * @return int/string 注意:如果失败返回false,请使用===判断,因为代码0代表tid 
  904.  */  
  905. function getuseraction($var) {  
  906.     ......      
  907. }  
  908.   
  909. /** 
  910.  * 获取我的中心中展示的应用 
  911.  */  
  912. function getuserapp($panel = 0) {  
  913.     ......      
  914. }  
  915.   
  916. /** 
  917.  * 获取manyou应用本地图标路径 
  918.  * @param <type> $appid 
  919.  */  
  920. function getmyappiconpath($appid, $iconstatus=0) {  
  921.     ......      
  922. }  
  923.   
  924. /** 
  925.  * 获取文字内的url列表 
  926.  * 
  927.  * @param $message 文字 
  928.  * @return <array> url列表 
  929.  * 
  930.  */  
  931. function get_url_list($message) {  
  932.     ......      
  933. }  
  934.   
  935. /** 
  936.  * 检查文字内的URL 
  937.  * 
  938.  * @param $allowposturl 用户组设置中的值 0=禁止 1=允许但审核 2=允许但不解析 
  939.  * @param $message 待处理的文字内容 
  940.  * @return 0=禁止 1=允许但审核 2=允许但不解析 
  941.  */  
  942. function checkurl($allowposturl, &$message) {  
  943.     ......      
  944. }  
  945.   
  946. /** 
  947.  * 更新页面和模块的关系 
  948.  * @param string $targettplname 页面名称 
  949.  * @param array $blocks 模块IDS 
  950.  */  
  951. function update_template_block($targettplname, $blocks) {  
  952.     ......      
  953. }  
  954.   
  955. /** 
  956.  * 获取批定类型的关联连接 
  957.  * 
  958.  * @param string $extent 内容所需关联链接范围 article, forum, group, blog 
  959.  * @return string 有效的关联链接 
  960.  */  
  961. function getrelatedlink($extent) {  
  962.     ......      
  963. }  
  964.   
  965. /** 
  966.  * 判断 Connect 链接参数有效性 
  967.  * @global  $_G 
  968.  * @param array $params 参数数组 
  969.  * @param array $connect_params 返回参数 
  970.  * @return boolean 
  971.  */  
  972. function connect_valid($params, &$connect_params) {  
  973.     ......      
  974. }  
  975.   
  976. /** 
  977.  * 获取 Token 
  978.  * @global  $_G 
  979.  * @param string $type 
  980.  * @return string 
  981.  */  
  982. function connect_get_access_token($type = ‘USER‘) {  
  983.     ......      
  984. }  
  985.   
  986. /** 
  987.  * 获取 Connect 参数签名 
  988.  * @param array $params 参数数组 
  989.  * @param string $access_token 加密 Token 
  990.  * @return string 
  991.  */  
  992. function connect_get_sig($params, $access_token) {  
  993.     ......      
  994. }  
  995.   
  996. /** 
  997.  * 通过 AID 获取附件表名 
  998.  * @param <int> $aid 
  999.  */  
  1000. function getattachtablebyaid($aid) {  
  1001.     ......      
  1002. }  
  1003.   
  1004. /** 
  1005.  * 返回指定 TID 所对应的附件表编号 
  1006.  * @param <int> $tid 
  1007.  */  
  1008. function getattachtableid($tid) {  
  1009.     ......      
  1010. }  
  1011.   
  1012. /** 
  1013.  * 通过 TID 获取附件表名 
  1014.  * @param <int> $tid 
  1015.  */  
  1016. function getattachtablebytid($tid) {  
  1017.     ......      
  1018. }  
  1019.   
  1020. /** 
  1021.  * 通过 PID 获取附件表名 
  1022.  * @param <int> $pid 
  1023.  */  
  1024. function getattachtablebypid($pid) {  
  1025.     ......      
  1026. }  
  1027.   
  1028. /** 
  1029.  * 添加一个新的附件索引记录,并返回新附件 ID 
  1030.  * @param <int> $uid 
  1031.  */  
  1032. function getattachnewaid($uid = 0) {  
  1033.     ......      
  1034. }  
  1035.   
  1036. /** 
  1037.  * 获取 SEO设置 
  1038.  * @param string $page 调用哪个页面的 
  1039.  * @param array $data 可替换数据 
  1040.  * @return array(‘seotitle‘, ‘seodescription‘, ‘seokeywords‘) 
  1041.  */  
  1042. function get_seosetting($page, $data = array(), $defset = array()) {  
  1043.     ......      
  1044. }  
  1045.   
  1046. /** 
  1047.  * 需处理连续分隔符的str_replace() 
  1048.  * @param array $searchs 被替换的数组 
  1049.  * @param array $replaces 用于替换的数组 
  1050.  * @param string $str 目标字符串 
  1051.  */  
  1052. function strreplace_strip_split($searchs, $replaces, $str) {  
  1053.     ......      
  1054. }  
  1055.   
  1056. /** 
  1057.  * 返回带第几页的title 
  1058.  * @global  $_G 
  1059.  * @param string $navtitle 源标题 
  1060.  * @param int $page 页码 
  1061.  * @return string 
  1062.  */  
  1063. function get_title_page($navtitle, $page){  
  1064.     if($page > 1) {  
  1065.     ......      
  1066. }  
  1067.   
  1068. /** 
  1069.  * 
  1070.  * 生成缩略图文件名 
  1071.  * @param String $fileStr: 原文件名,允许附带路径 
  1072.  * @param String $extend: 新文件名后缀 
  1073.  * @param Boolean $holdOldExt: 是否保留原扩展名 
  1074.  * @return 返加新的后缀文件名 
  1075.  */  
  1076. function getimgthumbname($fileStr, $extend=‘.thumb.jpg‘, $holdOldExt=true) {  
  1077.     ......      
  1078. }  
  1079.   
  1080. /** 
  1081.  * 更新数据的审核状态 
  1082.  * @param <string> $idtype 数据类型 tid=thread pid=post blogid=blog picid=picture doid=doing sid=share aid=article uid_cid/blogid_cid/sid_cid/picid_cid/aid_cid/topicid_cid=comment 
  1083.  * @param <array/int> $ids ID 数组、ID 值 
  1084.  * @param <int> $status 状态 0=加入审核(默认) 1=忽略审核 2=审核通过 
  1085.  */  
  1086. function updatemoderate($idtype, $ids, $status = 0) {  
  1087.     ......      
  1088. }  
  1089.   
  1090. /** 
  1091.  * 显示漫游应用公告 
  1092.  */  
  1093. function userappprompt() {  
  1094.     ......      
  1095. }  

discuz核心函数库function_core的函数注释