\ZBlogPHP

zbp全局操作类.

Summary

Methods

Properties

Constants

GetInstance()
InitializeDB()
__construct()
__destruct()
__call()
__set()
__get()
Initialize()
Load()
LoadManage()
Terminate()
OpenConnect()
ConvertTableAndDatainfo()
CloseConnect()
StartSession()
EndSession()
LoadConfigs()
LoadConfigsOnlySystem()
SaveConfig()
DelConfig()
Config()
HasConfig()
SaveCache()
LoadCache()
SaveOption()
LoadOption()
CheckRights()
CheckRightsByLevel()
Verify()
VerifyResult()
GenerateUserToken()
VerifyUserToken()
Verify_MD5()
Verify_Original()
Verify_Final()
Verify_Token()
LoadMembers()
LoadCategories()
LoadTags()
LoadModules()
LoadThemes()
LoadPlugins()
LoadApp()
CheckPlugin()
CheckApp()
GetPreActivePlugin()
LoadLanguage()
ReflushLanguages()
ReloadLanguages()
PrepareTemplate()
BuildTemplate()
CheckTemplate()
BuildModule()
RegBuildModule()
RegBuildModules()
AddBuildModule()
DelBuildModule()
GetListCustom()
GetListCustomByArray()
GetListType()
GetListOrigin()
GetListTypeByArray()
GetPostList()
GetPostByArray()
GetArticleList()
GetPageList()
GetCommentList()
GetMemberList()
GetTagList()
GetCategoryList()
GetModuleList()
GetUploadList()
get_results()
GetSomeThing()
GetPostByID()
GetCategoryByID()
GetCategoryByName()
GetCategoryByAlias()
GetCategoryByAliasOrName()
GetModuleByID()
GetModuleByFileName()
GetMemberByID()
GetMemberByName()
GetMemberByNameOrAlias()
GetMemberByEmail()
CheckMemberNameExist()
CheckMemberByNameOrAliasExist()
CheckMemberByEmailExist()
GetCommentByID()
GetUploadByID()
GetTagByAlias()
GetTagByAliasOrName()
GetTagByID()
LoadTagsByIDString()
LoadTagsByNameString()
ConvertTagIDtoString()
GetTopArticle()
GetCmtKey()
ValidCmtKey()
GetCSRFToken()
VerifyCSRFToken()
ShowValidCode()
CheckValidCode()
AddItemToNavbar()
DelItemToNavbar()
CheckItemToNavbar()
SetHint()
GetHint()
ShowHint()
ShowError()
CheckGzip()
StartGzip()
CheckSiteClosed()
RedirectInstall()
RedirectPermanentDomain()
RegPostType()
GetPostType_Name()
GetPostType_UrlRule()
GetPostType_Template()
GetPostType_CategoryType()
GetPostType_TagType()
RegAction()
GetActionDescription()
SetExclusive()
IsExclusive()
Verify_MD5Path()
GetToken()
ValidToken()
LoadCategorys()
GetWebToken()
ValidWebToken()

$version
$db
$option
$lang
$langs
$langpacklist
$path
$host
$cookiespath
$guid
$currenturl
$fullcurrenturl
$usersdir
$verifyCodeUrl
$validcodeurl
$feedurl
$searchurl
$ajaxurl
$xmlrpcurl
$members
$membersbyname
$categorys
$categories
$categorysbyorder
$categoriesbyorder
$modules
$modulesbyfilename
$configs
$tags
$tagsbyname
$comments
$posts
$title
$name
$subname
$theme
$themeinfo
$style
$user
$cache
$table
$datainfo
$posttype
$actions
$action
$ismanage
$isHttps
$template
$socialcomment
$header
$footer
$activedapps
$activeapps
$managecount
$pagebarcount
$searchcount
$displaycount
$commentdisplaycount
$csrfExpiration
$themeapp

No constants found

No protected methods found

$_exclusive

N/A

GetSomeThingByAlias()
GetSomeThingById()
GetSomeThingByAttr()

