这里会显示出您选择的修订版和当前版本之间的差别。
两侧同时换到之前的修订记录 前一修订版 后一修订版 | 前一修订版 | ||
zblogphp:development:functions:首页 [2020/05/17 19:33] zx.asd |
zblogphp:development:functions:首页 [2020/05/19 06:30] (当前版本) zx.asd |
||
---|---|---|---|
行 1: | 行 1: | ||
====== Z-BlogPHP 辅助函数列表 ====== | ====== Z-BlogPHP 辅助函数列表 ====== | ||
+ | ===== c_system_common里函数,提供基础性的功能 ===== | ||
- | ==== GetScheme() ==== | + | [[zblogphp:development:functions:common|common全部函数列表]] |
- | === 说明 === | + | [[zblogphp:development:functions:getvars]] |
- | 得到请求协议(考虑到反向代理等原因,未必准确) 如果想获取准确的值,请zbp->Load后使用$zbp->isHttps. | + | |
- | === 参数与返回值 === | ||
- | param(): | ||
- | return(\$string): | + | ===== c_system_event里函数,提供事件处理功能 ===== |
- | ==== GetWebServer() ==== | + | [[zblogphp:development:functions:getlist]] |
- | === 说明 === | + | [[zblogphp:development:functions:getpost]] |
- | 获取服务器. | + | |
- | === 参数与返回值 === | ||
- | return(integer): | ||
- | ==== GetSystem() ==== | + | [[zblogphp:development:functions:event]] |
- | === 说明 === | + | ===== c_system_admin里函数,提供后台管理功能 ===== |
- | 获取操作系统 | + | [[zblogphp:development:functions:admin]] |
- | === 参数与返回值 === | ||
- | return(integer): | ||
- | ==== GetPHPEngine() ==== | + | ===== c_system_plugin里函数,提供插件和接口的调用和管理功能 ===== |
+ | [[zblogphp:development:functions:plugin]] | ||
- | === 说明 === | + | ===== c_system_debug里函数,提供Debug管理功能 ===== |
- | 获取PHP解析引擎. | + | [[zblogphp:development:functions:debug]] |
- | === 参数与返回值 === | ||
- | return(integer): | ||
- | ==== GetPHPVersion() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | 获取PHP Version. | ||
- | |||
- | === 参数与返回值 === | ||
- | return(string): | ||
- | |||
- | ==== AutoloadClass() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | 自动加载类文件. | ||
- | |||
- | === 参数与返回值 === | ||
- | param(string): 类名 | ||
- | |||
- | api(): Filter_Plugin_Autoload * | ||
- | |||
- | return(mixed): | ||
- | |||
- | ==== Logs() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | 记录日志. | ||
- | |||
- | === 参数与返回值 === | ||
- | param(string): | ||
- | |||
- | param(boolean): | ||
- | |||
- | return(boolean): | ||
- | |||
- | ==== RunTime() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | 输出页面运行时长 | ||
- | |||
- | === 参数与返回值 === | ||
- | param(boolean): 是否输出(考虑历史原因,默认输出) | ||
- | |||
- | return(array): | ||
- | |||
- | ==== GetEnvironment() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | 获得系统信息. | ||
- | |||
- | === 参数与返回值 === | ||
- | return(string): 系统信息 | ||
- | |||
- | since(): 1.4 | ||
- | |||
- | ==== plugin_dir_url() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | 通过文件获取应用URL地址 | ||
- | |||
- | === 参数与返回值 === | ||
- | param(string): 文件名 | ||
- | |||
- | return(string): 返回URL地址 | ||
- | |||
- | ==== plugin_dir_path() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | 通过文件获取应用目录路径. | ||
- | |||
- | === 参数与返回值 === | ||
- | param(): | ||
- | |||
- | return(string): | ||
- | |||
- | ==== GetValueInArray() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | 通过Key从数组获取数据. | ||
- | |||
- | === 参数与返回值 === | ||
- | param(array): 数组名 | ||
- | |||
- | param(string): 下标key | ||
- | |||
- | return(mixed): | ||
- | |||
- | ==== GetValueInArrayByCurrent() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | 获取数组中的当前元素数据. | ||
- | |||
- | === 参数与返回值 === | ||
- | param(string): 数组名 | ||
- | |||
- | param(string): 下标key | ||
- | |||
- | return(mixed): | ||
- | |||
- | ==== SplitAndGet() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | 分割string并取某项数据. | ||
- | |||
- | === 参数与返回值 === | ||
- | param(string): | ||
- | |||
- | param(string): | ||
- | |||
- | param(integer): | ||
- | |||
- | return(string): | ||
- | |||
- | ==== RemoveMoreSpaces() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | 删除连续空格 | ||
- | |||
- | === 参数与返回值 === | ||
- | param(): | ||
- | |||
- | return(null): | ||
- | |||
- | ==== GetGuid() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | 获取Guid. | ||
- | |||
- | === 参数与返回值 === | ||
- | return(string): | ||
- | |||
- | ==== GetVars() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | 获取参数值 | ||
- | |||
- | === 参数与返回值 === | ||
- | param(string): 数组key名 | ||
- | |||
- | param(string): 默认为REQUEST | ||
- | |||
- | return(mixed): | ||
- | |||
- | ==== GetVarsByDefault() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | 获取参数值(可设置默认返回值). | ||
- | |||
- | === 参数与返回值 === | ||
- | param(string): 数组key名 | ||
- | |||
- | param(string): 默认为REQUEST | ||
- | |||
- | param(string): 默认为null | ||
- | |||
- | return(mixed): | ||
- | |||
- | since(): 1.3.140614 | ||
- | |||
- | ==== GetDbName() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | 获取数据库名. | ||
- | |||
- | === 参数与返回值 === | ||
- | return(string): 返回一个随机的SQLite数据文件名 | ||
- | |||
- | ==== GetCurrentHost() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | 获取当前网站地址 | ||
- | |||
- | === 参数与返回值 === | ||
- | param(string): 网站域名 | ||
- | |||
- | param(string): &$cookiesPath 返回cookie作用域值,要传引入 | ||
- | |||
- | return(string): 返回网站完整地址,如http://localhost/zbp/ | ||
- | |||
- | ==== GetHttpContent() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | 通过URL获取远程页面内容. | ||
- | |||
- | === 参数与返回值 === | ||
- | param(string): URL地址 | ||
- | |||
- | return(string): 返回页面文本内容,默认为null | ||
- | |||
- | ==== GetDirsInDir() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | 获取目录下文件夹列表. | ||
- | |||
- | === 参数与返回值 === | ||
- | param(string): 目录 | ||
- | |||
- | return(array): 文件夹列表 | ||
- | |||
- | ==== GetFilesInDir() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | 获取目录下指定类型文件列表. | ||
- | |||
- | === 参数与返回值 === | ||
- | param(string): 目录 | ||
- | |||
- | param(string): 文件类型,以|分隔 | ||
- | |||
- | return(array): 文件列表 | ||
- | |||
- | ==== RedirectByScript() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | 用script标签进行跳转. | ||
- | |||
- | === 参数与返回值 === | ||
- | param(string): 跳转链接 | ||
- | |||
- | ==== Redirect() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | 302跳转. | ||
- | |||
- | === 参数与返回值 === | ||
- | param(string): 跳转链接 | ||
- | |||
- | ==== Redirect301() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | 301跳转. | ||
- | |||
- | === 参数与返回值 === | ||
- | param(string): 跳转链接 | ||
- | |||
- | ==== Http404() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | Http404 | ||
- | |||
- | === 参数与返回值 === | ||
- | ==== Http500() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | Http500 | ||
- | |||
- | === 参数与返回值 === | ||
- | ==== Http503() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | Http503 | ||
- | |||
- | === 参数与返回值 === | ||
- | ==== Http304() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | 设置304缓存头. | ||
- | |||
- | === 参数与返回值 === | ||
- | param(string): 文件名 | ||
- | |||
- | param(string): 缓存时间 | ||
- | |||
- | ==== GetGuestIP() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | 获取客户端IP. | ||
- | |||
- | === 参数与返回值 === | ||
- | return(string): 返回IP地址 | ||
- | |||
- | ==== GetGuestAgent() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | 获取客户端Agent. | ||
- | |||
- | === 参数与返回值 === | ||
- | return(string): 返回Agent | ||
- | |||
- | ==== GetRequestUri() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | 获取请求来源URL. | ||
- | |||
- | === 参数与返回值 === | ||
- | return(string): 返回URL | ||
- | |||
- | ==== GetFileExt() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | 获取文件后缀名. | ||
- | |||
- | === 参数与返回值 === | ||
- | param(string): 文件名 | ||
- | |||
- | return(string): 返回小写的后缀名 | ||
- | |||
- | ==== GetFilePermsOct() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | 获取文件权限. | ||
- | |||
- | === 参数与返回值 === | ||
- | param(string): 文件名 | ||
- | |||
- | return(string): 返回文件权限,数值格式,如0644 | ||
- | |||
- | ==== GetFilePerms() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | 获取文件权限. | ||
- | |||
- | === 参数与返回值 === | ||
- | param(string): 文件名 | ||
- | |||
- | return(string): 返回文件权限,字符表达格式,如-rw-r--r-- | ||
- | |||
- | ==== AddNameInString() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | 向字符串型的参数表加入一个新参数. | ||
- | |||
- | === 参数与返回值 === | ||
- | param(string): 字符串型的参数表,以|符号分隔 | ||
- | |||
- | param(string): 参数名 | ||
- | |||
- | return(string): 返回新字符串,以|符号分隔 | ||
- | |||
- | ==== DelNameInString() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | 从字符串型的参数表中删除一个参数. | ||
- | |||
- | === 参数与返回值 === | ||
- | param(string): 字符串型的参数表,以|符号分隔 | ||
- | |||
- | param(string): 参数名 | ||
- | |||
- | return(string): 返回新字符串,以|符号分隔 | ||
- | |||
- | ==== HasNameInString() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | 在字符串参数值查找参数. | ||
- | |||
- | === 参数与返回值 === | ||
- | param(string): 字符串型的参数表,以|符号分隔 | ||
- | |||
- | param(string): 参数名 | ||
- | |||
- | return(boolean): | ||
- | |||
- | ==== JsonError4ShowErrorHook() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | 以JSON形式输出错误信息(用于ShowError接口). | ||
- | |||
- | === 参数与返回值 === | ||
- | param(): | ||
- | |||
- | param(): | ||
- | |||
- | param(): | ||
- | |||
- | param(): | ||
- | |||
- | ==== JsonError() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | 以JSON形式输出错误信息. | ||
- | |||
- | === 参数与返回值 === | ||
- | param(string): 错误编号 | ||
- | |||
- | param(string): 错误内容 | ||
- | |||
- | param(object): | ||
- | |||
- | ==== JsonReturn() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | 当代码正常运行时,以JSON形式输出信息. | ||
- | |||
- | === 参数与返回值 === | ||
- | param(object): 待返回内容 | ||
- | |||
- | ==== RespondError() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | XML-RPC应答错误页面. | ||
- | |||
- | === 参数与返回值 === | ||
- | param(): | ||
- | |||
- | param(): | ||
- | |||
- | param(): | ||
- | |||
- | param(): | ||
- | |||
- | return(void): | ||
- | |||
- | ==== ScriptError() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | XML-RPC脚本错误页面. | ||
- | |||
- | === 参数与返回值 === | ||
- | param(string): 错误提示字符串 | ||
- | |||
- | param(string): | ||
- | |||
- | param(string): | ||
- | |||
- | param(string): | ||
- | |||
- | return(void): | ||
- | |||
- | ==== CheckRegExp() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | 验证字符串是否符合正则表达式. | ||
- | |||
- | === 参数与返回值 === | ||
- | param(string): 字符串 | ||
- | |||
- | param(string): 正则表达式,可用[username]|[password]|[email]|[homepage]或自定义表达式 | ||
- | |||
- | return(boolean): | ||
- | |||
- | ==== FormatString() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | 格式化字符串. | ||
- | |||
- | === 参数与返回值 === | ||
- | param(string): 字符串 | ||
- | |||
- | param(string): 正则表达式,可用[html-format]|[nohtml]|[noscript]|[enter]|[noenter]|[filename]|[normalname]或自定义表达式 | ||
- | |||
- | return(string): | ||
- | |||
- | ==== TransferHTML() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | 格式化字符串 | ||
- | |||
- | === 参数与返回值 === | ||
- | param(string): | ||
- | |||
- | param(string): | ||
- | |||
- | Deprecated(): | ||
- | |||
- | ==== CloseTags() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | 封装HTML标签. | ||
- | |||
- | === 参数与返回值 === | ||
- | param(string): html源码 | ||
- | |||
- | return(string): | ||
- | |||
- | ==== SubStrUTF8_Start() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | 获取UTF8格式的字符串的子串. | ||
- | |||
- | === 参数与返回值 === | ||
- | param(string): 源字符串 | ||
- | |||
- | param(integer): 起始位置 | ||
- | |||
- | return(string): | ||
- | |||
- | ==== SubStrUTF8() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | 获取UTF8格式的字符串的子串. | ||
- | |||
- | === 参数与返回值 === | ||
- | param(string): 源字符串 | ||
- | |||
- | param(integer): 子串长度 | ||
- | |||
- | return(string): | ||
- | |||
- | ==== Zbp_SubStr() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | ZBP版获取UTF8格式的字符串的子串. | ||
- | |||
- | === 参数与返回值 === | ||
- | param(string): | ||
- | |||
- | param(integer): | ||
- | |||
- | return(string): | ||
- | |||
- | ==== Zbp_StrLen() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | ZBP版StrLen. | ||
- | |||
- | === 参数与返回值 === | ||
- | param(string): | ||
- | |||
- | return(string): | ||
- | |||
- | ==== Zbp_Strpos() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | ZBP版Strpos | ||
- | |||
- | === 参数与返回值 === | ||
- | param(string): | ||
- | |||
- | param(string): | ||
- | |||
- | param(integer): | ||
- | |||
- | return(string): | ||
- | |||
- | ==== Zbp_Stripos() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | ZBP版Stripos | ||
- | |||
- | === 参数与返回值 === | ||
- | param(string): | ||
- | |||
- | param(string): | ||
- | |||
- | param(integer): | ||
- | |||
- | return(string): | ||
- | |||
- | ==== SubStrUTF8_Html() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | 截取HTML格式的UTF8格式的字符串的子串. | ||
- | |||
- | === 参数与返回值 === | ||
- | param(string): 源字符串 | ||
- | |||
- | param(integer): 子串长度 | ||
- | |||
- | return(string): | ||
- | |||
- | ==== RemoveBOM() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | 删除文件BOM头. | ||
- | |||
- | === 参数与返回值 === | ||
- | param(string): 文件内容 | ||
- | |||
- | return(string): | ||
- | |||
- | ==== GetTimeZoneByGMT() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | 获取指定时区名. | ||
- | |||
- | === 参数与返回值 === | ||
- | param(integer): 时区号 | ||
- | |||
- | return(string): 时区名 | ||
- | |||
- | since(): 1.3.140614 | ||
- | |||
- | ==== htmlspecialchars_array() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | 对数组内的字符串进行htmlspecialchars. | ||
- | |||
- | === 参数与返回值 === | ||
- | param(array): 待过滤字符串 | ||
- | |||
- | return(array): | ||
- | |||
- | since(): 1.4 | ||
- | |||
- | ==== FilterCorrectName() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | 获得一个只含数字字母和-线的string. | ||
- | |||
- | === 参数与返回值 === | ||
- | param(string): 待过滤字符串 | ||
- | |||
- | return(string): | ||
- | |||
- | since(): 1.4 | ||
- | |||
- | ==== CheckCanBeString() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | 确认一个对象是否可被转换为string. | ||
- | |||
- | === 参数与返回值 === | ||
- | param(object): | ||
- | |||
- | return(boolean): | ||
- | |||
- | since(): 1.4 | ||
- | |||
- | ==== BuildSafeURL() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | 构造带Token的安全URL. | ||
- | |||
- | === 参数与返回值 === | ||
- | param(string): | ||
- | |||
- | param(string): 应用ID,可以生成一个应用专属的Token | ||
- | |||
- | return(string): | ||
- | |||
- | since(): 1.5.2 | ||
- | |||
- | ==== BuildSafeCmdURL() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | 构造cmd.php的访问链接. | ||
- | |||
- | === 参数与返回值 === | ||
- | param(string): cmd.php参数 | ||
- | |||
- | return(boolean): | ||
- | |||
- | since(): 1.5.2 | ||
- | |||
- | ==== utf84mb_filter() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | 实现utf84mb4的过滤 | ||
- | |||
- | === 参数与返回值 === | ||
- | param(string): | ||
- | |||
- | return(string): | ||
- | |||
- | ==== utf84mb_fixHtmlSpecialChars() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | 实现utf84mb的fixHtmlSpecialChars | ||
- | |||
- | === 参数与返回值 === | ||
- | return(string): | ||
- | |||
- | ==== utf84mb_convertToUCS4() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | 实现utf84mb的convertToUCS4 | ||
- | |||
- | === 参数与返回值 === | ||
- | param(string): | ||
- | |||
- | return(string): | ||
- | |||
- | ==== utf84mb_convertToUTF8() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | 实现utf84mb的convertToUTF8 | ||
- | |||
- | === 参数与返回值 === | ||
- | param(string): | ||
- | |||
- | return(string): | ||
- | |||
- | ==== VerifyWebToken() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | 验证Web Token是否合法. | ||
- | |||
- | === 参数与返回值 === | ||
- | param(): | ||
- | |||
- | param(): | ||
- | |||
- | param(string): | ||
- | |||
- | return(boolean): | ||
- | |||
- | ==== CreateWebToken() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | 创建Web Token. | ||
- | |||
- | === 参数与返回值 === | ||
- | param(): | ||
- | |||
- | param(): | ||
- | |||
- | param(string): | ||
- | |||
- | return(string): | ||
- | |||
- | ==== CheckIsRefererValid() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | 检测来源是否合法,这包括CSRF检测,在开启增强安全模式时加入来源检测. | ||
- | |||
- | === 参数与返回值 === | ||
- | throws(\Exception): | ||
- | |||
- | ==== CheckCSRFTokenValid() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | 验证CSRF Token是否合法. | ||
- | |||
- | === 参数与返回值 === | ||
- | param(string): | ||
- | |||
- | param(array): | ||
- | |||
- | return(boolean): | ||
- | |||
- | ==== CheckHTTPRefererValid() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | 检测HTTP Referer是否合法. | ||
- | |||
- | === 参数与返回值 === | ||
- | return(boolean): | ||
- | |||
- | ==== RemovePHPCode() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | 清除一串代码内所有的PHP代码 | ||
- | |||
- | === 参数与返回值 === | ||
- | param(string): | ||
- | |||
- | return(string): | ||
- | |||
- | ==== GetIDArrayByList() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | 拿到ID数组byList列表 | ||
- | |||
- | === 参数与返回值 === | ||
- | param(array): | ||
- | |||
- | param(string): | ||
- | |||
- | return(array): | ||
- | |||
- | ==== GetBackendCSPHeader() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | 拿到后台的CSP Heaeder | ||
- | |||
- | === 参数与返回值 === | ||
- | return(string): | ||
- | |||
- | ==== CheckIncludedFiles() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | 检查重复加载的. | ||
- | |||
- | === 参数与返回值 === | ||
- | param(string): | ||
- | |||
- | return(boolean): | ||
- | |||
- | ==== Logs_Dump() ==== | ||
- | |||
- | |||
- | === 说明 === | ||
- | Logs指定的变量的值 | ||
- | |||
- | === 参数与返回值 === |