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

discuz核心函数库function_core的函数注释的相关文章

discuz核心函数库function_core.php注释

/** * 系统错误处理 * @param <type> $message 错误信息 * @param <type> $show 是否显示信息 * @param <type> $save 是否存入日志 * @param <type> $halt 是否中断访问 */function system_error($message, $show = true, $save = true, $halt = true) { ...... } /** * 更新 sessi

苹果浏览器Safari对JS函数库中newDate()函数中的参数的解析中不支持形如“2020-01-01”形式

苹果浏览器safari对new Date('1937-01-01')不支持,用.replace(/-/g, "/")函数替换掉中划线即可 如果不做处理,会报错:invalid date 本解决方案参考:http://stackoverflow.com/questions/4310953/invalid-date-in-safari

6、C_宏定义与预处理、函数与函数库

C语言预处理理论 由源码到可执行程序的过程 源码.c->(编译)->elf可执行程序 源码.c->(编译)->目标文件.o->(链接)->elf可执行程序 源码.c->(编译)->汇编文件.S->(汇编)->目标文件.o->(链接)->elf可执行程序 源码.c->(预处理)->预处理过的.i源文件->(编译)->汇编文件.S->(汇编)->目标文件.o->(链接)->elf可执行程序

php总结8——mysql函数库、增删改

8.1 mysql函数库 php的函数   .php中用来操作mysql函数库的函数 常用函数 mysql_connect("主机名称/ip","用户名","密码")--->建立php到mysql的连接,返回资源----> mysql_error()  返回上一个mysql操作的文本错误信息 @ 错误抑制符 一般来说,mysql_connect和mysql_error() 一起使用,用如下方式表示: <?php $link[em

MySQL函数库

MySQL函数库,这个函数库是一个外部函数库!这个函数提供了对于MySQL数据库进行操作的常用函数,如连接MySQL服务器.打开数据库.执行SQL语句等.所以这个函数库的功能对于我们来说是非常重要的! 其实,MySQL数据库是整个程序开发的最底层,我们在程序开发时,就必须为其添加一层漂亮的外衣,这层漂亮的外衣就是图形化用户界面(Graphical User Interface,简称GUI,又称图形用户接口),也就是使用者只需要具体基本的计算机知识,然后通过鼠标,就可以实现某些复杂的功能!其实,我

人生维艰,何不利用开源.NET函数库让工作更轻松

今天推荐的文章会谈到一些让你工作更轻松的开源.NET函数库. 即使业界有时候认为.NET开源社区不太健康,很多开发团队都更多依赖于微软提供的东西来开发.不过最近在.NET世界中还是诞生了一些优秀和有意思的开源函数库. thomasvm就在他的博文中推荐了一些比较有代表性的开源函数库.这些函数库都是解决一些比较通用的问题,具备良好的文档,并非是一个强制你遵循某种规则和代码结构的框架,可以很好地嵌入到你的应用程序当中.当然,作者也给出了一些推荐理由: Hangfire.这是一个运行在ASP.NET中

在windows中安装使用python第三方函数库

很多使用过python的读者都知道,python光使用系统函数库是远远不能满足要求的,有时候我们需要使用第三方函数库与自定义函数库,然而第三方函数库是要自己手动安装的,由于笔者正在学习python,所以就演示一下安装过程,这里只展示windows的安装过程,linux的不再叙述,有兴趣的读者自行百度. 第一步,在python官网上下载第三方函数库httplib2,这里的版本为httplib2-0.9.2,点击下载地址即可下载. 第二步,将刚刚下载的压缩包解压到某个文件夹里,以笔者的为例,结果如下

动态函数库的制作和使用

>>>>>>接静态函数库的制作和使用>>http://www.cnblogs.com/hfxin2001-eric-daddy/p/5809010.html 2 动态函数库的制作和使用 动态函数库的制作步骤可以用下图来描述,具体包括 (1)  编写函数的.c文件(例如add.c.sub.c.mul.c和div.c) (2)  编写Makefile,然后make,实现函数的编译和归档入库 函数的编译:使用gcc –c add.c -fPIC只编译不链接函数.c

Linux之自定义的 Shell 函数和函数库

在 Linux 系统下,Shell 脚本可以在各种不同的情形下帮到我们,例如展示信息,甚至 自动执行特定的系统管理任务,创建简单的命令行工具等等. 在本指南中,我们将向 Linux 新手展示如何可靠地存储自定义的 shell 脚本,解释如何编写 shell 函数和函数库,以及如何在其它的脚本中使用函数库中的函数. Shell 脚本要存储在何处 为了在执行你自己的脚本时不必输入脚本所在位置的完整或绝对路径,脚本必须被存储在$PATH 环境变量所定义的路径里的其中一个. 使用下面的命令可以查看你系统