PHPCMS2008常用函数

sendmail：发送E-mail 函数原型：sendmail($mail_to, $mail_subject, $mail_body, $mail_from = '')
参数：$mail_to，收信人E-mail；$mail_subject，邮件主题；$mail_body，邮件内容；$mail_from，发信人E-mail
返回值：发送成功则返回 true，否则返回 false
用途：发送E-mail。会员注册、邮件验证、找回密码、续费通知、消费通知等经常要用到此功能。
定义位置：./include/mail.inc.php

random：产生随机字符 函数原型：random($length, $chars = '0123456789')
参数：$length，int，指定产生的随机字符长度；$chars，字符串，指定随机字符的组成元素，默认由数字组成
返回值：字符串
用途：产生随机字符。比如用来产生随机验证字符串、验证码等
定义位置：./include/global.func.php，默认被加载


sql_execute：批量执行SQL语句 函数原型：sql_execute($sql)
参数：$sql，string，SQL语句，多条SQL语句用分号隔开并且换行，# 和 - 开头的行为注释将被忽略
返回值：总是返回 TRUE
用途：批量执行SQL语句。数据库恢复时就是通过此函数执行SQL文件里的语句
定义位置：./admin/include/global.func.php


strip_textarea：格式化输出多行文本框提交的值 函数原型：strip_textarea($string)
参数：$string ，字符串
返回值：字符串
用途：格式化输出多行文本框提交的值。多行文本提交的数据如果直接显示到网页不能换行和空格，必须经过此函数处理才能保持换行和空格格式。
定义位置：./include/global.func.php，默认被加载

ubb：把UBB代码解析为合法的html代码 函数原型：ubb($string)
参数：$string，被解析字符串；
返回值：解析后的字符串
用途：此函数用来解析字符串中的UBB代码为合法的html代码。在导入论坛数据时需要通过此函数解析UBB代码为html代码
定义位置：./include/ubb.func.php
 
str_cut：截取字符串 函数原型：str_cut($string, $length, $dot = ' ...')
参数：$string，字符串，被截取的字符串；$length，int，截取长度；$dot，字符串，截取后字符串结尾字符
返回值：截取后的字符串
用途：用来截取指定长度的字符串。有时候文章标题过长会换行导致页面难看，可以通过此函数截取指定长度避免问题
定义位置：./include/global.func.php，默认被加载


numberval：格式化数字 函数原型：numberval($number, $precision = 2)
参数：$number，数字或数字组成的字符串；$precision，int，小数点后保留的位数
返回值：float 型数字
用途：把一个数字或者数字组成的字符串格式化输出。例如：numberval(1.333, 2) 的值为 1.33
定义位置：./include/global.func.php，默认被加载


get_remotefiles：获取内容中远程文件到本地 函数原型：get_remotefiles($string,$ext='gif|jpg|jpeg|bmp|png',$absurl='',$basehref='',$down=true,$uploaddir="uploadfile")
参数：$string，内容文本；$ext，获取的文件扩展名；$absurl，原网页绝对地址；$basehref，原网页base href地址；$down，true 或 false，是否保存远程文件；$uploaddir，附件目录
返回值：远程文件被处理后的内容html代码
用途：获取内容中远程文件并把相对地址替换为绝对地址。此函数常用于发布转载文章时获取文章内容中的远程图片或者获取采集内容中的图片和flash等
定义位置：./include/get_remotefiles.func.php



getcookie：获取Cookie值 函数原型：getcookie($var)
参数：$var ，字符串，Cookie 变量名
返回值：Cookie存在则返回其字符串值，不存在则返回 FALSE
用途：获取Cookie值
定义位置：./include/global.func.php，默认被加载
 file_put_contents：将一个字符串写入文件 函数原型：file_put_contents($file, $string, $append = '')
