CodeIgniter辅助函数简介

作者:烨竹

目录结构

CodeIgniter辅助函数简介_第1张图片

辅助函数参考

  • 数组辅助函数
  • 验证码辅助函数
  • Cookie 辅助函数
  • 日期辅助函数
  • 目录辅助函数
  • 下载辅助函数
  • 文件辅助函数
  • 表单辅助函数
  • HTML 辅助函数
  • Inflector 辅助函数
  • 语言辅助函数
  • 数字辅助函数
  • 路径辅助函数
  • 安全辅助函数
  • 字符串辅助函数
  • 文本辅助函数
  • 排版辅助函数
  • URL 辅助函数
  • XML 辅助函数

辅助函数具体内容如下:

首先是加载原则:要用那个辅助函数你要先加载哪个文件;
还可以这样,如果你懂源码的话还可以自己建一个新的辅助函数文件function.php, 把你项目中能够用到的函数复制进去,或者自己自定义的函数写进去;具体见http://codeigniter.org.cn/user_guide/general/helpers.html;
这也算是CodeIgniter的一大好处了--自由,简洁

具体见下图哈哈:

CodeIgniter辅助函数简介_第2张图片

下面是辅助函数提供的具体函数,每个函数的运行原理可以阅读源码;具体用法见:http://codeigniter.org.cn/user_guide/helpers/index.html#id1

数组函数

该函数通过索引获取数组中的元素:
element($item, $array[, $default = NULL])

通过多个索引获取数组中的多个元素:
elements($items, $array[, $default = NULL])

传入一个数组,并返回数组中随机的一个元素:
random_element($array)

验证码辅助函数

主要作用生成验证码;

可用函数:
根据你提供的一系列参数生成一张验证码图片,返回包含此图片信息的数组:create_captcha([$data = ''[, $img_path = ''[, $img_url = ''[, $font_path = '']]]])

Cookie

设置浏览器Cookie:
set_cookie ($名称[,$值= '' [,$到期= '' [,$域= '' [,$路径= '/' [,$前缀= '' [,$固定= NULL [,$仅Http = NULL ] ] ] ] ] ] ] )

获取浏览器Cookie:
get_cookie ($ index [,$ xss_clean = NULL ] )

删除一条Cookie:
delete_cookie ($ name [,$ domain ='' [,$ path ='/' [,$ prefix ='' ] ] ] )

日期

本地时间:
now([$timezone = NULL])

date() 函数一样, 但是它支持 MySQL 风格的日期格式:
mdate([$datestr = ''[, $time = '']])

将时间转换为 GMT 时间:
local_to_gmt([$time = ''])

将 GMT 时间转换为本地时间:
gmt_to_local([$time = ''[, $timezone = 'UTC'[, $dst = FALSE]]])

将 MySQL 时间戳转换为 UNIX 时间戳:
mysql_to_unix([$time = ''])

将 UNIX 时间戳转换为方便人类阅读的格式:
unix_to_human([$time = ''[, $seconds = FALSE[, $fmt = 'us']]])
人类阅读的时间格式转换为 UNIX 时间戳:
human_to_unix([$datestr = ''])

将一个 UNIX 时间戳转换为以下这种格式
1 Year, 10 Months, 2 Weeks, 5 Days, 10 Hours, 16 Minutes:
timespan([$seconds = 1[, $time = ''[, $units = '']]])

返回指定某个月的天数,会考虑闰年:
days_in_month([$month = 0[, $year = '']])

返回某一段时间的日期列表:
date_range([$unix_start = ''[, $mixed = ''[, $is_unix = TRUE[, $format = 'Y-m-d']]]])


根据时区返回它的 UTC 时间偏移:
timezones([$tz = ''])

该函数用于生成一个时区下拉菜单:
timezone_menu([$default = 'UTC'[, $class = ''[, $name = 'timezones'[, $attributes = '']]]])

目录辅助函数

该函数读取第一个参数中指定的目录路径,并构建它及其所有包含文件的数组表示:
directory_map($source_dir[, $directory_depth = 0[, $hidden = FALSE]])

下载辅助函数

下载一个服务器上已存在的文件:
force_download([$filename = ''[, $data = ''[, $set_mime = FALSE]]])

文件辅助函数

