====== c_system_common 里全部函数列表 ======
==== GetScheme() ====
=== 说明 ===
得到请求协议(考虑到反向代理等原因,未必准确) 如果想获取准确的值,请zbp->Load后使用$zbp->isHttps.
=== 参数与返回值 ===
param (array) $array:
return (string)
/**
* 得到请求协议(考虑到反向代理等原因,未必准确) 如果想获取准确的值,请zbp->Load后使用$zbp->isHttps.
*
* @param array $array
* @return string *
*/
}
function GetScheme($array)
==== GetWebServer() ====
=== 说明 ===
获取服务器.
=== 参数与返回值 ===
return (integer)
/**
* 获取服务器.
*
* @return integer *
*/
}
function GetWebServer()
==== GetSystem() ====
=== 说明 ===
获取操作系统
=== 参数与返回值 ===
return (integer)
/**
* 获取操作系统
*
* @return integer *
*/
}
function GetSystem()
==== GetPHPEngine() ====
=== 说明 ===
获取PHP解析引擎.
=== 参数与返回值 ===
return (integer)
/**
* 获取PHP解析引擎.
*
* @return integer *
*/
}
function GetPHPEngine()
==== GetPHPVersion() ====
=== 说明 ===
获取PHP Version.
=== 参数与返回值 ===
return (string)
/**
* 获取PHP Version.
*
* @return string *
*/
}
function GetPHPVersion()
==== AutoloadClass() ====
=== 说明 ===
自动加载类文件.
=== 参数与返回值 ===
param (string) $className: 类名
return (mixed)
/**
* 自动加载类文件.
*
* @param string $className
* @return mixed *
*/
}
function AutoloadClass($className)
==== Logs() ====
=== 说明 ===
记录日志.
=== 参数与返回值 ===
param (string) $logString:
param (boolean) $isError:
return (boolean)
/**
* 记录日志.
*
* @param string $logString
* @param boolean $isError
* @return boolean *
*/
}
function Logs($logString,$isError)
==== RunTime() ====
=== 说明 ===
输出页面运行时长
=== 参数与返回值 ===
param (boolean) $isOutput: 是否输出(考虑历史原因,默认输出)
return (array)
/**
* 输出页面运行时长
*
* @param boolean $isOutput
* @return array *
*/
}
function RunTime($isOutput)
==== GetEnvironment() ====
=== 说明 ===
获得系统信息.
=== 参数与返回值 ===
return (string)
/**
* 获得系统信息.
*
* @return string *
*/
}
function GetEnvironment()
==== plugin_dir_url() ====
=== 说明 ===
通过文件获取应用URL地址
=== 参数与返回值 ===
param (string) $file: 文件名
return (string)
/**
* 通过文件获取应用URL地址
*
* @param string $file
* @return string *
*/
}
function plugin_dir_url($file)
==== plugin_dir_path() ====
=== 说明 ===
通过文件获取应用目录路径.
=== 参数与返回值 ===
param () $file:
return (string)
/**
* 通过文件获取应用目录路径.
*
* @param $file
* @return string *
*/
}
function plugin_dir_path($file)
==== GetValueInArray() ====
=== 说明 ===
通过Key从数组获取数据.
=== 参数与返回值 ===
param (array) $array: 数组名
param (string) $name: 下标key
return (mixed)
/**
* 通过Key从数组获取数据.
*
* @param array $array
* @param string $name
* @return mixed *
*/
}
function GetValueInArray($array,$name)
==== GetValueInArrayByCurrent() ====
=== 说明 ===
获取数组中的当前元素数据.
=== 参数与返回值 ===
param (string) $array: 数组名
param (string) $name: 下标key
return (mixed)
/**
* 获取数组中的当前元素数据.
*
* @param string $array
* @param string $name
* @return mixed *
*/
}
function GetValueInArrayByCurrent($array,$name)
==== SplitAndGet() ====
=== 说明 ===
分割string并取某项数据.
=== 参数与返回值 ===
param (string) $string:
param (string) $delimiter:
param (integer) $n:
return (string)
/**
* 分割string并取某项数据.
*
* @param string $string
* @param string $delimiter
* @param integer $n
* @return string *
*/
}
function SplitAndGet($string,$delimiter,$n)
==== RemoveMoreSpaces() ====
=== 说明 ===
删除连续空格
=== 参数与返回值 ===
param () $s:
return (null|string|array)
/**
* 删除连续空格
*
* @param $s
* @return null *
*/
}
function RemoveMoreSpaces($s)
==== GetGuid() ====
=== 说明 ===
获取Guid.
=== 参数与返回值 ===
return (string)
/**
* 获取Guid.
*
* @return string *
*/
}
function GetGuid()
==== GetVars() ====
=== 说明 ===
获取参数值
=== 参数与返回值 ===
param (string) $name: 数组key名
param (string) $type: 默认为REQUEST
return (mixed|null)
/**
* 获取参数值
*
* @param string $name
* @param string $type
* @return mixed *
*/
}
function GetVars($name,$type)
==== GetVarsByDefault() ====
=== 说明 ===
获取参数值(可设置默认返回值).
=== 参数与返回值 ===
param (string) $name: 数组key名
param (string) $type: 默认为REQUEST
param (string) $default: 默认为null
return (mixed|null)
/**
* 获取参数值(可设置默认返回值).
*
* @param string $name
* @param string $type
* @param string $default
* @return mixed *
*/
}
function GetVarsByDefault($name,$type,$default)
==== GetDbName() ====
=== 说明 ===
获取数据库名.
=== 参数与返回值 ===
return (string)
/**
* 获取数据库名.
*
* @return string *
*/
}
function GetDbName()
==== GetCurrentHost() ====
=== 说明 ===
获取当前网站地址
=== 参数与返回值 ===
param (string) $blogpath: 网站域名
param (string) $cookiesPath: &$cookiesPath 返回cookie作用域值,要传引入
return (string)
/**
* 获取当前网站地址
*
* @param string $blogpath
* @param string $cookiesPath
* @return string *
*/
}
function GetCurrentHost($blogpath,$cookiesPath)
==== GetHttpContent() ====
=== 说明 ===
通过URL获取远程页面内容.
=== 参数与返回值 ===
param (string) $url: URL地址
return (string)
/**
* 通过URL获取远程页面内容.
*
* @param string $url
* @return string *
*/
}
function GetHttpContent($url)
==== GetDirsInDir() ====
=== 说明 ===
获取目录下文件夹列表.
=== 参数与返回值 ===
param (string) $dir: 目录
return (array)
/**
* 获取目录下文件夹列表.
*
* @param string $dir
* @return array *
*/
}
function GetDirsInDir($dir)
==== GetFilesInDir() ====
=== 说明 ===
获取目录下指定类型文件列表.
=== 参数与返回值 ===
param (string) $dir: 目录
param (string) $type: 文件类型,以|分隔
return (array)
/**
* 获取目录下指定类型文件列表.
*
* @param string $dir
* @param string $type
* @return array *
*/
}
function GetFilesInDir($dir,$type)
==== RedirectByScript() ====
=== 说明 ===
用script标签进行跳转.
=== 参数与返回值 ===
param (string) $url: 跳转链接
/**
* 用script标签进行跳转.
*
* @param string $url
*
*/
}
function RedirectByScript($url)
==== Redirect() ====
=== 说明 ===
302跳转.
=== 参数与返回值 ===
param (string) $url: 跳转链接
/**
* 302跳转.
*
* @param string $url
*
*/
}
function Redirect($url)
==== Redirect301() ====
=== 说明 ===
301跳转.
=== 参数与返回值 ===
param (string) $url: 跳转链接
/**
* 301跳转.
*
* @param string $url
*
*/
}
function Redirect301($url)
==== Http404() ====
=== 说明 ===
Http404
=== 参数与返回值 ===
/**
* Http404
*
*
*/
}
function Http404()
==== Http500() ====
=== 说明 ===
Http500
=== 参数与返回值 ===
/**
* Http500
*
*
*/
}
function Http500()
==== Http503() ====
=== 说明 ===
Http503
=== 参数与返回值 ===
/**
* Http503
*
*
*/
}
function Http503()
==== Http304() ====
=== 说明 ===
设置304缓存头.
=== 参数与返回值 ===
param (string) $filename: 文件名
param (string) $time: 缓存时间
/**
* 设置304缓存头.
*
* @param string $filename
* @param string $time
*
*/
}
function Http304($filename,$time)
==== GetGuestIP() ====
=== 说明 ===
获取客户端IP.
=== 参数与返回值 ===
return (string)
/**
* 获取客户端IP.
*
* @return string *
*/
}
function GetGuestIP()
==== GetGuestAgent() ====
=== 说明 ===
获取客户端Agent.
=== 参数与返回值 ===
return (string)
/**
* 获取客户端Agent.
*
* @return string *
*/
}
function GetGuestAgent()
==== GetRequestUri() ====
=== 说明 ===
获取请求来源URL.
=== 参数与返回值 ===
return (string)
/**
* 获取请求来源URL.
*
* @return string *
*/
}
function GetRequestUri()
==== GetFileExt() ====
=== 说明 ===
获取文件后缀名.
=== 参数与返回值 ===
param (string) $f: 文件名
return (string)
/**
* 获取文件后缀名.
*
* @param string $f
* @return string *
*/
}
function GetFileExt($f)
==== GetFilePermsOct() ====
=== 说明 ===
获取文件权限.
=== 参数与返回值 ===
param (string) $f: 文件名
return (string|null)
/**
* 获取文件权限.
*
* @param string $f
* @return string *
*/
}
function GetFilePermsOct($f)
==== GetFilePerms() ====
=== 说明 ===
获取文件权限.
=== 参数与返回值 ===
param (string) $f: 文件名
return (string|null)
/**
* 获取文件权限.
*
* @param string $f
* @return string *
*/
}
function GetFilePerms($f)
==== AddNameInString() ====
=== 说明 ===
向字符串型的参数表加入一个新参数.
=== 参数与返回值 ===
param (string) $s: 字符串型的参数表,以|符号分隔
param (string) $name: 参数名
return (string)
/**
* 向字符串型的参数表加入一个新参数.
*
* @param string $s
* @param string $name
* @return string *
*/
}
function AddNameInString($s,$name)
==== DelNameInString() ====
=== 说明 ===
从字符串型的参数表中删除一个参数.
=== 参数与返回值 ===
param (string) $s: 字符串型的参数表,以|符号分隔
param (string) $name: 参数名
return (string)
/**
* 从字符串型的参数表中删除一个参数.
*
* @param string $s
* @param string $name
* @return string *
*/
}
function DelNameInString($s,$name)
==== HasNameInString() ====
=== 说明 ===
在字符串参数值查找参数.
=== 参数与返回值 ===
param (string) $s: 字符串型的参数表,以|符号分隔
param (string) $name: 参数名
return (boolean)
/**
* 在字符串参数值查找参数.
*
* @param string $s
* @param string $name
* @return boolean *
*/
}
function HasNameInString($s,$name)
==== JsonError4ShowErrorHook() ====
=== 说明 ===
以JSON形式输出错误信息(用于ShowError接口).
=== 参数与返回值 ===
param () $errorCode:
param () $errorString:
param () $file:
param () $line:
/**
* 以JSON形式输出错误信息(用于ShowError接口).
*
* @param $errorCode
* @param $errorString
* @param $file
* @param $line
*
*/
}
function JsonError4ShowErrorHook($errorCode,$errorString,$file,$line)
==== JsonError() ====
=== 说明 ===
以JSON形式输出错误信息.
=== 参数与返回值 ===
param (string) $errorCode: 错误编号
param (string) $errorString: 错误内容
param (object) $data:
/**
* 以JSON形式输出错误信息.
*
* @param string $errorCode
* @param string $errorString
* @param object $data
*
*/
}
function JsonError($errorCode,$errorString,$data)
==== JsonReturn() ====
=== 说明 ===
当代码正常运行时,以JSON形式输出信息.
=== 参数与返回值 ===
param (object) $data: 待返回内容
/**
* 当代码正常运行时,以JSON形式输出信息.
*
* @param object $data
*
*/
}
function JsonReturn($data)
==== RespondError() ====
=== 说明 ===
XML-RPC应答错误页面.
=== 参数与返回值 ===
param () $errorCode:
param () $errorString:
param () $file:
param () $line:
return (void)
/**
* XML-RPC应答错误页面.
*
* @param $errorCode
* @param $errorString
* @param $file
* @param $line
* @return void *
*/
}
function RespondError($errorCode,$errorString,$file,$line)
==== ScriptError() ====
=== 说明 ===
XML-RPC脚本错误页面.
=== 参数与返回值 ===
param (string) $errorCode: 错误提示字符串
param (string) $errorText:
param (string) $file:
param (string) $line:
return (void)
/**
* XML-RPC脚本错误页面.
*
* @param string $errorCode
* @param string $errorText
* @param string $file
* @param string $line
* @return void *
*/
}
function ScriptError($errorCode,$errorText,$file,$line)
==== CheckRegExp() ====
=== 说明 ===
验证字符串是否符合正则表达式.
=== 参数与返回值 ===
param (string) $source: 字符串
param (string) $para: 正则表达式,可用[username]|[password]|[email]|[homepage]或自定义表达式
return (boolean)
/**
* 验证字符串是否符合正则表达式.
*
* @param string $source
* @param string $para
* @return boolean *
*/
}
function CheckRegExp($source,$para)
==== FormatString() ====
=== 说明 ===
格式化字符串.
=== 参数与返回值 ===
param (string) $source: 字符串
param (string) $para: 正则表达式,可用[html-format]|[nohtml]|[noscript]|[enter]|[noenter]|[filename]|[normalname]或自定义表达式
return (string)
/**
* 格式化字符串.
*
* @param string $source
* @param string $para
* @return string *
*/
}
function FormatString($source,$para)
==== TransferHTML() ====
=== 说明 ===
格式化字符串
=== 参数与返回值 ===
param (string) $source:
param (string) $param:
/**
* 格式化字符串
*
* @param string $source
* @param string $param
*
*/
}
function TransferHTML($source,$param)
==== CloseTags() ====
=== 说明 ===
封装HTML标签.
=== 参数与返回值 ===
param (string) $html: html源码
return (string)
/**
* 封装HTML标签.
*
* @param string $html
* @return string *
*/
}
function CloseTags($html)
==== SubStrUTF8_Start() ====
=== 说明 ===
获取UTF8格式的字符串的子串.
=== 参数与返回值 ===
param (string) $sourcestr: 源字符串
param (integer) $start: 起始位置
return (string)
/**
* 获取UTF8格式的字符串的子串.
*
* @param string $sourcestr
* @param integer $start
* @return string *
*/
}
function SubStrUTF8_Start($sourcestr,$start)
==== SubStrUTF8() ====
=== 说明 ===
获取UTF8格式的字符串的子串.
=== 参数与返回值 ===
param (string) $sourcestr: 源字符串
param (integer) $cutlength: 子串长度
return (string)
/**
* 获取UTF8格式的字符串的子串.
*
* @param string $sourcestr
* @param integer $cutlength
* @return string *
*/
}
function SubStrUTF8($sourcestr,$cutlength)
==== Zbp_SubStr() ====
=== 说明 ===
ZBP版获取UTF8格式的字符串的子串.
=== 参数与返回值 ===
param (string) $sourcestr:
param (integer) $start:
return (string)
/**
* ZBP版获取UTF8格式的字符串的子串.
*
* @param string $sourcestr
* @param integer $start
* @return string *
*/
}
function Zbp_SubStr($sourcestr,$start)
==== Zbp_StrLen() ====
=== 说明 ===
ZBP版StrLen.
=== 参数与返回值 ===
param (string) $string:
return (string)
/**
* ZBP版StrLen.
*
* @param string $string
* @return string *
*/
}
function Zbp_StrLen($string)
==== Zbp_Strpos() ====
=== 说明 ===
ZBP版Strpos
=== 参数与返回值 ===
param (string) $haystack:
param (string) $needle:
param (integer) $offset:
return (string)
/**
* ZBP版Strpos
*
* @param string $haystack
* @param string $needle
* @param integer $offset
* @return string *
*/
}
function Zbp_Strpos($haystack,$needle,$offset)
==== Zbp_Stripos() ====
=== 说明 ===
ZBP版Stripos
=== 参数与返回值 ===
param (string) $haystack:
param (string) $needle:
param (integer) $offset:
return (string)
/**
* ZBP版Stripos
*
* @param string $haystack
* @param string $needle
* @param integer $offset
* @return string *
*/
}
function Zbp_Stripos($haystack,$needle,$offset)
==== SubStrUTF8_Html() ====
=== 说明 ===
截取HTML格式的UTF8格式的字符串的子串.
=== 参数与返回值 ===
param (string) $source: 源字符串
param (integer) $length: 子串长度
return (string)
/**
* 截取HTML格式的UTF8格式的字符串的子串.
*
* @param string $source
* @param integer $length
* @return string *
*/
}
function SubStrUTF8_Html($source,$length)
==== RemoveBOM() ====
=== 说明 ===
删除文件BOM头.
=== 参数与返回值 ===
param (string) $s: 文件内容
return (string)
/**
* 删除文件BOM头.
*
* @param string $s
* @return string *
*/
}
function RemoveBOM($s)
==== GetTimeZoneByGMT() ====
=== 说明 ===
获取指定时区名.
=== 参数与返回值 ===
param (integer) $z: 时区号
return (string)
/**
* 获取指定时区名.
*
* @param integer $z
* @return string *
*/
}
function GetTimeZoneByGMT($z)
==== htmlspecialchars_array() ====
=== 说明 ===
对数组内的字符串进行htmlspecialchars.
=== 参数与返回值 ===
param (array) $array: 待过滤字符串
return (array)
/**
* 对数组内的字符串进行htmlspecialchars.
*
* @param array $array
* @return array *
*/
}
function htmlspecialchars_array($array)
==== FilterCorrectName() ====
=== 说明 ===
获得一个只含数字字母和-线的string.
=== 参数与返回值 ===
param (string) $s: 待过滤字符串
return (string|array)
/**
* 获得一个只含数字字母和-线的string.
*
* @param string $s
* @return string *
*/
}
function FilterCorrectName($s)
==== CheckCanBeString() ====
=== 说明 ===
确认一个对象是否可被转换为string.
=== 参数与返回值 ===
param (object) $obj:
return (boolean)
/**
* 确认一个对象是否可被转换为string.
*
* @param object $obj
* @return boolean *
*/
}
function CheckCanBeString($obj)
==== BuildSafeURL() ====
=== 说明 ===
构造带Token的安全URL.
=== 参数与返回值 ===
param (string) $url:
param (string) $appId: 应用ID,可以生成一个应用专属的Token
return (string)
/**
* 构造带Token的安全URL.
*
* @param string $url
* @param string $appId
* @return string *
*/
}
function BuildSafeURL($url,$appId)
==== BuildSafeCmdURL() ====
=== 说明 ===
构造cmd.php的访问链接.
=== 参数与返回值 ===
param (string) $paramters: cmd.php参数
return (boolean)
/**
* 构造cmd.php的访问链接.
*
* @param string $paramters
* @return boolean *
*/
}
function BuildSafeCmdURL($paramters)
==== utf84mb_filter() ====
=== 说明 ===
实现utf84mb4的过滤
=== 参数与返回值 ===
param (string) $sql:
return (string)
/**
* 实现utf84mb4的过滤
*
* @param string $sql
* @return string *
*/
}
function utf84mb_filter($sql)
==== utf84mb_fixHtmlSpecialChars() ====
=== 说明 ===
实现utf84mb的fixHtmlSpecialChars
=== 参数与返回值 ===
return (string)
/**
* 实现utf84mb的fixHtmlSpecialChars
*
* @return string *
*/
}
function utf84mb_fixHtmlSpecialChars()
==== utf84mb_convertToUCS4() ====
=== 说明 ===
实现utf84mb的convertToUCS4
=== 参数与返回值 ===
param (string) $matches:
return (string)
/**
* 实现utf84mb的convertToUCS4
*
* @param string $matches
* @return string *
*/
}
function utf84mb_convertToUCS4($matches)
==== utf84mb_convertToUTF8() ====
=== 说明 ===
实现utf84mb的convertToUTF8
=== 参数与返回值 ===
param (string) $matches:
return (string)
/**
* 实现utf84mb的convertToUTF8
*
* @param string $matches
* @return string *
*/
}
function utf84mb_convertToUTF8($matches)
==== VerifyWebToken() ====
=== 说明 ===
验证Web Token是否合法.
=== 参数与返回值 ===
param () $webTokenString:
param () $webTokenId:
param (string) $key:
return (boolean)
/**
* 验证Web Token是否合法.
*
* @param $webTokenString
* @param $webTokenId
* @param string $key
* @return boolean *
*/
}
function VerifyWebToken($webTokenString,$webTokenId,$key)
==== CreateWebToken() ====
=== 说明 ===
创建Web Token.
=== 参数与返回值 ===
param () $webTokenId:
param () $time:
param (string) $key:
return (string)
/**
* 创建Web Token.
*
* @param $webTokenId
* @param $time
* @param string $key
* @return string *
*/
}
function CreateWebToken($webTokenId,$time,$key)
==== CheckIsRefererValid() ====
=== 说明 ===
检测来源是否合法,这包括CSRF检测,在开启增强安全模式时加入来源检测.
=== 参数与返回值 ===
/**
* 检测来源是否合法,这包括CSRF检测,在开启增强安全模式时加入来源检测.
*
*
*/
}
function CheckIsRefererValid()
==== CheckCSRFTokenValid() ====
=== 说明 ===
验证CSRF Token是否合法.
=== 参数与返回值 ===
param (string) $fieldName:
param (array) $methods:
return (boolean)
/**
* 验证CSRF Token是否合法.
*
* @param string $fieldName
* @param array $methods
* @return boolean *
*/
}
function CheckCSRFTokenValid($fieldName,$methods)
==== CheckHTTPRefererValid() ====
=== 说明 ===
检测HTTP Referer是否合法.
=== 参数与返回值 ===
return (boolean)
/**
* 检测HTTP Referer是否合法.
*
* @return boolean *
*/
}
function CheckHTTPRefererValid()
==== RemovePHPCode() ====
=== 说明 ===
清除一串代码内所有的PHP代码
=== 参数与返回值 ===
param (string) $code:
return (string)
/**
* 清除一串代码内所有的PHP代码
*
* @param string $code
* @return string *
*/
}
function RemovePHPCode($code)
==== GetIDArrayByList() ====
=== 说明 ===
拿到ID数组byList列表
=== 参数与返回值 ===
param (array) $array:
param (string) $keyname:
return (array)
/**
* 拿到ID数组byList列表
*
* @param array $array
* @param string $keyname
* @return array *
*/
}
function GetIDArrayByList($array,$keyname)
==== GetBackendCSPHeader() ====
=== 说明 ===
拿到后台的CSP Heaeder
=== 参数与返回值 ===
return (string)
/**
* 拿到后台的CSP Heaeder
*
* @return string *
*/
}
function GetBackendCSPHeader()
==== CheckIncludedFiles() ====
=== 说明 ===
检查重复加载的.
=== 参数与返回值 ===
param (string) $file:
return (boolean)
/**
* 检查重复加载的.
*
* @param string $file
* @return boolean *
*/
}
function CheckIncludedFiles($file)
==== Logs_Dump() ====
=== 说明 ===
Logs指定的变量的值
=== 参数与返回值 ===
/**
* Logs指定的变量的值
*
*
*/
}
function Logs_Dump()