$_zbp
$isinitialized
$isconnected
$isload
$issession
$isGzip
$prvConfigList
$cache_hash
$hint1
$hint2
$hint3
$hint4
$hint5

N/A

File: zb_system/function/lib/zblogphp.php
Package: Default
Class hierarchy: \ZBlogPHP

Tags

None found

Properties

$version

$version : string

Type

string — 版本号

$db

$db : \Database__Interface

Type

\Database__Interface — 数据库

$option

$option : array

Type

array — 配置选项

$lang

$lang : array

Type

array — 语言

$langs

$langs : \json类型

Type

\json类型 — 语言

$langpacklist

$langpacklist : array

Type

array — 语言包list

$path

$path : string

Type

string — 路径

$host

$host : string

Type

string — 域名

$cookiespath

$cookiespath : string

Type

string — cookie作用域

$guid

$guid : string

Type

string — guid

$currenturl

$currenturl : string

Type

string — 当前链接

$fullcurrenturl

$fullcurrenturl : string

Type

string — 当前链接

$usersdir

$usersdir : string

Type

string — 用户目录

$verifyCodeUrl

$verifyCodeUrl : string

Type

string — 验证码地址

$validcodeurl

$validcodeurl : string

Type

string — 验证码地址（拼写错误）

$feedurl

$feedurl : string

Type

string

$searchurl

$searchurl : string

Type

string

$ajaxurl

$ajaxurl : string

Type

string

$xmlrpcurl

$xmlrpcurl : string

Type

string

$members

$members : array<mixed,\Member>

Type

array<mixed,\Member> — 用户数组

$membersbyname

$membersbyname : array<mixed,\Member>

Type

array<mixed,\Member> — 用户数组（以用户名为键）

$categorys

$categorys : array<mixed,\Category>

Type

array<mixed,\Category> — 分类数组

$categories

$categories :

Type

$categorysbyorder

$categorysbyorder : array<mixed,\Category>

Type

array<mixed,\Category> — 分类数组（已排序）

$categoriesbyorder

$categoriesbyorder :

Type

$modules

$modules : array<mixed,\Module>

Type

array<mixed,\Module> — 模块数组

$modulesbyfilename

$modulesbyfilename : array<mixed,\Module>

Type

array<mixed,\Module> — 模块数组（以文件名为键）

$configs

$configs : array<mixed,\Config>

Type

array<mixed,\Config> — 配置选项

$tags

$tags : array<mixed,\Tag>

Type

array<mixed,\Tag> — 标签数组

$tagsbyname

$tagsbyname : array<mixed,\Tag>

Type

array<mixed,\Tag> — 标签数组（以标签名为键）

$comments

$comments : array<mixed,\Comment>

Type

array<mixed,\Comment> — 评论数组

$posts

$posts : array<mixed,\Post>

Type

array<mixed,\Post> — 文章列表数组

$title

$title : string

Type

string — 当前页面标题

$name

$name : string

Type

string — 网站名

$subname

$subname : string

Type

string — 网站子标题

$theme

$theme : \App

Type

\App — 当前主题

$themeinfo

$themeinfo : \array()

Type

\array() — 当前主题版本信息

$style

$style : string

Type

string — 当前主题风格

$user

$user : \Member

Type

\Member — 当前用户

$cache

$cache : \Config

Type

\Config — 缓存

$table

$table : array|null

Type

array|null — 数据表

$datainfo

$datainfo : array|null

Type

array|null — 数据表信息

$posttype

$posttype : array|null

Type

array|null — 类型序列

$actions

$actions : array|null

Type

array|null — 操作列表

$action

$action : mixed|null|string

Type

mixed|null|string — 当前操作

$ismanage

$ismanage :

Type

$isHttps

$isHttps :

Type

$template

$template : \Template

Type

\Template — 当前模板

$socialcomment

$socialcomment : null

Type

null — 社会化评论

$header

$header : null

Type

null — 模板头部

$footer

$footer : null

Type

null — 模板尾部

$activedapps

$activedapps : array

Type