向指定文件中写入数据,如果文件不存在,则创建该文件:
write_file($path, $data[, $mode = 'wb'])

删除指定路径下的所有文件:
delete_files($path[, $del_dir = FALSE[, $htdocs = FALSE]])

获取指定目录下所有文件名组成的数组:
get_filenames($source_dir[, $include_path = FALSE])

获取指定目录下所有文件信息组成的数组,包括文件名、文件大小、日期 和 权限:get_dir_file_info($source_dir, $top_level_only)

获取指定文件的信息,包括文件名、路径、文件大小,修改日期等:
get_file_info($file[, $returned_values = array('name', 'server_path', 'size', 'date')])

根据 config/mimes.php 文件中的配置将文件扩展名转换为 MIME 类型:et_mime_by_extension($filename)

将文件权限的数字格式(例如 fileperms() 函数的返回值)转换为标准的符号格式:symbolic_permissions($perms)

将文件权限的数字格式(例如 fileperms() 函数的返回值)转换为三个字符的八进制表示格式:octal_permissions($perms)

表单辅助函数

函数可以对 HTML 的特殊字符进行转义,从而可以安全的在域值中使用字符串:html_escape()

生成一个 form 起始标签:
form_open([$action = ''[, $attributes = ''[, $hidden = array()]]])

生成隐藏域:
form_hidden($name[, $value = ''])

生成标准的文本输入框:
form_input([$data = ''[, $value = ''[, $extra = '']]])

生成标准的password文本输入框:
form_password([$data = ''[, $value = ''[, $extra = '']]])

生成"file" 类型输入框 :
form_upload([$data = ''[, $value = ''[, $extra = '']]])

生成"textarea" 类型输入框:
form_textarea([$data = ''[, $value = ''[, $extra = '']]])

生成一个标准的下拉框域:
form_dropdown([$name = ''[, $options = array()[, $selected = array()[, $extra = '']]]])

生成一个标准的多选下拉框:
form_multiselect([$name = ''[, $options = array()[, $selected = array()[, $extra = '']]]])

生成 fieldset 和 legend 域:
form_fieldset([$legend_text = ''[, $attributes = array()]])

用于生成结束标签 :
form_fieldset_close([$extra = ''])

生成一个复选框:
form_checkbox([$data = ''[, $value = ''[, $checked = FALSE[, $extra = '']]]])

生成

HTML辅助函数

创建 HTML 标题标签:
heading([$data = ''[, $h = '1'[, $attributes = '']]])

生成 HTML 标签:
img([$src = ''[, $index_page = FALSE[, $attributes = '']]])

生成 HTML 标签:
link_tag([$href = ''[, $rel = 'stylesheet'[, $type = 'text/css'[, $title = ''[, $media = ''[, $index_page = FALSE]]]]]])

生成 HTML 无序列表(

    ):
    ul($list[, $attributes = ''])

    生成的是有序列表(
      ):
      ol($list, $attributes = '')

      生成 meta 标签:
      meta([$name = ''[, $content = ''[, $type = 'name'[, $newline = "n"]]]])

      用于生成 DTD:
      doctype([$type = 'xhtml1-strict'])

Inflector 辅助函数

Inflector 辅助函数文件包含了一些帮助你将 英语 单词转换为单复数或驼峰格式等等的函数

将一个单词的复数形式变为单数形式:
singular($str)

将一个单词的单数形式变为复数形式:
plural($str)

将一个以空格或下划线分隔的单词转换为驼峰格式:
camelize($str)

将以空格分隔的多个单词转换为下划线分隔格式:
underscore($str)

将以下划线分隔的多个单词转换为以空格分隔,并且每个单词以大写开头:humanize($str[, $separator = '_'])

判断某个单词是否有复数形式:
is_countable($word)

语言辅助函数

从加载的语言文件中返回一行文本:
lang($line[, $for = ''[, $attributes = array()]])

数字辅助函数

根据数值大小以字节的形式格式化,并添加适合的缩写单位:
byte_format($num[, $precision = 1])

路径辅助函数

该函数返回指定路径在服务端的绝对路径(不是符号路径或相对路径):set_realpath($path[, $check_existance = FALSE])

安全辅助函数

XSS 攻击的过滤:
xss_clean($str[, $is_image = FALSE])

提供针对目录遍历的保护:
sanitize_filename($filename)

