Z-Blog Wiki Z-Blog Wiki

Z-Blog官方文档

用户工具

站点工具


zblogphp:development:functions:event

c_system_event里全部的函数,提供事件处理的函数

   

VerifyLogin()

说明

验证登录.

参数与返回值

param (boolean) $throwException:

return (boolean)

/**
* 验证登录.
*
* @param boolean $throwException
* @return boolean *
*/
}
function VerifyLogin($throwException)
   

SetLoginCookie()

说明

设置登录Cookie,直接登录该用户.

参数与返回值

param (\Member) $user:

param (integer) $cookieTime:

return (boolean)

/**
* 设置登录Cookie,直接登录该用户.
*
* @param \Member $user
* @param integer $cookieTime
* @return boolean *
*/
}
function SetLoginCookie($user,$cookieTime)
   

Logout()

说明

注销登录.

参数与返回值

/**
* 注销登录.
*
*
*/
}
function Logout()
   

GetPost()

说明

获取文章.

参数与返回值

param (mixed) $idorname: 文章id 或 名称、别名

param (array) $option: |null

return (\Post)

/**
* 获取文章.
*
* @param mixed $idorname
* @param array $option
* @return \Post *
*/
}
function GetPost($idorname,$option)
   

GetList()

说明

获取文章列表.

参数与返回值

param (integer) $count: 数量

param (null) $cate: 分类ID

param (null) $auth: 用户ID

param (null) $date: 日期

param (null) $tags: 标签

param (null) $search: 搜索关键词

param (null) $option:

return (array|mixed)

/**
* 获取文章列表.
*
* @param integer $count
* @param null $cate
* @param null $auth
* @param null $date
* @param null $tags
* @param null $search
* @param null $option
* @return array *
*/
}
function GetList($count,$cate,$auth,$date,$tags,$search,$option)
   

ViewIndex()

说明

ViewIndex,首页,搜索页,feed页的主函数.

参数与返回值

return (mixed)

/**
* ViewIndex,首页,搜索页,feed页的主函数.
*
* @return mixed *
*/
}
function ViewIndex()
   

ViewFeed()

说明

显示RSS2Feed.

参数与返回值

/**
* 显示RSS2Feed.
*
*
*/
}
function ViewFeed()
   

ViewSearch()

说明

展示搜索结果.

参数与返回值

return (mixed)

/**
* 展示搜索结果.
*
* @return mixed *
*/
}
function ViewSearch()
   

ViewAuto()

说明

根据Rewrite_url规则显示页面.

参数与返回值

param (string) $inpurl: 页面url

return (null|string)

/**
* 根据Rewrite_url规则显示页面.
*
* @param string $inpurl
* @return null *
*/
}
function ViewAuto($inpurl)
   

ViewList()

说明

显示列表页面.

参数与返回值

param (integer) $page:

param (mixed) $cate:

param (mixed) $auth:

param (mixed) $date:

param (mixed) $tags: tags列表

param (boolean) $isrewrite: 是否启用urlrewrite

return (string)

/**
* 显示列表页面.
*
* @param integer $page
* @param mixed $cate
* @param mixed $auth
* @param mixed $date
* @param mixed $tags
* @param boolean $isrewrite
* @return string *
*/
}
function ViewList($page,$cate,$auth,$date,$tags,$isrewrite)
   

ViewPost()

说明

显示文章.

参数与返回值

param (array|integer|string) $object: 文章ID/ ID/别名对象

param (string) $theSecondParam: (如果有的话)文章别名

param (boolean) $enableRewrite: 是否启用urlrewrite

return (string)

/**
* 显示文章.
*
* @param array|integer|string $object
* @param string $theSecondParam
* @param boolean $enableRewrite
* @return string *
*/
}
function ViewPost($object,$theSecondParam,$enableRewrite)
   

ViewComments()

说明

显示文章下评论列表.

参数与返回值

param (integer) $postid: 文章ID

param (integer) $page: 页数

return (boolean)

/**
* 显示文章下评论列表.
*
* @param integer $postid
* @param integer $page
* @return boolean *
*/
}
function ViewComments($postid,$page)
   

ViewComment()

说明

显示评论.

参数与返回值

param (integer) $id: 评论ID

return (boolean)

/**
* 显示评论.
*
* @param integer $id
* @return boolean *
*/
}
function ViewComment($id)
   

PostArticle()

说明

提交文章数据.

参数与返回值

return (boolean)

/**
* 提交文章数据.
*
* @return boolean *
*/
}
function PostArticle()
   

DelArticle()

说明

删除文章.

参数与返回值

return (boolean)

/**
* 删除文章.
*
* @return boolean *
*/
}
function DelArticle()
   

PostArticle_CheckTagAndConvertIDtoString()