array — 激活的插件列表

$activeapps

$activeapps :

Type

$managecount

$managecount : integer

Type

integer — 管理页面显示条数

$pagebarcount

$pagebarcount : integer

Type

integer — 页码显示条数

$searchcount

$searchcount : integer

Type

integer — 搜索返回条数

$displaycount

$displaycount : integer

Type

integer — 文章列表显示条数

$commentdisplaycount

$commentdisplaycount : integer

Type

integer — 评论显示数量

$csrfExpiration

$csrfExpiration : integer

Type

integer — 当前实例下CSRF Token过期时间（小时）

$themeapp

$themeapp : \App

Type

\App — 当前主题类

$_exclusive

$_exclusive :

Type

$_zbp

$_zbp :

Type

$isinitialized

$isinitialized :

Type

$isconnected

$isconnected :

Type

$isload

$isload :

Type

$issession

$issession :

Type

$isGzip

$isGzip :

Type

$prvConfigList

$prvConfigList :

载入插件Configs表 Only System Option.

Type

$cache_hash

$cache_hash :

Type

$hint1

$hint1 :

Type

$hint2

$hint2 :

Type

$hint3

$hint3 :

Type

$hint4

$hint4 :

Type

$hint5

$hint5 :

Type

Methods

GetInstance()

GetInstance() : null|\ZBlogPHP

获取唯一实例.

Returns

null|\ZBlogPHP

InitializeDB()

InitializeDB(string  $type) : \Database__Interface

初始化数据库连接.

Parameters

string

$type

数据连接类型

Returns

\Database__Interface

__construct()

__construct()

构造函数，加载基本配置到$zbp.

__destruct()

__destruct()

析构函数，释放资源.

__call()

__call(  $method,   $args) : mixed

Parameters

	$method
	$args

Returns

mixed

Inherited from: \ZBlogPHP

Tags

api	Filter_Plugin_Zbp_Call

__set()

__set(  $name,   $value) : mixed

设置参数值

Parameters

	$name
	$value

Returns

mixed

__get()

__get(  $name) : mixed

获取参数值

Parameters

$name

Returns

mixed

Initialize()

Initialize() : boolean

初始化$zbp.

Throws

\Exception

Returns

boolean

Load()

Load() : boolean

从数据库里读取信息，启动整个ZBP.

Throws

\Exception

Returns

boolean

LoadManage()

LoadManage()

载入管理.

Throws

\Exception

Terminate()

Terminate()

终止连接，释放资源.

OpenConnect()

OpenConnect() : boolean

连接数据库.

Throws

\Exception

Returns

boolean

ConvertTableAndDatainfo()

ConvertTableAndDatainfo()

对表名和数据结构进行预转换.

CloseConnect()

CloseConnect()

关闭数据库连接.

StartSession()

StartSession() : boolean

启用session.

Returns

boolean

EndSession()

EndSession() : boolean

终止session.

Returns

boolean

LoadConfigs()

LoadConfigs()

Load or ReLoad插件Configs表.

LoadConfigsOnlySystem()

LoadConfigsOnlySystem(  $onlysystemoption = true)

Parameters

$onlysystemoption

SaveConfig()

SaveConfig(string  $name) : boolean

保存Configs表.

Parameters

string

$name

Configs表名

Returns

boolean

DelConfig()

DelConfig(string  $name) : boolean

删除Configs表.

Parameters

string

$name

Configs表名

Returns

boolean

Config()

Config(string  $name) : mixed

获取Configs表值

Parameters

string

$name

Configs表名

Returns

mixed

HasConfig()

HasConfig(string  $name) : boolean

查某Config是否存在.

Parameters

string

CheckRights(string  $action, integer|string  $level = null) : boolean

验证操作权限.

Parameters

string	$action	操作
integer\|string	$level

Returns

boolean

CheckRightsByLevel()

CheckRightsByLevel(string  $action, integer  $level) : boolean

根据用户等级验证操作权限 1.5开始参数换顺序.

Parameters

string	$action	操作
integer	$level	用户等级