从字符串中去除图像标签,它将图像URL保留为纯文本:
strip_image_tags($ str )

将 PHP 标签转换为实体对象:
encode_php_tags($str)

字符串辅助函数

移除一个字符串数组中的所有斜线:
strip_slashes($data)

移除字符串中出现的单引号和双引号:
strip_quotes($str)

移除字符串中重复出现的某个指定字符:
reduce_double_slashes($str)

当执行一个循环时,让两个或两个以上的条目轮流使用:
alternator($args)

自增字符串是指向字符串尾部添加一个数字,或者对这个数字进行自增:increment_string($ str [,$ separator ='_' [,$ first = 1 ] ] )

根据你所指定的类型和长度产生一个随机字符串:
random_string([ $ type ='alnum' [,$ len = 8 ] ] )

将字符串中的双斜线('//')转换为单斜线('/'),但不转换 URL 协议中的双斜线(例如:http://)
:reduce_multiples($str[, $character = ''[, $trim = FALSE]])

将字符串中的单引号和双引号转换为相应的 HTML 实体:
quotes_to_entities($str)

文本辅助函数

根据指定的 单词 个数裁剪字符串:
word_limiter($str[, $limit = 100[, $end_char = '…']])

根据指定的 字符 个数裁剪字符串;它会保证单词的完整性,所以最终生成的 字符串长度和你指定的长度有可能会有出入:
character_limiter($str[, $n = 500[, $end_char = '…']])

将 ASCII 字符转换为字符实体:
ascii_to_entities($str)

将高位 ASCII 字符转换为与之相等的普通 ASCII 字符:convert_accented_characters($str)

对字符串中出现的敏感词进行审查:
word_censor($str, $censored[, $replacement = ''])

对一段代码(PHP、HTML 等)进行着色:
highlight_code($str)

对字符串内的一个短语进行突出显示:
highlight_phrase($str, $phrase[, $tag_open = ''[, $tag_close = '']])

根据指定的 字符 数目对文本进行换行操作,并且保持单词的完整性:word_wrap($str[, $charlim = 76])

该函数移除字符串中出现的标签,并根据指定的长度裁剪字符串,并插入省略号:ellipsize($str, $max_length[, $position = 1[, $ellipsis = '…']])

排版辅助函数

格式化文本以便纠正语义和印刷错误的 HTML 代码:
auto_typography($str[, $reduce_linebreaks = FALSE])

将换行符转换为
标签,忽略

 标签中的换行符:
nl2br_except_pre($str)

ENT_COMPAT 模式下的 PHP 原生函数 html_entity_decode():
entity_decode($str, $charset = NULL)

url辅助函数

根据配置文件返回你的站点 URL:
site_url([$uri = ''[, $protocol = NULL]])

根据配置文件返回你站点的根 URL:
base_url($uri = '', $protocol = NULL)

返回当前正在浏览的页面的完整 URL:
current_url()

返回包含该函数的页面的 URI 分段:
uri_string()

返回你在配置文件中配置的 index_page 参数:
index_page()

根据你提供的 URL 生成一个标准的 HTML 链接:
anchor($uri = '', $title = '', $attributes = '')

和anchor() 函数非常类似,只是它生成的 URL 将会在新窗口被打开:
anchor_popup($uri = '', $title = '', $attributes = FALSE)

创建一个标准的 HTML e-mail 链接:
mailto()

和mailto()函数一样,但是它的 mailto 标签使用了一个混淆的写法, 可以防止你的 e-mail 地址被垃圾邮件机器人爬到:
safe_mailto($email, $title = '', $attributes = '')

将一个字符串中的 URL 和 e-mail 地址自动转换为链接:
auto_link($str, $type = 'both', $popup = FALSE)

将字符串转换为对人类友好的 URL 字符串格式:
url_title($str, $separator = '-', $lowercase = FALSE)

如果协议前缀从URL中丢失,该功能将添加http://:
prep_url($str = '')

通过 HTTP 头重定向到指定 URL:
redirect($ uri ='',$ method ='auto',$ code = NULL )

XML 辅助函数

将输入字符串中的下列 XML 保留字符转换为实体(Entity):
xml_convert($str[, $protect_all = FALSE])

你可能感兴趣的:(CodeIgniter辅助函数简介)