ecshop二次开发网页模板之常用函数汇总

• 最近进行ecshop的二次开发，整理了一部分的函数，另外在ecshop论坛上面也发现了很多函数说明，整理汇总如下，供大家参考。
• 所有函数功能说明:
• lib_time.php
• gmtime()
• 说明：获得当前格林威治时间的时间戳
• server_timezone()
• 说明：获得服务器的时区
• local_mktime($hour = NULL , $minute= NULL, $second = NULL, $month = NULL, $day = NULL, $year = NULL)
• 说明：生成一个用户自定义时区日期的GMT时间戳
• local_date($format, $time = NULL)
• 说明：将GMT时间戳格式化为用户自定义时区日期
• gmstr2time($str)
• 说明：转换字符串形式的时间表达式为GMT时间戳
• local_strtotime($str)
• 说明：将一个用户自定义时区的日期转为GMT时间戳
• local_gettime($timestamp = NULL)
• 说明：获得用户所在时区指定的时间戳
• local_getdate($timestamp = NULL)
• 说明：获得用户所在时区指定的日期和时间信息
• lib_base.php
• sub_str($str, $length = 0, $append = true)
• 说明：截取UTF-8编码下字符串的函数
• real_ip()
• 说明：获得用户的真实IP地址
• str_len($str)
• 说明：计算字符串的长度（汉字按照两个字符计算）
• get_crlf()
• 说明：获得用户操作系统的换行符
• send_mail($name, $email, $subject, $content, $type = 0, $notification=false)
• 说明：邮件发送
• gd_version()
• 说明：获得服务器上的 GD 版本
• file_get_contents($file)
• 说明：如果系统不存在file_get_contents函数则声明该函数
• file_put_contents($file, $data, $flags = ”)
• 说明：如果系统不存在file_put_contents函数则声明该函数
• floatval($n)
• 说明：如果系统不存在 floatval 函数则声明该函数
• file_mode_info($file_path)
• 说明：文件或目录权限检查函数
• log_write($arg, $file = ”, $line = ”)
• 说明：写入日志内容
• make_dir($folder)
• 说明：检查目标文件夹是否存在，如果不存在则自动创建该目录
• gzip_enabled()
• 说明：获得系统是否启用了 gzip
• addslashes_deep($value)
• 说明：递归方式的对变量中的特殊字符进行转义
• addslashes_deep_obj($obj)
• 说明：将对象成员变量或者数组的特殊字符进行转义
• stripslashes_deep($value)
• 说明：递归方式的对变量中的特殊字符去除转义
• make_semiangle($str)
• 说明：将一个字串中含有全角的数字字符、字母、空格或’%+-()’字符转换为相应半角字符
• check_file_type($filename, $realname = ”, $limit_ext_types = ”)
• 说明：检查文件类型 /文件名/真实文件名/允许的文件类型
• mysql_like_quote($str)
• 说明：对 MYSQL LIKE 的内容进行转义 过滤掉_ %等字符.
• real_server_ip()
• 说明：获取服务器的ip
• ecs_header($string, $replace = true, $http_response_code = 0)
• 说明：自定义 header 函数，用于过滤可能出现的安全隐患
• ecs_iconv($source_lang, $target_lang, $source_string = ”)
• 说明：自定义的编码转换
• ecs_geoip($ip)
• 说明：取得IP的地址,采用IP库
• trim_right($str)
• 说明：去除字符串右侧可能出现的乱码
• move_upload_file($file_name, $target_name = ”)
• 说明：将上传文件转移到指定位置
• json_str_iconv($str)
• 说明：将JSON传递的参数转码
• get_file_suffix($file_name, $allow_type = array())
• 说明：获取文件后缀名,并判断是否合法
• read_static_cache($cache_name)
• 说明：读结果缓存文件
• write_static_cache($cache_name, $caches)
• 说明：写结果缓存文件
• lib_common.php (公用函数库)
• db_create_in($item_list, $field_name = ”)
• 说明：创建像这样的查询: “IN(‘a’,’b’)” $item_list为数组
• is_email($user_email)
• 说明：验证输入的邮件地址是否合法
• is_time($time)
• 说明：检查是否为一个合法的时间格式
• assign_query_info()
• 说明：获得查询时间和次数，并赋值给smarty
• region_result($parent, $sel_name, $type)
• 说明：创建地区的返回信息
• get_regions($type = 0, $parent = 0)
• 说明：获得指定国家的所有省份, 函数需要数据库支持.
• get_shipping_config($area_id)
• 说明：获得配送区域中指定的配送方式的配送费用的计算参数 比如快捷公司不同.
• init_users()
• 说明：初始化会员数据整合类
• cat_list($cat_id = 0, $selected = 0, $re_type = true, $level = 0, $is_show_all = true)
• 说明：获得指定分类下的子分类的数组, $re_type控制返回类型
• cat_options($spec_cat_id, $arr)
• 说明：过滤和排序所有分类，返回一个带有缩进级别的数组
• load_config()
• 说明：载入配置信息
• get_brand_list()
• 说明：取得品牌列表
• get_brands($cat = 0, $app = ‘brand’)
• 说明：获得某个分类下的品牌列表
• get_promotion_info($goods_id = ”)
• 说明：所有的促销活动信息
• get_children($cat = 0)
• 说明：获得指定分类下所有底层分类的ID
• get_article_children ($cat = 0)
• 说明：获得指定文章分类下所有底层分类的ID
• get_mail_template($tpl_name)
• 说明：获取邮件模板
• order_action($order_sn, $order_status, $shipping_status, $pay_status, $note = ”, $username = null)
• 说明：记录订单操作记录
• price_format($price, $change_price = true)
• 说明：格式化商品价格
• get_virtual_goods($order_id, $shipping = false)
• 说明：返回订单中的虚拟商品 记录是否发货.
• virtual_goods_ship(&$virtual_goods, &$msg, $order_sn, $return_result = false, $process = ‘other’)
• 说明：虚拟商品发货
• virtual_card_shipping ($goods, $order_sn, &$msg, $process = ‘other’)
• 说明：虚拟卡发货
• virtual_card_result($order_sn, $goods)
• 说明：返回虚拟卡信息
• get_snatch_result($id)
• 说明：获取指定 id snatch 活动的结果
• clear_tpl_files($is_cache = true, $ext = ”)
• 说明：清除指定后缀的模板缓存或编译文件
• clear_compiled_files($ext = ”)
• 说明：清除模版编译文件
• clear_cache_files($ext = ”)
• 说明：清除缓存文件
• clear_all_files($ext = ”)
• 说明：清除模版编译和缓存文件
• smarty_insert_scripts($args)
• 说明：页面上调用的js文件,组合功能.
• smarty_create_pages($params)
• 说明：创建分页的列表
• build_uri($app, $params, $append = ”, $page = 0, $size = 0)
• 说明：重写 URL 地址
• formated_weight($weight)
• 说明：格式化重量
• log_account_change($user_id, $user_money = 0, $frozen_money = 0, $rank_points = 0, $pay_points = 0, $change_desc = ”, $change_type = ACT_OTHER)
• 说明：记录帐户变动
• article_cat_list($cat_id = 0, $selected = 0, $re_type = true, $level = 0)
• 说明：获得指定分类下的子分类的数组/ 向下取数组.
• article_cat_options($spec_cat_id, $arr)
• 说明：过滤和排序所有文章分类，返回一个带有缩进级别的数组
• uc_call($func, $params=null)
• 说明：调用UCenter的函数
• exception_handler($errno, $errstr, $errfile, $errline)
• 说明：error_handle回调函数未启用.
• get_image_path($goods_id, $image=”, $thumb=false, $call=’goods’, $del=false)
• 说明：重新获得商品图片与商品相册的地址
• user_uc_call($func, $params = null)
• 说明：调用使用UCenter插件时的函数
• get_volume_price_list($goods_id, $price_type = ‘1’)
• 说明：取得商品优惠价格列表
• get_final_price($goods_id, $goods_num = ‘1’, $is_spec_price = false, $spec = array())
• 说明：取得商品最终使用价格
• get_package_info($id)
• 说明：获取指定id package 的信息
• get_package_goods($package_id)
• 说明：获得指定礼包的商品lib_main.php (前台公用函数库)
• update_user_info()
• 说明：更新用户SESSION,COOKIE及登录时间、登录次数。
• get_user_info($id=0)
• 说明：获取用户信息数组
• assign_ur_here($cat = 0, $str = ”)
• 说明：取得当前位置和页面标题
• get_parent_cats($cat)
• 说明：获得指定分类的所有上级分类
• build_pagetitle($arr, $type = ‘category’)
• 说明：根据提供的数组编译成页面标题
• build_urhere($arr, $type = ‘category’)
• 说明：根据提供的数组编译成当前位置
• assign_dynamic($tmp)
• 说明：获得指定页面的动态内容
• assign_articles($id, $num)
• 说明：分配文章列表给smarty
• get_shop_help()
• 说明：分配帮助信息
• 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=”)
• 说明：创建分页信息.分页函数.
• get_pager($url, $param, $record_count, $page = 1, $size = 10)
• 说明：生成给pager.lbi赋值的数组
• get_vote($id = ”)
• 说明：调用调查内容
• get_user_browser()
• 说明：获得浏览器名称和版本
• is_spider($record = true)
• 说明：判断是否为搜索引擎蜘蛛
• get_os()
• 说明：获得客户端的操作系统
• visit_stats()
• 说明：统计访问信息
• save_searchengine_keyword($domain, $path)
• 说明：保存搜索引擎关键字
• get_tags($goods_id = 0, $user_id = 0)
• 说明：获得指定用户、商品的所有标记
• get_dyna_libs($theme, $tmp)
• 说明：获取指定主题某个模板的主题的动态模块
• dyna_libs_replace($matches)
• 说明：换动态模块
• upload_file($upload, $type)
• 说明：处理上传文件，并返回上传图片名(上传失败时返回图片名为空）
• show_message($content, $links = ”, $hrefs = ”, $type = ‘info’, $auto_redirect = true)
• 说明：显示一个提示信息
• parse_rate_value($str, &$operate)
• 说明：将一个形如+10, 10, -10, 10%的字串转换为相应数字，并返回操作符号
• recalculate_price()
• 说明：重新计算购物车中的商品价格：目的是当用户登录时享受会员价格，当用户退出登录时不享受会员价格
• assign_comment($id, $type, $page = 1)
• 说明：查询评论内容
• assign_template($ctype = ”, $catlist = array())
• 说明：默认的smarty赋值
• time2gmt($time)
• 说明：将一个本地时间戳转成GMT时间戳
• get_user_bonus($user_id = 0)
• 说明：查询会员的红包金额
• set_affiliate()
• 说明：保存推荐uid
• get_affiliate()
• 说明：获取推荐uid
• article_categories_tree($cat_id = 0)
• 说明：获得指定分类同级的所有分类以及该分类下的子分类
• get_article_parent_cats($cat)
• 说明：获得指定文章分类的所有上级分类
• get_library_number($library, $template = null)
• 说明：取得某模板某库设置的数量
• get_navigator($ctype = ”, $catlist = array())
• 说明：取得自定义导航栏列表
• license_info()
• 说明：授权信息内容
• lib_insert.php (动态内容函数库)
• insert_query_info()
• 说明：获得查询次数以及查询时间
• insert_history()
• 说明：调用浏览历史
• insert_cart_info()
• 说明：调用购物车信息
• insert_ads($arr)
• 说明：调用指定的广告位的广告
• insert_member_info()
• 说明：调用会员信息
• insert_comments($arr)
• 说明：调用评论信息
• insert_vote()
• 说明：调用在线调查信息
• lib_goods.php (商品相关函数库)
• goods_sort($goods_a, $goods_b)
• 说明：商品推荐usort用自定义排序行数
• get_categories_tree($cat_id = 0)
• 说明：获得指定分类同级的所有分类以及该分类下的子分类
• get_child_tree($tree_id = 0)
• 说明：取和指定分类ID下的分类树
• get_top10($cats = ”)
• 说明：调用当前分类的销售排行榜
• get_recommend_goods($type = ”, $cats = ”)
• 说明：获得推荐商品
• get_promote_goods($cats = ”)
• 说明：获得促销商品
• get_category_recommend_goods($type = ”, $cats = ”, $brand = 0, $min =0, $max = 0, $ext=”)
• 说明：获得指定分类下的推荐商品
• get_goods_info($goods_id)
• 说明：获得商品的详细信息
• get_goods_properties($goods_id)
• 说明：获得商品的属性和规格
• get_same_attribute_goods($attr)
• 说明：获得属性相同的商品
• get_goods_gallery($goods_id)
• 说明：获得指定商品的相册
• assign_cat_goods($cat_id, $num = 0, $from = ‘web’)
• 说明：获得指定分类下的商品
• assign_brand_goods($brand_id, $num = 0, $cat_id = 0)
• 说明：获得指定的品牌下的商品
• get_extension_goods($cats)
• 说明：获得所有扩展分类属于指定分类的所有商品ID
• bargain_price($price, $start, $end)
• 说明：判断某个商品是否正在特价促销期
• spec_price($spec)
• 说明：获得指定的规格的价格
• group_buy_info($group_buy_id, $current_num = 0)
• 说明：取得团购活动信息
• group_buy_stat($group_buy_id, $deposit)
• 说明：取得某团购活动统计信息
• group_buy_status($group_buy)
• 说明：获得团购的状态
• auction_info($act_id, $config = false)
• 说明：取得拍卖活动信息
• auction_log($act_id)
• 说明：取得拍卖活动出价记录
• auction_status($auction)
• 说明：计算拍卖活动状态（注意参数一定是原始信息）
• goods_info($goods_id)
• 说明：取得商品信息
• favourable_info($act_id)
• 说明：取得优惠活动信息
• wholesale_info($act_id)
• 说明：批发信息
• add_style($goods_name, $style)
• 说明：添加商品名样式
• get_goods_attr($goods_id)
• 说明：取得商品属性
• get_goods_fittings($goods_list = array())
• 说明：获得购物车中商品的配件
• lib_article.php (文章及文章分类相关函数库)
• get_cat_articles($cat_id, $page = 1, $size = 20 ,$requirement=”)
• 说明：获得文章分类下的文章列表
• get_article_count($cat_id ,$requirement=”)
• 说明：获得指定分类下的文章总数