ecshop函数库说明

http://hi.baidu.com/miracle521/item/d789e39b74fcbcdb7b7f01c6




require(ROOT_PATH . 'includes/inc_constant.php');//导入ecshop 常用的 常量定义文件
require(ROOT_PATH . 'includes/cls_ecshop.php');//导入 ECSHOP 基础类
require(ROOT_PATH . 'includes/cls_error.php');//导入 ECSHOP 用户级错误处理类
require(ROOT_PATH . 'includes/lib_time.php');// 导入 ECSHOP 时间函数
require(ROOT_PATH . 'includes/lib_base.php');//导入 ECSHOP 基础函数库
require(ROOT_PATH . 'includes/lib_common.php');//导入  ECSHOP 公用函数库
require(ROOT_PATH . 'includes/lib_main.php');//导入ECSHOP 前台公用函数库
require(ROOT_PATH . 'includes/lib_insert.php');//导入  ECSHOP 动态内容函数库
require(ROOT_PATH . 'includes/lib_goods.php');//导入 ECSHOP 商品相关函数库
require(ROOT_PATH . 'includes/lib_article.php');//导入 ECSHOP 文章及文章分类相关函数库
















http://bbs.phpchina.com/thread-145498-1-1.html
http://www.cnblogs.com/jessezhao/archive/2010/06/09/1755127.html
http://www.cnblogs.com/suihui/archive/2012/12/27/2835914.html






所有函数功能说明: 
lib_time.php
gmtime() 
P: 获得当前格林威治时间的时间戳 /$0
server_timezone() 
P: 获得服务器的时区 /$0
local_mktime($hour = NULL , $minute= NULL, $second = NULL, $month = NULL, $day = NULL, $year = NULL) 
P: 生成一个用户自定义时区日期的GMT时间戳
local_date($format, $time = NULL) 
P: 将GMT时间戳格式化为用户自定义时区日期
gmstr2time($str) 
P: 转换字符串形式的时间表达式为GMT时间戳
local_strtotime($str) 
P: 将一个用户自定义时区的日期转为GMT时间戳
local_gettime($timestamp = NULL) 
P: 获得用户所在时区指定的时间戳
local_getdate($timestamp = NULL) 
P: 获得用户所在时区指定的日期和时间信息
----------------------------------------------




lib_common.php (公用函数库)
db_create_in($item_list, $field_name = ”) 
P: 创建像这样的查询: “IN(’a',’b')” $item_list为数组
is_email($user_email) 
P: 验证输入的邮件地址是否合法
is_time($time) 
P: 检查是否为一个合法的时间格式
assign_query_info() 
P: 获得查询时间和次数，并赋值给smarty
region_result($parent, $sel_name, $type) 
P: 创建地区的返回信息
get_regions($type = 0, $parent = 0) 
P: 获得指定国家的所有省份, 函数需要数据库支持.
get_shipping_config($area_id) 
P: 获得配送区域中指定的配送方式的配送费用的计算参数 比如快捷公司不同.
init_users() 
P: 初始化会员数据整合类
cat_list($cat_id = 0, $selected = 0, $re_type = true, $level = 0, $is_show_all = true) 
P: 获得指定分类下的子分类的数组, $re_type控制返回类型
cat_options($spec_cat_id, $arr) 
P: 过滤和排序所有分类，返回一个带有缩进级别的数组
load_config() 
P: 载入配置信息
get_brand_list() 
P: 取得品牌列表
get_brands($cat = 0, $app = ‘brand’) 
P: 获得某个分类下的品牌列表
get_promotion_info($goods_id = ”) 
P: 所有的促销活动信息
get_children($cat = 0) 
P: 获得指定分类下所有底层分类的ID
get_article_children ($cat = 0) 
P: 获得指定文章分类下所有底层分类的ID
get_mail_template($tpl_name) 
P: 获取邮件模板
order_action($order_sn, $order_status, $shipping_status, $pay_status, $note = ”, $username = null) 
P: 记录订单操作记录
price_format($price, $change_price = true) 
P: 格式化商品价格
get_virtual_goods($order_id, $shipping = false) 
P: 返回订单中的虚拟商品 记录是否发货.
virtual_goods_ship(&$virtual_goods, &$msg, $order_sn, $return_result = false, $process = ‘other’) 
P: 虚拟商品发货
virtual_card_shipping ($goods, $order_sn, &$msg, $process = ‘other’) 
P: 虚拟卡发货
virtual_card_result($order_sn, $goods) 
P: 返回虚拟卡信息
get_snatch_result($id) 
P: 获取指定 id snatch 活动的结果
clear_tpl_files($is_cache = true, $ext = ”) 
P: 清除指定后缀的模板缓存或编译文件
clear_compiled_files($ext = ”) 
P: 清除模版编译文件
clear_cache_files($ext = ”) 
P: 清除缓存文件
clear_all_files($ext = ”) 
P: 清除模版编译和缓存文件
smarty_insert_scripts($args) 
P: 页面上调用的js文件,组合功能.
smarty_create_pages($params) 
P: 创建分页的列表
build_uri($app, $params, $append = ”, $page = 0, $size = 0) 
P: 重写 URL 地址
formated_weight($weight) 
P: 格式化重量
log_account_change($user_id, $user_money = 0, $frozen_money = 0, $rank_points = 0, $pay_points = 0, $change_desc = ”, $change_type = ACT_OTHER) 
P: 记录帐户变动
article_cat_list($cat_id = 0, $selected = 0, $re_type = true, $level = 0) 
P: 获得指定分类下的子分类的数组/ 向下取数组.
article_cat_options($spec_cat_id, $arr) 
P: 过滤和排序所有文章分类，返回一个带有缩进级别的数组
uc_call($func, $params=null) 
P: 调用UCenter的函数
exception_handler($errno, $errstr, $errfile, $errline) 
P: error_handle回调函数未启用.
get_image_path($goods_id, $image=”, $thumb=false, $call=’goods’, $del=false) 
P: 重新获得商品图片与商品相册的地址
user_uc_call($func, $params = null) 
P: 调用使用UCenter插件时的函数
get_volume_price_list($goods_id, $price_type = ‘1′) 
P: 取得商品优惠价格列表
get_final_price($goods_id, $goods_num = ‘1′, $is_spec_price = false, $spec = array()) 
P: 取得商品最终使用价格