参数：$file，字符串，要被写入数据的文件名；$string，字符串，要写入的数据；$append，为 FILE_APPEND 表示追加模式（ab），为空表示写入模式（wb）
返回值：该函数将返回写入到文件内数据的字节数。
用途：将一个字符串写入文件。写入字符串到文件的快速方法，此函数是为PHP4构造的，PHP5以上就是内置函数了
定义位置：./include/global.func.php，默认被加载
 
bytes2x：把字节数转换为合适的单位 函数原型：bytes2x($size)
参数：$size，int，字节数
返回值：换算成合适单位后的大小
用途：把字节数转换为合适的单位。大小单位包括 B、KB、MB、GB、TB
定义位置：./admin/include/global.func.php


imgurl：图片地址处理函数 函数原型：imgurl($imgurl = '', $isabs = 0)
参数：$imgurl，字符串，图片地址；$isabs，0  或 1，值为1则表示返回绝对URL地址，否则返回相对域名的URL地址
返回值：返回处理后的图片地址
用途：
URL处理。通常情况下数据库中保存的网页和图片URL是相对的，为了链接不发生错误，我们需要通过此函数把URL处理为相对域名的URL或者绝对URL。假如phpcms安装在http://localhost/phpcms/ ，
标题图片URL为 article/thumb/x.jpg ，那么经过 linkurl('article/thumb/x.jpg') 处理URL则变为 /phpcms/article/thumb/x.jpg 。
与 linkurl 不同的是，当 $imgurl 为空时，系统会返回一个默认图片URL
定义位置：./include/global.func.php，默认被加载

linkurl：URL处理函数 函数原型：linkurl($linkurl, $isabs = 0)
参数：$linkurl，字符串，待处理的URL；$isabs，0 或 1，值为1则表示返回绝对URL地址，否则返回相对域名的URL地址
返回值：返回处理后的URL
用途：URL处理。通常情况下数据库中保存的网页和图片URL是相对的，为了链接不发生错误，我们需要通过此函数把URL处理为相对域名的URL或者绝对URL。
假如phpcms安装在 http://localhost/phpcms/ ，标题图片URL为 article/thumb/x.jpg ，那么经过 linkurl('article/thumb/x.jpg') 处理URL则变为 /phpcms/article/thumb/x.jpg
定义位置：./include/global.func.php，默认被加载


mkcookie：创建或删除Cookie 函数原型：mkcookie($var, $value = '', $time = 0)
参数：$var ，字符串，Cookie变量名；$value，字符串，Cookie变量值，为空则删除Cookie； $time，int，Cookie变量生存时间，为 0 则表示随浏览器进程
返回值：成功则返回 TRUE，失败则返回 FALSE
用途：创建或删除Cookie
定义位置：./include/global.func.php，默认被加载
 
module_setting：模块配置保存 函数原型：module_setting($module, $setting)
参数：$module，string，模块名；$setting，array，模块配置数组
返回值：总是返回 true
用途：保存模块配置
定义位置：./admin/include/global.func.php

moduledir：获取模块路径 函数原型：moduledir($module)
参数：$module，字符串，模块名
返回值：返回指定模块根目录相对路径。例如 moduledir('article') 返回 module/article
用途：获取模块路径
定义位置：./include/global.func.php，默认被加载
 
new_addslashes：转义字符串或数组值 函数原型：new_addslashes($string)
参数：$string ，字符串或数组
返回值：字符串或数组，与$string类型相同
用途：转义 $string 中的敏感字符，比如给单引号和双引号加上反斜线，一般用来处理表单提交的数据
定义位置：./include/global.func.php，默认被加载

new_htmlspecialchars：实体化字符串或数组值中的html 函数原型：new_htmlspecialchars($string)
参数：$string ，字符串或数组
返回值：字符串或数组，与$string类型相同
用途：实体化字符串或数组值中的html，禁止表单提交html，避免页面错乱或跨站脚本攻击
定义位置：./include/global.func.php，默认被加载