说明

提交文章数据时检查tag数据,并将新tags转为标准格式返回.

参数与返回值

param (string) $tagnamestring: 提交的文章tag数据,可以:,,、等符号分隔

return (string)

/**
* 提交文章数据时检查tag数据,并将新tags转为标准格式返回.
*
* @param string $tagnamestring
* @return string *
*/
}
function PostArticle_CheckTagAndConvertIDtoString($tagnamestring)
   

DelArticle_Comments()

说明

删除文章下所有评论.

参数与返回值

param (integer) $id: 文章ID

/**
* 删除文章下所有评论.
*
* @param integer $id
*
*/
}
function DelArticle_Comments($id)
   

PostPage()

说明

提交页面数据.

参数与返回值

return (boolean)

/**
* 提交页面数据.
*
* @return boolean *
*/
}
function PostPage()
   

DelPage()

说明

删除页面.

参数与返回值

return (boolean)

/**
* 删除页面.
*
* @return boolean *
*/
}
function DelPage()
   

PostComment()

说明

提交评论.

参数与返回值

return (boolean)

/**
* 提交评论.
*
* @return boolean *
*/
}
function PostComment()
   

DelComment()

说明

删除评论.

参数与返回值

return (boolean)

/**
* 删除评论.
*
* @return boolean *
*/
}
function DelComment()
   

DelComment_Children()

说明

删除评论下的子评论.

参数与返回值

param (integer) $id: 父评论ID

/**
* 删除评论下的子评论.
*
* @param integer $id
*
*/
}
function DelComment_Children($id)
   

GetSubComments()

说明

只历遍并保留评论id进array,不进行删除.

参数与返回值

param (integer) $id: 父评论ID

param (array) $array: 将子评论ID存入新数组

/**
* 只历遍并保留评论id进array,不进行删除.
*
* @param integer $id
* @param array $array
*
*/
}
function GetSubComments($id,$array)
   

CheckComment()

说明

检查评论数据并保存、更新计数、更新“最新评论”模块.

参数与返回值

/**
* 检查评论数据并保存、更新计数、更新“最新评论”模块.
*
*
*/
}
function CheckComment()
   

BatchComment()

说明

评论批量处理(删除、通过审核、加入审核).

参数与返回值

/**
* 评论批量处理(删除、通过审核、加入审核).
*
*
*/
}
function BatchComment()
   

PostCategory()

说明

提交分类数据.

参数与返回值

return (boolean)

/**
* 提交分类数据.
*
* @return boolean *
*/
}
function PostCategory()
   

DelCategory()

说明

删除分类.

参数与返回值

return (boolean)

/**
* 删除分类.
*
* @return boolean *
*/
}
function DelCategory()
   

DelCategory_Articles()

说明

删除分类下所有文章.

参数与返回值

param (integer) $id: 分类ID

/**
* 删除分类下所有文章.
*
* @param integer $id
*
*/
}
function DelCategory_Articles($id)
   

PostTag()

说明

提交标签数据.

参数与返回值

return (boolean)

/**
* 提交标签数据.
*
* @return boolean *
*/
}
function PostTag()
   

DelTag()

说明

删除标签.

参数与返回值

return (boolean)

/**
* 删除标签.
*
* @return boolean *
*/
}
function DelTag()
   

PostMember()

说明

提交用户数据.

参数与返回值

return (boolean)

/**
* 提交用户数据.
*
* @return boolean *
*/
}
function PostMember()
   

DelMember()

说明

删除用户.

参数与返回值

return (boolean)

/**
* 删除用户.
*
* @return boolean *
*/
}
function DelMember()
   

DelMember_AllData()

说明

删除用户下所有数据(包括文章、评论、附件).

参数与返回值

param (integer) $id: 用户ID

/**
* 删除用户下所有数据(包括文章、评论、附件).
*
* @param integer $id
*
*/
}
function DelMember_AllData($id)
   

PostModule()

说明

提交模块数据.

参数与返回值

return (boolean)

/**
* 提交模块数据.
*
* @return boolean *
*/
}
function PostModule()
   

DelModule()

说明

删除模块.

参数与返回值

return (boolean)

/**
* 删除模块.
*
* @return boolean *
*/
}
function DelModule()
   

PostUpload()

说明

附件上传.

参数与返回值

/**
* 附件上传.
*
*
*/
}
function PostUpload()
   

DelUpload()

说明

删除附件.

参数与返回值

return (boolean)

/**
* 删除附件.
*
* @return boolean *
*/
}
function DelUpload()
   

EnablePlugin()

说明

启用插件.

参数与返回值

param (string) $name: 插件ID

return (string)

/**
* 启用插件.
*
* @param string $name
* @return string *
*/
}
function EnablePlugin($name)
   