get_package_info($id) 
P: 获取指定id package 的信息
get_package_goods($package_id) 
P: 获得指定礼包的商品


----------------------------------------------






lib_main.php (前台公用函数库)
update_user_info() 
P: 更新用户SESSION,COOKIE及登录时间、登录次数。
get_user_info($id=0) 
P: 获取用户信息数组
assign_ur_here($cat = 0, $str = ”) 
P: 取得当前位置和页面标题
get_parent_cats($cat) 
P: 获得指定分类的所有上级分类
build_pagetitle($arr, $type = ‘category’) 
P: 根据提供的数组编译成页面标题
build_urhere($arr, $type = ‘category’) 
P: 根据提供的数组编译成当前位置
assign_dynamic($tmp 
P: 获得指定页面的动态内容
assign_articles($id, $num) 
P: 分配文章列表给smarty
get_shop_help() 
P: 分配帮助信息
assign_pager($app, $cat, $record_count, $size, $sort, $order, $page = 1,$keywords = ”, $brand = 0, $price_min = 0, $price_max = 0, $display_type = ‘list’, $filter_attr=”, $url_format=”, $sch_array=”) 
P: 创建分页信息.分页函数.
get_pager($url, $param, $record_count, $page = 1, $size = 10) 
P: 生成给pager.lbi赋值的数组
get_vote($id = ”) 
P: 调用调查内容
get_user_browser() 
P: 获得浏览器名称和版本
is_spider($record = true) 
P: 判断是否为搜索引擎蜘蛛
get_os() 
P: 获得客户端的操作系统
visit_stats() 
P: 统计访问信息
save_searchengine_keyword($domain, $path) 
P: 保存搜索引擎关键字
get_tags($goods_id = 0, $user_id = 0) 
P: 获得指定用户、商品的所有标记
get_dyna_libs($theme, $tmp) 
P: 获取指定主题某个模板的主题的动态模块
dyna_libs_replace($matches) 
P: 换动态模块
upload_file($upload, $type) 
P: 处理上传文件，并返回上传图片名(上传失败时返回图片名为空）
show_message($content, $links = ”, $hrefs = ”, $type = ‘info’, $auto_redirect = true) 
P: 显示一个提示信息
parse_rate_value($str, &$operate) 
P: 将一个形如+10, 10, -10, 10%的字串转换为相应数字，并返回操作符号
recalculate_price() 
P: 重新计算购物车中的商品价格：目的是当用户登录时享受会员价格，当用户退出登录时不享受会员价格
assign_comment($id, $type, $page = 1) 
P: 查询评论内容
assign_template($ctype = ”, $catlist = array()) 
P: 默认的smarty赋值
time2gmt($time) 
P: 将一个本地时间戳转成GMT时间戳
get_user_bonus($user_id = 0) 
P: 查询会员的红包金额
set_affiliate() 
P: 保存推荐uid
get_affiliate() 
P: 获取推荐uid
article_categories_tree($cat_id = 0) 
P: 获得指定分类同级的所有分类以及该分类下的子分类
get_article_parent_cats($cat) 
P: 获得指定文章分类的所有上级分类
get_library_number($library, $template = null) 
P: 取得某模板某库设置的数量
get_navigator($ctype = ”, $catlist = array()) 
P: 取得自定义导航栏列表
license_info() 
P: 授权信息内容






















----------------------------------------------
lib_insert.php (动态内容函数库)
insert_query_info() 
P: 获得查询次数以及查询时间
insert_history() 
P: 调用浏览历史
insert_cart_info() 
P: 调用购物车信息
insert_ads($arr) 
P: 调用指定的广告位的广告
insert_member_info() 
P: 调用会员信息
insert_comments($arr) 
P: 调用评论信息
insert_vote() 
P: 调用在线调查信息




----------------------------------------------
lib_goods.php (商品相关函数库)
goods_sort($goods_a, $goods_b) 
P: 商品推荐usort用自定义排序行数
get_categories_tree($cat_id = 0) 
P: 获得指定分类同级的所有分类以及该分类下的子分类
get_child_tree($tree_id = 0) 
P: 取和指定分类ID下的分类树
get_top10($cats = ”) 
P: 调用当前分类的销售排行榜
get_recommend_goods($type = ”, $cats = ”) 
P: 获得推荐商品
get_promote_goods($cats = ”) 
P: 获得促销商品
get_category_recommend_goods($type = ”, $cats = ”, $brand = 0, $min =0, $max = 0, $ext=”) 
P: 获得指定分类下的推荐商品
get_goods_info($goods_id) 
P: 获得商品的详细信息
get_goods_properties($goods_id) 
P: 获得商品的属性和规格
get_same_attribute_goods($attr) 
P: 获得属性相同的商品
get_goods_gallery($goods_id) 
P: 获得指定商品的相册
assign_cat_goods($cat_id, $num = 0, $from = ‘web’) 
P: 获得指定分类下的商品
assign_brand_goods($brand_id, $num = 0, $cat_id = 0) 
P: 获得指定的品牌下的商品
get_extension_goods($cats) 
P: 获得所有扩展分类属于指定分类的所有商品ID
bargain_price($price, $start, $end) 
P: 判断某个商品是否正在特价促销期
spec_price($spec) 
P: 获得指定的规格的价格
group_buy_info($group_buy_id, $current_num = 0) 
P: 取得团购活动信息
group_buy_stat($group_buy_id, $deposit) 
P: 取得某团购活动统计信息
group_buy_status($group_buy) 
P: 获得团购的状态
auction_info($act_id, $config = false) 
P: 取得拍卖活动信息
auction_log($act_id) 
P: 取得拍卖活动出价记录
auction_status($auction) 
P: 计算拍卖活动状态（注意参数一定是原始信息）
goods_info($goods_id) 
P: 取得商品信息
favourable_info($act_id) 
P: 取得优惠活动信息
wholesale_info($act_id) 
P: 批发信息
add_style($goods_name, $style) 
P: 添加商品名样式
get_goods_attr($goods_id) 
P: 取得商品属性
get_goods_fittings($goods_list = array()) 
P: 获得购物车中商品的配件
lib_article.php (文章及文章分类相关函数库)
get_cat_articles($cat_id, $page = 1, $size = 20 ,$requirement=”) 
P: 获得文章分类下的文章列表
get_article_count($cat_id ,$requirement=”) 
P: 获得指定分类下的文章总数




















ecshop 资料整理






----------------------------------------------
lib_base.php 基础函数库
1.sub_str($str, $length = 0, $append = true)
　　截取UTF-8编码下字符串的函数
　　string $str 被截取的字符串
　　int $length 截取的长度
　　bool $append 是否附加省略号


2.reap_ip()
　　获得用户的真实IP地址


3.str_len($str)
　　计算字符串的长度（汉字按照两个字符计算）
4.get_crlf()
　　获得用户操作系统的换行符
5.send_mail($name, $email, $subject, $content, $type = 0, $notification=false)
　　邮件发送
　　$name[string] 接收人姓名
　　$email[string] 接收人邮件地址
　　$subject[string] 邮件标题
　　$content[string] 邮件内容
　　$type[int] 0 普通邮件， 1 HTML邮件
　　$notification[bool] true 要求回执， false 不用回执
6.gd_version()
　　获得服务器上的 GD 版本
7.file_mode_info($file_path)
　　文件或目录权限检查函数
8.make_dir($folder)
　　检查目标文件夹是否存在，如果不存在则自动创建该目录
9.gzip_enabled()
　　获得系统是否启用了 gzip
10.addslashes_deep($value)
　　递归方式的对变量中的特殊字符进行转义
11. addslashes_deep_obj($obj)
　　将对象成员变量或者数组的特殊字符进行转义
12.stripslashes_deep($value)
　　递归方式的对变量中的特殊字符去除转义
13.make_semiangle($str)
　　将一个字串中含有全角的数字字符、字母、空格或'%+-()'字符转换为相应半角字符
14.check_file_type($filename, $realname = '', $limit_ext_types = '')
　　检查文件类型
　　string filename 文件名
　　string realname 真实文件名
　　string limit_ext_types 允许的文件类型
　　return string
15.mysql_like_quote($str)
　　对 MYSQL LIKE 的内容进行转义
16.real_server_ip()
　　获取服务器的ip
17.ecs_header($string, $replace = true, $http_response_code = 0)
　　自定义 header 函数，用于过滤可能出现的安全隐患
18.ecs_geoip($ip)
19. ecs_iconv
20.trim_right($str)
　　去除字符串右侧可能出现的乱码
21.move_upload_file($file_name, $target_name = '')
　　将上传文件转移到指定位置
22.json_str_iconv($str)
　　将JSON传递的参数转码
23.to_utf8_iconv($str)
　　循环转码成utf8内容
24.get_file_suffix($file_name, $allow_type = array())
　　获取文件后缀名,并判断是否合法
25.read_static_cache($cache_name)
　　读结果缓存文件
26.write_static_cache($cache_name, $caches)
　　写结果缓存文件








----------------------------------------------
cls_ecshop.php 基础类


类名：ECS
构造函数： ECS
方法：
1.table($str)
　　将指定的表名加上前缀后返回
2. compile_password($pass) 
　　ECSHOP 密码编译方法
3.get_domain()
　　取得当前的域名
4.url()
　　获得 ECSHOP 当前环境的 URL 地址
5.http()
　　获得 ECSHOP 当前环境的 HTTP 协议方式
6.data_dir($sid = 0)
　　获得数据目录的路径
7. image_dir($sid = 0)
　　获得图片的目录路径
----------------------------------------------
cls_mysql.php mysql公用类库
类名：cls_mysql
构造函数：__construct
方法：
1.cls_mysql($dbhost, $dbuser, $dbpw, $dbname = '', $charset = 'gbk', $pconnect = 0, $quiet = 0)
2.connect($dbhost, $dbuser, $dbpw, $dbname = '', $charset = 'utf8', $pconnect = 0, $quiet = 0)
连接数据库
3.select_database($dbname)
选择数据库
4.set_mysql_charset($charset)
设置数据库编码
5.fetch_array
从结果集中取得一行作为数组。
6.query($sql, $type = '')
执行sql语句
7.affected_rows()
取得前一次 MySQL 操作所影响的记录行数
8.error()
mysql错误
9.errno()
返回上一个 MySQL 操作中的错误信息的数字编码
10.result
取得结果数据
11.num_rows($query)
取得结果集中行的数目
12.num_fields
取得结果中指定字段的字段名
13.free_result
释放结果内存
14.fetchRow($query)
15.fetch_fields($query)
16.version()
17.ping()
18.escape_string($unescaped_string)
19.close()
20.ErrorMsg($message = '', $sql = '')
21.selectLimit($sql, $num, $start = 0)
查询几条数
22.getOne($sql, $limited = false)
查询1条
23.getOneCached($sql, $cached = 'FILEFIRST')
24.getAll($sql)
查询所有
25.getAllCached($sql, $cached = 'FILEFIRST')
26.getRow($sql, $limited = false)
27.getRowCached($sql, $cached = 'FILEFIRST')
28.getCol($sql)
29.getColCached($sql, $cached = 'FILEFIRST')
30.autoExecute($table, $field_values, $mode = 'INSERT', $where = '', $querymode = '')
31.autoReplace($table, $field_values, $update_values, $where = '', $querymode = '')
32.setMaxCacheTime($second)
33.getMaxCacheTime()
34.getSqlCacheData($sql, $cached = '')
35.setSqlCacheData($result, $data)
36.table_lastupdate($tables)
获取 SQL 语句中最后更新的表的时间，有多个表的情况下，返回最新的表的时间
37.get_table_name($query_item)
38.set_disable_cache_tables($tables)
设置不允许进行缓存的表