phpcms插件开发初步规范

phpcms公用库函数原型

（一）./include/global.php 中的函数可在phpcms的任何一个程序中调用，下面是各函数的原型及用法。

message($alert,$goback='') --  显示js消息对话框形式的提示信息

无返回值，$alert为提示信息内容，$goback参数是用户确认后跳转的url地址（此参数可选，默认为空即不进行跳转，如果该参数的值为“goback”，则用户确认后浏览器自动跳转到前一个打开的地址，如果该参数的值为“close”，则用户确认后浏览器自动关闭当前窗口。

createdir($dir='') --  创建目录

无返回值，$dir参数必须是一个目录地址，默认为空不创建目录。目录地址可以是多层次的目录，该函数会逐层目录地检查该目录是否创建，如果已经创建则继续检查下级目录，如果没有创建则自动创建目录。目录属性默认为 0777

file_write($filename,$content) --  创建一个文件并写入内容

无返回值，$filename为要创建的文件名，$content为要写入该文件的内容。

dhtmlspecialchars($string) --  把特殊字符转换为html实体

返回字符串或者数组，$string参数可以是一个字符串，也可以是一个数组。

daddslashes($string) -- 使用反斜线引用字符串

返回字符串或者数组，该字符串为了数据库查询语句等的需要在某些字符前加上了反斜线。这些字符是单引号（'）、双引号（"）、反斜线（）与 nul（null 字符）。

random($length,$chars='0123456789') -- 生成随机字符串

返回字符串，$length为返回的字符串长度，$chars为字符串的组成字符，默认为数字即'0123456789'。

language($file,$language) -- 获取语言包文件的路径

返回字符串，$file为文件名（不带后缀.php），$language为语言包目录（比如“chinese-gb2312”）。

template($file,$admin=0) -- 获取模板文件路径

返回字符串，$file为文件名（不带后缀.htm），$admin参数为可选值，默认值为0，即表示调用前台模板文件，如果$admin=1，则表示调用后台模板文件。

html($file) -- 调用 ./include/html/ 目录下的文件并执行

无返回值，$file参数为不带后缀.php的文件名，该文件应该是存在于 ./include/html/ 目录下的，调用此函数后该文件将被执行，通常情况下次函数用在生成html的程序中

articlepage($pagenumber=1,$page=0,$path='') -- 一篇文章分页

返回字符串，$pagenumber为文章总页数默认为1，$page为当前页数默认为0，$path为文章路径。此函数返回一篇文章的分页连接。

showpage($totle,$perpage=30,$page=1,$url='?') -- 文章分页

返回字符串，$totle 为总记录数，$perpage为每页显示的记录条数（默认为30），$page为当前页码（默认为1），$url为分页链接的基准地址（默认为“?”），此函数将返回文章分页的链接。

wordscut($string, $length ,$sss=0) -- 字符串截断

返回字符串，$string为需要截断的字符串，$length为截断后的最大长度，$sss为设置是否显示“...”的开关，当值为1时显示“...”，默认为不显示。

str_out($string) -- 处理要输出的字符串

返回字符串或者数组，$string为要处理的字符串或者数组，该函数会还原经addslashes处理过的字符串，把html实体化，把textarea中的换行变成“<br>”，把空格变成“&nbsp;”。

str_in($string) -- 处理插入到数据库的字符串

返回字符串或者数组，$string为要处理的字符串或者数组，该函数会对目标字符串或者数组进行addslashes处理。

chartype($pattern,$string) -- 对字符串或者数组进行正则检查

返回字符串或者数组，$string为要处理的字符串或者数组，$pattern为perl格式的正则表达式，值得一提的是该函数可对数组进行正则检查。

file_ext($name,$exts) -- 检查文件扩展名

返回文件扩展名或者false，$name参数为要检查的文件名，$exts为需要判断的文件名后缀，多个后缀用“|”隔开，如果$name的后缀是$exts中的一个则函数返回该后缀名，如果不是则返回false。此函数一般用在对上传文件后缀判断中。

menu($parentid=0) -- 获取子栏目信息

返回一个数组，$parentid为子栏目的上级栏目的catid，如果$menu=menu($parentid=0)，那么$menu[url]为栏目链接地址，$menu[catname]为栏目名称，$menu[description]为栏目描述，$menu[target]为栏目打开的目标窗口。

（二）./admin/global.php 中的函数可在phpcms后台的任何一个程序中调用，下面是各函数的原型及用法。

showmessage($msg, $url_forward = '', $msgtype = 'message') -- 显示提示信息

无返回值，$msg为提示信息内容，$url_forward 为跳转的url地址，$msgtype 为显示形式，有“message”和“form”可供选择

dir_writeable($dir) -- 判断目录是否可写

返回true或者false，$dir为要检查的目录

copydir($source,$destination,$child=1) -- 拷贝目录

无返回值，$source为要拷贝的源目录路径，$destination为目标目录路径，当$child为1时此函数将自动拷贝$source目录下所有子目录和文件至$destination目录（如果$destination目录不存在则自动创建），当$child为0时此函数将自动拷贝$source目录下所有文件至$destination目录（如果$destination目录不存在则自动创建）。

deletedir($dirname) -- 删除目录

无返回值，自动删除$dirname目录下所有的子目录和文件

sizecount($filesize) -- 空间大小换算

返回浮点型数字，自动把$filesize从bytes单位换算成k、m、g的单位

listpages($totle,$perpage=30,$page=1,$path='') -- 文章分页

listpages($totle,$perpage=30,$page=1,$path='')类似于showpage($totle,$perpage=30,$page=1,$url='?')，但是showpage($totle,$perpage=30,$page=1,$url='?')适用于htm网页分页，而listpages($totle,$perpage=30,$page=1,$path='')则适用于php网页分页

checkadmin($msg,$referer='') -- 权限检查

无返回值，$msg为提示信息内容，$referer为跳转url。此函数自动检查当前用户是否为管理员以及是否具有当前操作权限，如果没有则显示$msg信息并跳转至$referer