Returns

boolean

Verify()

Verify() : boolean

验证用户登录.

Returns

boolean

VerifyResult()

VerifyResult(\Member  $m) : string

返回登录成功后应保存的cookie信息.

Parameters

\Member

已验过成功的member

Returns

string

GenerateUserToken()

GenerateUserToken(\Member  $user, integer  $time) : string

生成User Token，用于登录验证

Parameters

\Member	$user
integer	$time

Returns

string

VerifyUserToken()

VerifyUserToken(string  $token, string  $username) : \Member

验证用户登录Token.

Parameters

string	$token
string	$username

Returns

\Member

Verify_MD5()

Verify_MD5(string  $name, string  $md5pw, \Member  $member) : boolean

验证用户登录（一次MD5密码）.

Parameters

string	$name	用户名
string	$md5pw	md5加密后的密码
\Member	$member	返回读取成功的member对象

Returns

boolean

Verify_Original()

Verify_Original(string  $name, string  $originalpw, \Member  $member = null) : boolean

验证用户登录（原始明文密码）.

Parameters

string	$name	用户名
string	$originalpw	密码明文
\Member	$member	返回读取成功的member对象

Returns

boolean

Verify_Final()

Verify_Final(string  $name, string  $password, object  $member = null) : boolean

验证用户登录（数据库保存的最终运算后密码）.

Parameters

string	$name	用户名
string	$password	二次加密后的密码
object	$member	返回读取成功的member对象

Returns

boolean

Verify_Token()

Verify_Token(string  $name, string  $wt, string  $wt_id, object  $member = null) : boolean

验证用户登录（使用Token，替代密码保存）.

Parameters

string	$name	用户名
string	$wt	WebToken
string	$wt_id	WebToken的ID识别符
object	$member	返回读取成功的member对象

Returns

boolean

LoadMembers()

LoadMembers(integer  $level) : boolean

载入用户列表.

Parameters

integer

LoadApp(string  $type, string  $id) : \App

载入指定应用.

Parameters

string	$type	应用类型(theme\|plugin)
string	$id	应用ID

Returns

\App

CheckPlugin()

CheckPlugin(string  $name) : boolean

检查应用是否安装并启用.

Parameters

string

$name

应用（插件或主题）的ID

Returns

boolean

CheckApp()

CheckApp(string  $name) : boolean

检查应用是否安装并启用.

Parameters

string

$name

应用ID（插件或主题）

Returns

boolean

GetPreActivePlugin()

GetPreActivePlugin() : array<mixed,string>

获取预激活插件名数组.

Returns

array<mixed,string>

LoadLanguage()

LoadLanguage(string  $type, string  $id, string  $default = '') : null

载入指定应用语言包.

Parameters

string	$type	应用类型(system\|theme\|plugin)
string	$id	应用ID
string	$default	默认语言

Throws

\Exception

Returns

null

ReflushLanguages()

ReflushLanguages()

ReloadLanguages()

ReloadLanguages()

重新读取语言包.

Throws

\Exception

PrepareTemplate()

PrepareTemplate(string  $theme = null) : \Template

创建模板对象，预加载已编译模板

Parameters

string

$theme

指定主题名

Returns

\Template

BuildTemplate()

BuildTemplate() : boolean

模板解析.

Returns

boolean

CheckTemplate()

CheckTemplate(boolean  $onlycheck = false, boolean  $forcebuild = false) : true

更新模板缓存.

Parameters

boolean	$onlycheck	为真的话，只判断是否需要而不Build
boolean	$forcebuild

Returns

true —

or false

BuildModule()

BuildModule()

生成所有进Ready List的模块的Content内容并保存.

RegBuildModule()

RegBuildModule(string  $moduleFileName, string  $moduleFunction)

重建模块.

Parameters

string	$moduleFileName	模块名
string	$moduleFunction	用户函数

RegBuildModules()

RegBuildModules()

系统默认注册模块.

AddBuildModule()

AddBuildModule(string  $moduleFileName, null  $parameters = null)