DisablePlugin()

说明

禁用插件.

参数与返回值

param (string) $name: 插件ID

return (\App|boolean)

/**
* 禁用插件.
*
* @param string $name
* @return \App *
*/
}
function DisablePlugin($name)
   

SetTheme()

说明

设置当前主题样式.

参数与返回值

param (string) $theme: 主题ID

param (string) $style: 样式名

return (string)

/**
* 设置当前主题样式.
*
* @param string $theme
* @param string $style
* @return string *
*/
}
function SetTheme($theme,$style)
   

SetSidebar()

说明

设置侧栏.

参数与返回值

/**
* 设置侧栏.
*
*
*/
}
function SetSidebar()
   

SaveSetting()

说明

保存网站设置选项.

参数与返回值

/**
* 保存网站设置选项.
*
*
*/
}
function SaveSetting()
   

BatchPost()

说明

批量删除Post.

参数与返回值

param () $type:

/**
* 批量删除Post.
*
* @param $type
*
*/
}
function BatchPost($type)
   

Include_ShowError404()

说明

显示404页面(内置插件函数).

参数与返回值

param () $errorCode:

param () $errorDescription:

param () $file:

param () $line:

/**
* 显示404页面(内置插件函数).
*
* @param $errorCode
* @param $errorDescription
* @param $file
* @param $line
*
*/
}
function Include_ShowError404($errorCode,$errorDescription,$file,$line)
   

Include_AddonAdminFont()

说明

输出后台指定字体family(内置插件函数).

参数与返回值

/**
* 输出后台指定字体family(内置插件函数).
*
*
*/
}
function Include_AddonAdminFont()
   

Include_BatchPost_Article()

说明

批处理文章

参数与返回值

param (integer) $type:

/**
* 批处理文章
*
* @param integer $type
*
*/
}
function Include_BatchPost_Article($type)
   

Include_BatchPost_Page()

说明

批处理页面

参数与返回值

param (integer) $type:

/**
* 批处理页面
*
* @param integer $type
*
*/
}
function Include_BatchPost_Page($type)
   

Include_Index_End()

说明

首页index.php的结尾处理

参数与返回值

/**
* 首页index.php的结尾处理
*
*
*/
}
function Include_Index_End()
   

Include_Index_Begin()

说明

首页index.php的开头处理

参数与返回值

/**
* 首页index.php的开头处理
*
*
*/
}
function Include_Index_Begin()
   

FilterMeta()

说明

过滤扩展数据.

参数与返回值

param () $object:

/**
* 过滤扩展数据.
*
* @param $object
*
*/
}
function FilterMeta($object)
   

FilterComment()

说明

过滤评论数据.

参数与返回值

param () $comment:

/**
* 过滤评论数据.
*
* @param $comment
*
*/
}
function FilterComment($comment)
   

FilterPost()

说明

过滤文章数据.

参数与返回值

param () $article:

/**
* 过滤文章数据.
*
* @param $article
*
*/
}
function FilterPost($article)
   

FilterMember()

说明

过滤用户数据.

参数与返回值

param () $member:

/**
* 过滤用户数据.
*
* @param $member
*
*/
}
function FilterMember($member)
   

FilterModule()

说明

过滤模块数据.

参数与返回值

param () $module:

/**
* 过滤模块数据.
*
* @param $module
*
*/
}
function FilterModule($module)
   

FilterCategory()

说明

过滤分类数据.

参数与返回值

param () $category:

/**
* 过滤分类数据.
*
* @param $category
*
*/
}
function FilterCategory($category)
   

FilterTag()

说明

过滤tag数据.

参数与返回值

param () $tag:

/**
* 过滤tag数据.
*
* @param $tag
*
*/
}
function FilterTag($tag)
   

CountTopPost()

说明

统计置顶文章数组.

参数与返回值

param (integer) $type:

param (null) $addplus:

param (null) $delplus:

/**
* 统计置顶文章数组.
*
* @param integer $type
* @param null $addplus
* @param null $delplus
*
*/
}
function CountTopPost($type,$addplus,$delplus)
   

CountCommentNums()

说明

统计评论数.

参数与返回值

param (integer) $allplus: 控制是否要进行全表扫描 总评论

param (integer) $chkplus: 控制是否要进行全表扫描 未审核评论

/**
* 统计评论数.
*
* @param integer $allplus
* @param integer $chkplus
*
*/
}
function CountCommentNums($allplus,$chkplus)
   

CountNormalArticleNums()

说明

统计公开文章数.

参数与返回值

param (integer) $plus: 控制是否要进行全表扫描

/**
* 统计公开文章数.
*
* @param integer $plus
*
*/
}
function CountNormalArticleNums($plus)
   

CountPost()

说明