new_stripslashes：反字符串或数组转义 函数原型：new_stripslashes($string)
参数：$string ，字符串或数组
返回值：字符串或数组，与$string类型相同
用途：反字符串或数组转义。由于表单提交的数据被转义，把表单提交的数据存储为文本前需要通过此函数处理
定义位置：./include/global.func.php，默认被加载

convert_encoding：字符编码转换 函数原型：convert_encoding($from_encoding, $to_encoding, $str_or_array)
参数：$from_encoding，gbk，big5，utf-8，原字符集编码；$to_encoding，gbk，big5，utf-8，目标字符集编码；$str_or_array，要转换的字符串或数组
返回值：转换编码后的字符串，如果失败则返回 FALSE
用途：字符编码转换
定义位置：./include/charset.func.php
 

check_purview：判断当前用户是否拥有权限 函数原型：check_purview($groupids = '')
参数：$groupids，字符串，逗号分隔的数字，例如：,7,8,9,，指 groupid ID为 7、8、9 的用户拥有权限
返回值：有权限则返回 TRUE，否则返回 FALSE
用途：判断当前用户是否拥有权限
定义位置：./include/global.func.php，默认被加载

editor：可视化编辑器调用 函数原型：editor($textareaid = 'content', $toolbar = 'phpcms', $width = 500, $height = 400, $editorName = 'editor')
参数：$textareaid，字符串，文本框ID；$toolbar，字符串，工具栏样式；$width，int，编辑器宽度；$height，int，编辑器高度；
返回值：无返回值
用途：调用可视化编辑器。$toolbar 为 editor 时调用 ,/editor 编辑器，否则调用 ./fckeditor 编辑器。
前台模板编辑器调用示例：
  <textarea name="content" id="content" cols="100" rows="25"></textarea>
  {$editor('content','phpcms',500,400)}
定义位置：./include/global.func.php，默认被加载

phpcms_auth：可逆的加密与解密 函数原型：phpcms_auth($txt, $operation = 'ENCODE', $key = '')
参数：$txt，字符串，需要加密或解密的字符串；$operation，为 ENCODE（加密） 或 DECODE（解密）；$key ，字符串，密钥
返回值：返回加密或解密后的字符串
用途：通常用来加密Cookie或者系统间通信数据，保证数据加密传输而不被窃取
定义位置：./include/global.func.php，默认被加载



array_save：保存数组到文件 函数原型：array_save($array, $arrayname, $file)
参数：$array，array，被保存的数组；$arrayname，string，保存后的数组名；$file，string，文件物理路径
返回值：数组文件大小
用途：保存数组到php文件。常用来保存一些配置和缓存
定义位置：./admin/include/global.func.php


area：获取指定城市的区/县列表 函数原型：area($province, $city)
参数：$province，字符串，省/市名称；$city，城市名称
返回值：以数组形式返回城市的区/县列表
用途：获取指定城市的区/县列表
定义位置：./include/area.func.php
应用举例：
假设 ./test.php 代码如下：
<?php
require './include/common.inc.php';
require_once PHPCMS_ROOT.'/include/area.func.php';
$areas = area('陕西省', '西安市');
print_r($areas);
?>
上例将打印出西安市下面的区/县名称


province：获取省市名称列表 函数原型：province()
参数：无
返回值：以数组形式返回省市名称
用途：获取省市名称列表
定义位置：./include/area.func.php
应用举例：
<?php
require './include/common.inc.php';
require_once PHPCMS_ROOT.'/include/area.func.php';
$provinces = province();
print_r($provinces);
?>
 

template：获取模板缓存物理路径 函数原型：template($module = 'phpcms', $template = 'index')
参数：$module，字符串，模块名；$template，字符串，去掉了后缀的模板名
返回值：字符串，模板物理路径
用途：获取模板缓存物理路径，如果模板缓存不存在或者过期，则系统会重新编译模板缓存。
模板调用实例：include template('phpcms','index');  //包含网站首页模板
定义位置：./include/global.func.php，默认被加载