添加进入Build Ready列表的模块.

Parameters

string	$moduleFileName	模块名
null	$parameters	模块参数

DelBuildModule()

DelBuildModule(string  $moduleFileName)

删除进入Build Ready列表模块.

Parameters

string

$moduleFileName

模块名

GetListCustom()

GetListCustom(string|array  $table, array  $datainfo, string  $sql) : array

查询指定数据结构的sql并返回Base对象列表.

Parameters

string\|array	$table	数据表
array	$datainfo	数据字段
string	$sql	SQL操作语句

Returns

array

GetListCustomByArray()

GetListCustomByArray(string|array  $table, array  $datainfo, array  $array) : array<mixed,\Base>

查询ID数据的指定数据结构的sql并返回Base对象列表.

Parameters

string\|array	$table	数据表
array	$datainfo	数据字段
array	$array	ID数组

Returns

array<mixed,\Base>

GetListType()

GetListType(  $type,   $sql) : array<mixed,\Base>

已改名GetListType,1.5版中扔掉有歧义的GetList.

Parameters

	$type
	$sql

Returns

array<mixed,\Base>

GetListOrigin()

GetListOrigin(  $sql) : array<mixed,\Base>

GetListOrigin.

Parameters

$sql

Returns

array<mixed,\Base>

GetListTypeByArray()

GetListTypeByArray(string  $type, mixed  $array) : array<mixed,\Base>

查询ID数据的指定类型的sql并返回指定类型对象列表.

Parameters

string	$type	类型
mixed	$array	ID数组

Returns

array<mixed,\Base>

GetPostList()

GetPostList(mixed  $select = null, mixed  $where = null, mixed  $order = null, mixed  $limit = null, mixed  $option = null) : array<mixed,\Post>

Parameters

mixed	$select
mixed	$where
mixed	$order
mixed	$limit
mixed	$option

Returns

array<mixed,\Post>

GetPostByArray()

GetPostByArray(array<mixed,mixed>  $array) : array<mixed,\Post>|array<mixed,\Base>

通过ID数组获取文章实例.

Parameters

array<mixed,mixed>

$array

Returns

array<mixed,\Post>|array<mixed,\Base> —

Posts

GetArticleList()

GetArticleList(mixed  $select = null, mixed  $where = null, mixed  $order = null, mixed  $limit = null, mixed  $option = null, mixed  $readtags = true) : array<mixed,\Post>

Parameters

mixed	$select
mixed	$where
mixed	$order
mixed	$limit
mixed	$option
mixed	$readtags

Returns

array<mixed,\Post>

GetPageList()

GetPageList(mixed  $select = null, mixed  $where = null, mixed  $order = null, mixed  $limit = null, mixed  $option = null) : array<mixed,\Post>

Parameters

mixed	$select
mixed	$where
mixed	$order
mixed	$limit
mixed	$option

Returns

array<mixed,\Post>

GetCommentList()

GetCommentList(mixed  $select = null, mixed  $where = null, mixed  $order = null, mixed  $limit = null, mixed  $option = null) : array<mixed,\Comment>

Parameters

mixed	$select
mixed	$where
mixed	$order
mixed	$limit
mixed	$option

Returns

array<mixed,\Comment>

GetMemberList()

GetMemberList(mixed  $select = null, mixed  $where = null, mixed  $order = null, mixed  $limit = null, mixed  $option = null) : array<mixed,\Member>|array<mixed,\Base>

Parameters

mixed	$select
mixed	$where
mixed	$order
mixed	$limit
mixed	$option

Returns

array<mixed,\Member>|array<mixed,\Base>

GetTagList()

GetTagList(mixed  $select = null, mixed  $where = null, mixed  $order = null, mixed  $limit = null, mixed  $option = null) : array<mixed,\Tag>|array<mixed,\Base>

Parameters

mixed	$select
mixed	$where
mixed	$order
mixed	$limit
mixed	$option

Returns

array<mixed,\Tag>|array<mixed,\Base>

GetCategoryList()