统计文章下评论数.

参数与返回值

param (\post) $article:

param (integer) $plus: 控制是否要进行全表扫描

/**
* 统计文章下评论数.
*
* @param \post $article
* @param integer $plus
*
*/
}
function CountPost($article,$plus)
   

CountPostArray()

说明

批量统计指定文章下评论数并保存.

参数与返回值

param (array) $array: 记录文章ID的数组

param (integer) $plus: 控制是否要进行全表扫描

/**
* 批量统计指定文章下评论数并保存.
*
* @param array $array
* @param integer $plus
*
*/
}
function CountPostArray($array,$plus)
   

CountCategory()

说明

统计分类下文章数.

参数与返回值

param (\Category) $category: &$category

param (integer) $plus: 控制是否要进行全表扫描

/**
* 统计分类下文章数.
*
* @param \Category $category
* @param integer $plus
*
*/
}
function CountCategory($category,$plus)
   

CountCategoryArray()

说明

批量统计指定分类下文章数并保存.

参数与返回值

param (array) $array: 记录分类ID的数组

param (integer) $plus: 控制是否要进行全表扫描

/**
* 批量统计指定分类下文章数并保存.
*
* @param array $array
* @param integer $plus
*
*/
}
function CountCategoryArray($array,$plus)
   

CountTag()

说明

统计tag下的文章数.

参数与返回值

param (\tag) $tag: &$tag

param (integer) $plus: 控制是否要进行全表扫描

/**
* 统计tag下的文章数.
*
* @param \tag $tag
* @param integer $plus
*
*/
}
function CountTag($tag,$plus)
   

CountTagArrayString()

说明

批量统计指定tag下文章数并保存.

参数与返回值

param (string) $string: 类似'{1}{2}{3}{4}{4}'的tagID串

param (integer) $plus: 控制是否要进行全表扫描

param (integer) $articleid: 暂没发现有用处的参数

return (boolean)

/**
* 批量统计指定tag下文章数并保存.
*
* @param string $string
* @param integer $plus
* @param integer $articleid
* @return boolean *
*/
}
function CountTagArrayString($string,$plus,$articleid)
   

CountMember()

说明

统计用户下的文章数、页面数、评论数、附件数等.

参数与返回值

param () $member:

param (array) $plus: 设置是否需要完全全表扫描

/**
* 统计用户下的文章数、页面数、评论数、附件数等.
*
* @param $member
* @param array $plus
*
*/
}
function CountMember($member,$plus)
   

CountMemberArray()

说明

批量统计指定用户数据并保存.

参数与返回值

param (array) $array: 记录用户ID的数组

param (array) $plus: 设置是否需要完全全表扫描

/**
* 批量统计指定用户数据并保存.
*
* @param array $array
* @param array $plus
*
*/
}
function CountMemberArray($array,$plus)
   

BuildModule_catalog()

说明

BuildModule_catalog

参数与返回值

return (string)

/**
* BuildModule_catalog
*
* @return string *
*/
}
function BuildModule_catalog()
   

BuildModule_calendar()

说明

BuildModule_calendar

参数与返回值

param (string) $date:

return (string)

/**
* BuildModule_calendar
*
* @param string $date
* @return string *
*/
}
function BuildModule_calendar($date)
   

BuildModule_comments()

说明

BuildModule_comments

参数与返回值

return (string)

/**
* BuildModule_comments
*
* @return string *
*/
}
function BuildModule_comments()
   

BuildModule_previous()

说明

BuildModule_previous

参数与返回值

return (string)

/**
* BuildModule_previous
*
* @return string *
*/
}
function BuildModule_previous()
   

BuildModule_archives()

说明

BuildModule_archives

参数与返回值

return (string)

/**
* BuildModule_archives
*
* @return string *
*/
}
function BuildModule_archives()
   

BuildModule_navbar()

说明

BuildModule_navbar

参数与返回值

return (string)

/**
* BuildModule_navbar
*
* @return string *
*/
}
function BuildModule_navbar()
   

BuildModule_tags()

说明

BuildModule_tags

参数与返回值

return (string)

/**
* BuildModule_tags
*
* @return string *
*/
}
function BuildModule_tags()
   

BuildModule_authors()

说明

BuildModule_authors

参数与返回值

param (integer) $level:

return (string)

/**
* BuildModule_authors
*
* @param integer $level
* @return string *
*/
}
function BuildModule_authors($level)
   

BuildModule_statistics()

说明

BuildModule_statistics

参数与返回值

param (array) $array:

return (string)

/**
* BuildModule_statistics
*
* @param array $array
* @return string *
*/
}
function BuildModule_statistics($array)
   

zblogphp/development/functions/event.txt · 最后更改: 2020/05/24 23:48 由 zx.asd