template_cache：重新编译所有模板 函数原型：template_cache()
参数：无
返回值：无
用途：重新编译所有模板。phpcms模板在每次修改后都会自动编译成php文件，以便加快执行速度。
定义位置：./include/template.func.php

template_compile：模板编译 函数原型：template_compile($module,$template)
参数：$module，模板所属模块名；$template，模板名；
返回值：编译后的文件字节数
用途：编译模板文件。phpcms模板在每次修改后都会自动编译成php文件，以便加快执行速度。
template_compile('phpcms','index');
这个语句意思是把网站首页模板文件编译为php的缓存
定义位置：./include/template.func.php


template_module：编译指定模块的所有模板 函数原型：template_module($module)
参数：$module，模板所属模块名；
返回值：总是返回 true
用途：编译指定模块的模板文件。
phpcms模板在每次修改后都会自动编译成php文件，以便加快执行速度。
template_module('article');
这个语句意思是把文章模块所有模板文件编译为php的缓存
定义位置：./include/template.func.php


template_parse：模板代码解析 函数原型：template_parse($str)
参数：$str，被解析的字符串；
返回值：解析后的字符串
用途：此函数用来把html代码中的模板代码（变量、常量、循环、判断、中文标签、函数）解析为合法的php代码
定义位置：./include/template.func.php



tpl_data：获取模板执行后的数据 函数原型：tpl_data($module = 'phpcms', $template = 'index')
参数：$module，字符串，模块名；$template，字符串，模板名
返回值：返回模板被执行后的数据
用途：获取模板执行后的数据。在给用户发送邮件的时候，经常需要得到指定邮件模板执行后的数据。
定义位置：./include/global.func.php，默认被加载

admin_catpos：获取后台栏目当前位置html代码 函数原型：admin_catpos($catid, $s = ' >> ')
参数：$catid，int，栏目ID；$s，string，分隔符
返回值：后台栏目当前位置html代码
用途：获取后台栏目当前位置html代码。
定义位置：./admin/include/global.func.php


admin_users：获得模块/频道/栏目管理员帐号代码 函数原型：admin_users($field = '', $search = '', $grade = -1)
参数：$field，string，搜索字段；$search，string，搜索字符；$grade，int，管理员等级，-1表示不限等级
返回值：模块/频道/栏目管理员帐号代码
用途：获得模块/频道/栏目管理员帐号代码。经常在后台用来显示各模块/频道/栏目的管理员

应用举例：
获取频道ID为1的管理员帐号
<?php
echo admin_users( 'channelids', ',1,');
?>
定义位置：./admin/include/global.func.php


adminmenu：获取后台操作菜单 函数原型：adminmenu($menuname, $submenu=array())
参数：$menuname，string，菜单名；$submenu，array，菜单定义数组
返回值：后台操作菜单html代码
用途：此函数后台操作菜单html代码

应用举例：
<?php
defined('IN_PHPCMS') or exit('Access Denied');

$submenu = array
(
array("管理首页", "?mod=".$mod."&file=".$file."&channelid=".$channelid."&action=manage"),
array("添加栏目", "?mod=".$mod."&file=".$file."&channelid=".$channelid."&action=add"),
array("合并栏目", "?mod=".$mod."&file=".$file."&channelid=".$channelid."&action=join"),
array("栏目数据修复", "?mod=".$mod."&file=".$file."&channelid=".$channelid."&action=repair")
);
$menu = adminmenu("栏目管理",$submenu);

echo $menu;
?>
定义位置：./admin/include/global.func.php


admintpl：获取后台模板路径 函数原型：admintpl($file = 'index', $module = '')
参数：$file，string，后台模板文件名（不包括后缀 .tpl.php）；$module，string，模板所属模块名
返回值：模板物理路径
用途：此函数用来获取后台模板物理路径。调用后台模板的方法：
<?php

include admintpl('index');
?>
定义位置：./admin/include/global.func.php