GetCategoryList(mixed  $select = null, mixed  $where = null, mixed  $order = null, mixed  $limit = null, mixed  $option = null) : array<mixed,\Category>|array<mixed,\Base>

Parameters

mixed	$select
mixed	$where
mixed	$order
mixed	$limit
mixed	$option

Returns

array<mixed,\Category>|array<mixed,\Base>

GetModuleList()

GetModuleList(mixed  $select = null, mixed  $where = null, mixed  $order = null, mixed  $limit = null, mixed  $option = null) : array<mixed,\Module>|array<mixed,\Base>

Parameters

mixed	$select
mixed	$where
mixed	$order
mixed	$limit
mixed	$option

Returns

array<mixed,\Module>|array<mixed,\Base>

GetUploadList()

GetUploadList(mixed  $select = null, mixed  $where = null, mixed  $order = null, mixed  $limit = null, mixed  $option = null) : array<mixed,\Upload>|array<mixed,\Base>

Parameters

mixed	$select
mixed	$where
mixed	$order
mixed	$limit
mixed	$option

Returns

array<mixed,\Upload>|array<mixed,\Base>

get_results()

get_results(  $sql) : mixed

Parameters

$sql

Returns

mixed

GetSomeThing()

GetSomeThing(array<mixed,\Base>|string  $object, string  $attr, mixed  $val, string  $className = null) : \Base|null

获取数据通用函数.

Parameters

array<mixed,\Base>\|string	$object	缓存对象（string / object）
string	$attr	欲查找的属性
mixed	$val	要查找内容
string	$className	对象未找到时，初始化类名

Returns

\Base|null

GetPostByID()

GetPostByID(integer  $id) : \Post|\Base

通过ID获取文章实例.

Parameters

integer

$id

Returns

\Post|\Base

GetCategoryByID()

GetCategoryByID(integer  $id) : \Category|\Base

通过ID获取分类实例.

Parameters

integer

$id

Returns

\Category|\Base

GetCategoryByName()

GetCategoryByName(string  $name) : \Category|\Base

通过分类名获取分类实例.

Parameters

string

$name

Returns

\Category|\Base

GetCategoryByAlias()

GetCategoryByAlias(string  $name, null  $backKey = null) : \Category|\Base

通过分类别名获取分类实例.

Parameters

string	$name
null	$backKey

Returns

\Category|\Base

GetCategoryByAliasOrName()

GetCategoryByAliasOrName(string  $name) : \Category

与老版本保持兼容函数.

Parameters

string

$name

Returns

\Category

GetModuleByID()

GetModuleByID(integer  $id) : \Module|\Base

通过ID获取模块实例.

Parameters

integer

$id

Returns

\Module|\Base

GetModuleByFileName()

GetModuleByFileName(string  $fn) : \Module|\Base

通过FileName获取模块实例.

Parameters

string

$fn

Returns

\Module|\Base

GetMemberByID()

GetMemberByID(integer  $id) : \Member|\Base

通过ID获取用户实例.

Parameters

integer

$id

Returns

\Member|\Base

GetMemberByName()

GetMemberByName(string  $name) : \Member|\Base

通过用户名获取用户实例(不区分大小写).

Parameters

string

$name

Returns

\Member|\Base

GetMemberByNameOrAlias()

GetMemberByNameOrAlias(string  $name) : \Member|\Base

通过获取用户名或别名实例(不区分大小写).

Parameters

string

$name

Returns

\Member|\Base

GetMemberByEmail()

GetMemberByEmail(string  $email) : \Member

通过邮箱名获取用户实例(不区分大小写).

Parameters

string

$email

Returns

\Member

CheckMemberNameExist()

CheckMemberNameExist(  $name) : boolean

检查指定名称的用户是否存在(不区分大小写).

Parameters

$name

Returns

boolean

CheckMemberByNameOrAliasExist()

CheckMemberByNameOrAliasExist(  $name) : boolean

检查指定名称或别名的用户是否存在(不区分大小写).

Parameters

$name

Returns

