函数列表

Z-BlogPHP 封装了众多辅助函数，文件路径为：「zb_system/function/c_system_common.php 」←此链接可直接在线查看；

还有一些在zb_system/function/c_system_function.php，不过除了前两个外不太需要自行调用；

本章节会介绍一些相对常用的，具体定义可在文件中搜索查看。

GetList()

通过 GetList 可以获取自定义的文章列表，如指定分类的最新文章、置顶文章等等；

注：该函数是 $zbp->GetPostList() 的上层封装，主要供内部路由调用，建议直接使用 $zbp->GetPostList() 或自行按需封装；

$result = GetList(array('count'=>10)) //返回array(Post类型) 或是 空array()Copy to clipboardErrorCopied

array 参数如下

array(   'count' => 10, //（文章数量，可省略）   'cate' => 1, //（分类ID，可省略）   'auth' => 2, //（作者ID，可省略）   'date' => '2020-1', //（可省略）   'tags' => 'abc', //（标签名，可省略）   'search' => 's', //（搜索词，可省略）   //以下是原$option 参数的 key 键   'post_type' => null, //指定查询 Post 表的类型 （0文章，1单页 可省略）   'post_status' => null, //指定查询 Post 表的状态 （0公开 1草稿 2审核 可省略）   'only_ontop' => false, //指定全是置顶 （可省略）   'only_not_ontop' => false, //指定全不是置顶 （可省略）   'has_subcate' => false, //指定包含子孙目录 （可省略）   'is_related' => '文章id', //指定查询相关文章 （可省略）   'order_by_metas' => false, //指定按 Metas 值排序输出结果 （可省略）   'random' => 5, //指定抽取 5 篇 Post 表的记录 （可省略）   'where_custom' => array(array('>', 'log_PostTime', '1657884349')), //自定义 where   'order_custom' => array('log_ViewNums' => 'DESC', 'log_CommNums' => 'ASC'), //自定义 order )Copy to clipboardErrorCopied

GetPost()

通过 GetPost 可以获取指定的文章或页面或是其它类型的 Post 表的数据；

//返回id为10的Post对象实例，如果没有就返回一个空的Post对象实例 $post = GetPost(array('id'=>10)) //返回object(Post类型)Copy to clipboardErrorCopied

array 参数如下

array(   'id' => 10, //指定 ID（可省略）   'title' => 'abc', //指定 Post 标题（可省略）   'alias' => 'cba', //指定 Post 别名（可省略）   'titleoralias' => 'ddd', //指定 Post 标题 or 别名（可省略）   'idorname' => 'fff', //指定 Post 的 ID 或标题 or 别名（可省略）   //以下是原$option 参数的 key 键   'post_type' => null, //指定查询 Post 表的类型 （可省略）   'post_status' => null, //指定查询 Post 表的状态 （可省略）   'only_article' => false, //指定是查找文章 （可省略）   'only_page' => false, //指定是查找页面 （可省略）   'where_custom' => array(array('=', 'log_Template', '')), //自定义 where   'order_custom' => array('log_CommNums' => 'ASC'), //自定义 order )Copy to clipboardErrorCopied

GetVars()

• 可快速获取 GET/POST/COOKIE 等传值；

• 不存在时将默认返回null，无需isset($_GET['act'])判断；

• 可通过第三个可选参数决定默认返回值；

• 其实第二个参数大小写不敏感，但是不知道为什么习惯上还是大写；

$act = GetVars("act", "GET"); $name = GetVars("name", "POST"); $password = GetVars("password", "COOKIE", "12345678");Copy to clipboardErrorCopied

GetValueInArray()

• 从数组中获取指定键值的元素；(可以省去了 isset 判断)

• 内部封装了所需键值是否存在的判断，不存在时返回第三个参数；

• 第三个参数可省，默认值为 null；

  $siteInfos = array(     "url" => "https://docs.zblogcn.com/php/",     "git" => "https://github.com/zblogcn/docs-zblogphp",     "engine" => "docsify",   );   $siteUrl = GetValueInArray($siteInfos, "url", "");   //或是   $siteUrl = GetValueInArray($siteInfos, 'url');   echo $siteUrl;   // https://docs.zblogcn.com/php/Copy to clipboardErrorCopied

GetImagesFromHtml()

从 HTML 中获取所有图片；

参数及返回值；

// @param  string $html // @return arrayCopy to clipboardErrorCopied

访问来源信息

// IP GetGuestIP(); // HTTP_USER_AGENT GetGuestAgent(); // 访问来源 URL GetRequestUri();Copy to clipboardErrorCopied

获取空间环境信息

此处部分信息会在初始化时赋值给常量，可直接使用，见「zb_system\function\c_system_base.php」

// 系统信息概览 var_dump(GetEnvironment()); // string(73) "WINNT10.0; IIS10.0; PHP7.4.21x64; mysqli5.7.23; curl7.70.0; OpenSSL1.1.1k" // 以下是其他相关函数 // 请求协议 GetScheme($_SERVER) // web 服务 - Nginx / Apache / IIS GetWebServer() // 操作系统 GetSystem() // PHP 版本 GetPHPVersion() Copy to clipboardErrorCopied

common.php 函数简介

HTTP 服务器及系统检测函数

获取 Scheme

GetScheme($array)

获取服务器

GetWebServer()

获取操作系统

GetSystem()

获取 PHP 解析引擎

GetPHPEngine()

PHP Version

GetPHPVersion()

获取当前网站地址

GetCurrentHost($blogpath, &$cookiesPath)

设置 http 状态头

SetHttpStatusCode($number, $force = false)

用 script 标签进行跳转

RedirectByScript($url)

302 跳转

Redirect302($url)

http 302 跳转

Redirect($url)

301 跳转

Redirect301($url)

输出 Http404

Http404()

输出 Http500

Http500()

输出 Http503

Http503()

设置 304 缓存头

Http304($filename, $time)

获取客户端 IP

GetGuestIP()

获取客户端 Agent

GetGuestAgent()

获取请求来源 URL

GetRequestUri()

获取请求 Script Name

GetRequestScript()

获取指定时区名

GetTimeZoneByGMT($z)

获得系统信息

GetEnvironment($more = false)

拿到后台的 CSP Heaeder

GetBackendCSPHeader()

检查移动端

zbp_is_mobile()

检查移动端

CheckIsMobile()

通过 URL 获取远程页面内容

GetHttpContent($url)

文件及目录处理函数

自动加载类文件

AutoloadClass($className)

管理自动加载类文件的目录

AddAutoloadClassDir($dir, $prepend = false)

通过文件获取应用 URL 地址

plugin_dir_url($file)

通过文件获取应用目录路径

plugin_dir_path($file)

获取目录下文件夹列表(递归)

GetDirsInDir_Recursive($dir)

获取目录下指定类型文件列表(递归)

GetFilesInDir_Recursive($dir, $type)

获取当前目录下文件夹列表

GetDirsInDir($dir)

获取当前目录下指定类型文件列

GetFilesInDir($dir, $type)

获取文件后缀名

GetFileExt($f)

获取文件权限

GetFilePermsOct($f)

获取文件权限（字符表达格式）

GetFilePerms($f)

删除文件 BOM 头

RemoveBOM($s)

检查重复加载的

CheckIncludedFiles($file)

数组处理类函数

获取$_GET, $_POST 等数组的参数值

GetVars($name, $type = 'REQUEST', $default = null)

从一系列指定的环境变量获得参数值

GetVarsFromEnv($name, $source = '', $default = '')

解析 env:设置项目读取环境变量获得参数值

GetOptionVarsFromEnv($value)

拿到 ID 数组 by List 列表

GetIDArrayByList($array, $keyname = null)

判断数组是否已经有$key，如果没有就 set 一次$default

Array_Isset(&$array, $key, $default)

数组 转 对象

array_to_object($arr)

对象 转 数组

object_to_array($obj)

字符串处理类函数

分割 string 并取某项数据

SplitAndGet($string, $delimiter, $n = 0)

删除连续空格

RemoveMoreSpaces($s)

向字符串型的参数表加入一个新参数

AddNameInString($s, $name)

从字符串型的参数表中删除一个参数

DelNameInString($s, $name)

在字符串参数值查找参数

HasNameInString($s, $name)

验证字符串是否符合正则表达式

CheckRegExp($source, $para)

获取 UTF8 格式的字符串的子串

SubStrUTF8_Start($sourcestr, $start)

获取 UTF8 格式的字符串的子串

SubStrUTF8($sourcestr, $cutlength)

ZBP 版获取 UTF8 格式的字符串的子串

Zbp_SubStr($sourcestr, $start)

ZBP 版 StrLen

Zbp_StrLen($string)

ZBP 版 Strpos

Zbp_Strpos($haystack, $needle, $offset = 0)

ZBP 版 Stripos

Zbp_Stripos($haystack, $needle, $offset = 0)

截取 HTML 格式的 UTF8 格式的字符串的子串

SubStrUTF8_Html($source, $length)

获得一个只含数字字母和-线的 string

FilterCorrectName($s)

确认一个对象是否可被转换为 string

CheckCanBeString($obj)

实现 utf84mb4 的过滤

utf84mb_filter(&$sql)

清除一串代码内所有的 PHP 代码

RemovePHPCode($code)

中文与特殊字符友好的 JSON 编码

JsonEncode($arr)

UCS-2BE 转 UTF-8，解决 JSON 中文转码问题

Ucs2Utf8($matchs)

HTML 文本处理转换类函数

格式化字符串

FormatString($source, $para)

同上

TransferHTML($source, $para)

封装 HTML 标签

CloseTags($html)

对数组内的字符串进行 htmlspecialchars

htmlspecialchars_array($array)

递归转义 HTML 实体

RecHtmlSpecialChars(&$arr)

从 HTML 中获取所有图片

GetImagesFromHtml($html)

URL 判断处理类函数

构造带 Token 的安全 URL

BuildSafeURL($url, $appId = '')

构造 cmd.php 的访问链接

BuildSafeCmdURL($paramters)

把 Url 前的 https:// 和 http:// 替换成 //

RemoveProtocolFromUrl($url)

判断 URL 是否为本地

CheckUrlIsLocal($url)

把 URL 中的 Host 转换为本地路径

UrlHostToPath($url)

rawurlencode 转义但不转义/

rawurlencode_without_backslash($s)

SWoole 及 Workerman 相关函数

将 swoole 和 workerman 下的$request 数组转换为$GLOBALS 全局数组

http_request_convert_to_global($request)

获取 swoole 或 workerman 或标准 php 环境下的原始 post data

get_http_raw_post_data(&$request = null)

错误输出及记录函数

以 JSON 形式输出错误信息（用于 ShowError 接口）

JsonError4ShowErrorHook($errorCode, $errorString, $file, $line)

以 JSON 形式输出错误信息.(err code 为(int)0 认为是没有错误，所以把 0 转为 1)

JsonError($errorCode, $errorString, $data)

当代码正常运行时，以 JSON 形式输出信息

JsonReturn($data)

XML-RPC 应答错误页面

RespondError($errorCode, $errorString = '', $file = '', $line = '')

Script 脚本错误页面

ScriptError($errorCode, $errorText = '', $file = '', $line = '')

记录日志

Logs($logString, $level = 'INFO', $source = 'system')

Logs 指定的变量的值

Logs_Dump()

系统其它类函数

初始化统计信息

RunTime_Begin()

输出页面运行时长

RunTime($isOutput = true)

获取 Guid

GetGuid()

获取随机的 sqlite 数据库名

GetDbName()

安全检测判断类函数

简易版本的字符串加扰函数

zbp_string_auth_code($data, $operation, $password, $additional = null)

验证 Web Token 是否合法

VerifyWebToken($webTokenString, $webTokenId, $key = '')

创建 Web Token

CreateWebToken($webTokenId, $time, $key = '')

检测来源是否合法，这包括 CSRF 检测，在开启增强安全模式时加入来源检测

CheckIsRefererValid()

验证 CSRF Token 是否合法

CheckCSRFTokenValid($fieldName = 'csrfToken', $methods = array('get', 'post'))

检测 HTTP Referer 是否合法

CheckHTTPRefererValid()

zbp 限流函数 (依赖 zbp_cache 插件)

zbp_throttle($name = 'default', $max_reqs = 60, $period = 60)

加解密类的函数

1.7.3 开始系统集成了 ZbpEncrypt 加密类

AES 对称加密函数

// 加密函数 ZbpEncrypt::encrypt($data, $password, $additional = null, $type = null) # $data 原文string # $password 密码 # $additional 附加认证数据(可设为null) # $type 可以指定类型为 aes256gcm, aes256cbc, sm4 // 解密函数 ZbpEncrypt::decrypt($data, $password, $additional = null, $type = null) # $data 待解密的string # 注意： # aes256gcm 需要openssl或sodium扩展实现 (PHP >= 7.1.0) # aes256cbc 需要mcrypt或openssl扩展实现 # sm4 需要openssl扩展实现 (PHP >= 7.2.0) # 推荐使用 aes256gcm # 如果不指定$type则会自动判断，依次尝试使用aes256gcm>aes256cbcCopy to clipboardErrorCopied

//aes256gcm加解密函数使用示范 $endata = ZbpEncrypt::encrypt('原文字符串', '12345', 'add', 'aes256gcm'); $dedata = ZbpEncrypt::decrypt($endata, '12345', 'add', 'aes256gcm'); var_dump($dedata);// string(15) "原文字符串" //或是 $endata = ZbpEncrypt::aes256gcm_encrypt('原文字符串', '12345'); $dedata = ZbpEncrypt::aes256gcm_decrypt($endata, '12345'); //aes256加解密函数(支持cbc,cfb,ctr,ecb,ofb模式) $endata = ZbpEncrypt::aes256_encrypt('原文字符串', '12345', '', 'ofb'); $dedata = ZbpEncrypt::aes256_decrypt($endata, '12345', '', 'ofb'); //sm4加解密函数使用示范 (支持cbc,cfb,ctr,ecb,ofb模式) $endata = ZbpEncrypt::sm4_encrypt('原文字符串', '12345', '', 'cbc'); $dedata = ZbpEncrypt::sm4_decrypt($endata, '12345', '', 'cbc'); //用于和其它系统对接的，原汁原味版的aes256gcm加解密 ZbpEncrypt::original_aes256gcm_encrypt($data, $password, $additional, $nonce) ZbpEncrypt::original_aes256gcm_decrypt($data, $password, $additional, $nonce) //需要输入三种参数 $password, $additional, $nonce //$password 为 32字节长度 $nonce 为 12字节长度 Copy to clipboardErrorCopied

RSA 非对称加密函数

// RSA非对称公钥加密函数 ZbpEncrypt::rsa_public_encrypt($data, $public_key_pem, $key_length = 2048) # $data 原文string # $public_key_pem 公钥pem字符串 # $key_length 密钥长度默认2048 // RSA非对称公钥解密函数 ZbpEncrypt::rsa_public_decrypt($data, $public_key_pem, $key_length = 2048) # $data 待解密的string // RSA非对称私钥加密函数 ZbpEncrypt::rsa_private_encrypt($data, $private_key_pem, $key_length = 2048) # $private_key_pem 私钥pem字符串 // RSA非对称私钥解密函数 ZbpEncrypt::rsa_private_decrypt($data, $private_key_pem, $key_length = 2048)Copy to clipboardErrorCopied

//rsa函数使用示范 $rsa_config = array(      'digest_alg' => 'sha512',      'private_key_bits' => 2048,      'private_key_type' => OPENSSL_KEYTYPE_RSA, ); //创建公私钥 $res = openssl_pkey_new($rsa_config); //获取私钥 openssl_pkey_export($res, $private_key); //获取公钥 $public_key = openssl_pkey_get_details($res)['key']; //使用私钥加密 $endata = ZbpEncrypt::rsa_private_encrypt('原文字符串', $private_key); //使用公钥解密 $dedata = ZbpEncrypt::rsa_public_decrypt($endata, $public_key); var_dump($dedata);// string(15) "原文字符串" //使用公钥加密 $endata = ZbpEncrypt::rsa_public_encrypt('原文字符串', $public_key); //使用私钥解密 $dedata = ZbpEncrypt::rsa_private_decrypt($endata, $private_key); var_dump($dedata);// string(15) "原文字符串" Copy to clipboardErrorCopied