boolean

CheckMemberByEmailExist()

CheckMemberByEmailExist(  $email) : boolean

检查指定邮箱的用户是否存在(不区分大小写).

Parameters

$email

Returns

boolean

GetCommentByID()

GetCommentByID(integer  $id) : \Comment|\Base

通过ID获取评论实例.

Parameters

integer

$id

Returns

\Comment|\Base

GetUploadByID()

GetUploadByID(integer  $id) : \Upload|\Base

通过ID获取附件实例.

Parameters

integer

$id

Returns

\Upload|\Base

GetTagByAlias()

GetTagByAlias(string  $name, null  $backKey = null) : \Tag|\Base

通过tag名获取tag实例.

Parameters

string	$name
null	$backKey

Returns

\Tag|\Base

GetTagByAliasOrName()

GetTagByAliasOrName(string  $name) : \Tag|\Base

通过tag名获取tag实例.

Parameters

string

$name

Returns

\Tag|\Base

GetTagByID()

GetTagByID(integer  $id) : \Tag|\Base

通过ID获取tag实例.

Parameters

integer

$id

Returns

\Tag|\Base

LoadTagsByIDString()

LoadTagsByIDString(  $s) : array

通过类似'{1}{2}{3}{4}'载入tags.

Parameters

Returns

array

LoadTagsByNameString()

LoadTagsByNameString(string  $s) : array

通过类似'aaa,bbb,ccc,ddd'载入tags.

Parameters

string

标签名字符串，如'aaa,bbb,ccc,ddd

Returns

array

ConvertTagIDtoString()

ConvertTagIDtoString(array  $array) : string

通过数组array[111,333,444,555,666]转换成存储串.

Parameters

array

$array

标签ID数组

Returns

string

GetTopArticle()

GetTopArticle(integer  $type) : array

获取全部置顶文章（优先从cache里读数组）.

Parameters

integer

$type

Returns

array

GetCmtKey()

GetCmtKey(  $id) : string

获取评论key.

Parameters

$id

Returns

string

ValidCmtKey()

ValidCmtKey(  $id,   $key) : boolean

验证评论key.

Parameters

	$id
	$key

Returns

boolean

GetCSRFToken()

GetCSRFToken(string  $id = '') : string

获取CSRF Token.

Parameters

string

$id

应用ID，可以保证每个应用获取不同的Token

Returns

string

VerifyCSRFToken()

VerifyCSRFToken(string  $token, string  $id = '') : boolean

验证CSRF Token.

Parameters

string	$token
string	$id	应用ID，可为每个应用生成一个专属token

Returns

boolean

ShowValidCode()

ShowValidCode(string  $id = '') : boolean

显示验证码

Parameters

string

$id

命名事件

Returns

boolean

Inherited from: \ZBlogPHP

Tags

api	Filter_Plugin_Zbp_ShowValidCode 如该接口未被挂载则显示默认验证图片

CheckValidCode()

CheckValidCode(string  $verifyCode, string  $id = '') : boolean

比对验证码

Parameters

string	$verifyCode	验证码数值
string	$id	命名事件

Returns

boolean

Inherited from: \ZBlogPHP

Tags

api	Filter_Plugin_Zbp_CheckValidCode 如该接口未被挂载则比对默认验证码

AddItemToNavbar()

AddItemToNavbar(string  $type, string  $id, string  $name, string  $url)

向导航菜单添加相应条目.

Parameters

string	$type	$type=category,tag,page,item
string	$id
string	$name
string	$url

DelItemToNavbar()

DelItemToNavbar(string  $type,   $id)

删除导航菜单中相应条目.

Parameters

string	$type
	$id

CheckItemToNavbar()

CheckItemToNavbar(string  $type,   $id) : boolean

检查条目是否在导航菜单中.

Parameters

string	$type
	$id

Returns

boolean

SetHint()

SetHint(string  $signal, string  $content = '')

设置提示消息并存入Cookie.

Parameters

string	$signal	提示类型（good\|bad\|tips）
string	$content	提示内容

GetHint()

GetHint()

提取Cookie中的提示消息.

ShowHint()

ShowHint(string  $signal, string  $content = '')

由提示消息获取HTML.

Parameters

string	$signal	提示类型（good\|bad\|tips）
string	$content	提示内容

ShowError()

ShowError(\string/int  $errorText, null  $file = null, null  $line = null) : mixed

显示错误信息.

Parameters

\string/int	$errorText
null	$file
null	$line

Throws

\Exception

Returns

mixed

Inherited from: \ZBlogPHP

Tags

api	Filter_Plugin_Zbp_ShowError

CheckGzip()

CheckGzip()

检查并开启Gzip压缩.

StartGzip()

StartGzip()

启用Gzip.

CheckSiteClosed()

CheckSiteClosed()

检测网站关闭，如果关闭，则抛出错误.

Throws

\Exception

RedirectInstall()

RedirectInstall()

跳转到安装页面.

RedirectPermanentDomain()

RedirectPermanentDomain()

检测当前url，如果不符合设置就跳转到固定域名的链接.

RegPostType()

RegPostType(  $typeId,   $name, string  $urlRule = '', string  $template = 'single', string  $categoryType = null, string  $tagType = null)

注册PostType.

Parameters

	$typeId
	$name
string	$urlRule	默认是取Page类型的Url Rule
string	$template	默认模板名page
string	$categoryType	当前文章类的分类Type
string	$tagType	当前文章类的标签Type

Throws

\Exception

GetPostType_Name()

GetPostType_Name(  $typeid) : string

RegAction()

RegAction(  $name,   $level,   $title)

注册Action.

Parameters

	$name
	$level
	$title

GetActionDescription()

GetActionDescription(  $name) : mixed

获得Action权限注释.

Parameters

$name

Returns

mixed

SetExclusive()

SetExclusive(  $function,   $appid)

通知系统控制权

Parameters

	$function
	$appid

IsExclusive()

IsExclusive(  $function)

查询系统控制权

Parameters

$function

Verify_MD5Path()

Verify_MD5Path(string  $name, string  $ps_path_hash, object  $member = null) : boolean

验证用户登录（MD5加zbp->guid盐后的密码）.

Parameters

string	$name	用户名
string	$ps_path_hash	MD5加zbp->guid盐后的密码
object	$member	返回读取成功的member对象

Returns

boolean

GetToken()

GetToken(string  $id = '') : string

获取CSRF Token的错误别名.

Parameters

string

$id

应用ID，可以保证每个应用获取不同的Token

Returns

string

ValidToken()

ValidToken(  $t,   $id = '') : boolean

验证CSRF Token的错误别名.

Parameters

	$t
	$id

Returns

boolean

LoadCategorys()

LoadCategorys() : boolean

Returns

boolean

GetWebToken()

GetWebToken(string  $wt_id = '', integer  $day = 1) : string

获取会话WebToken.

Parameters

string	$wt_id
integer	$day	默认1天有效期，1小时为1/24，1分钟为1/(24*60)

Returns

string

ValidWebToken()

ValidWebToken(  $wt,   $wt_id = '') : boolean

验证会话WebToken.

Parameters

	$wt
	$wt_id

Returns

boolean

GetSomeThingByAlias()

GetSomeThingByAlias(  $object, string  $val, string  $backAttr = null, string  $className = null) : \Base|null

根据别名得到相应数据.

Parameters

	$object
string	$val
string	$backAttr
string	$className

Returns

\Base|null

GetSomeThingById()

GetSomeThingById(  $object, string  $className, integer|string  $id) : \Base|null

根据ID得到相应数据.

Parameters

	$object
string	$className	找不到ID时初始化对象的类名
integer\|string	$id	与此类相关的ID

Returns

\Base|null

GetSomeThingByAttr()

GetSomeThingByAttr(  $object, string  $attr, mixed  $val) : null

根据属性值得到相应数据.

Parameters

	$object
string	$attr	属性名
mixed	$val	要查找的值

Returns

null