文本辅助函数

文本辅助函数文件包含了一些帮助你处理文本的函数。

加载辅助函数

该辅助函数通过下面的代码加载:

  1. $this->load->helper('text');

可用函数

该辅助函数有下列可用函数：

  • wordlimiter($str[, $limit = 100[, $endchar = '…']])

参数:

  • $str (string) — Input string
  • $limit (int) — Limit
  • $end_char (string) — End character (usually an ellipsis)返回:Word-limited string返回类型:string

根据指定的 单词 个数裁剪字符串。例如:

  1. $string = "Here is a nice text string consisting of eleven words.";
  2. $string = word_limiter($string, 4);
  3. // Returns:  Here is a nice

第三个参数用于给裁剪的字符串设置一个可选的后缀，默认使用省略号。

  • characterlimiter($str[, $n = 500[, $endchar = '…']])

参数:

  • $str (string) — Input string
  • $n (int) — Number of characters
  • $end_char (string) — End character (usually an ellipsis)返回:Character-limited string返回类型:string

根据指定的 字符 个数裁剪字符串。它会保证单词的完整性，所以最终生成的字符串长度和你指定的长度有可能会有出入。

例如:

  1. $string = "Here is a nice text string consisting of eleven words.";
  2. $string = character_limiter($string, 20);
  3. // Returns:  Here is a nice text string

第三个参数用于给裁剪的字符串设置一个可选的后缀，如果没该参数，默认使用省略号。

注解

如果你需要将字符串精确的裁剪到指定长度，请参见下面的 ellipsize() 函数。

  • asciito_entities($str_)

参数:

  • $str (string) — Input string返回:A string with ASCII values converted to entities返回类型:string

将 ASCII 字符转换为字符实体，包括高位 ASCII 和 Microsoft Word 中的特殊字符，在 Web 页面中使用这些字符可能会导致问题。转换为字符实体后，它们就可以不受浏览器设置的影响正确的显示出来，也能可靠的存储到到数据库中。本函数依赖于你的服务器支持的字符集，所以它可能并不能保证 100% 可靠，但在大多数情况下，它都能正确的识别这些特殊字符（例如重音字符）。

例如:

  1. $string = ascii_to_entities($string);
  • convertaccented_characters($str_)

参数:

  • $str (string) — Input string返回:A string with accented characters converted返回类型:string

将高位 ASCII 字符转换为与之相等的普通 ASCII 字符，当你的 URL 中需要使用非英语字符，而你的 URL 又设置了只允许出现普通 ASCII 字符时很有用。

例如:

  1. $string = convert_accented_characters($string);

注解

该函数使用了 application/config/foreign_chars.php 配置文件来决定将什么字符转换为什么字符。

  • wordcensor($str, $censored[, $replacement = ''_])

参数:

  • $str (string) — Input string
  • $censored (array) — List of bad words to censor
  • $replacement (string) — What to replace bad words with返回:Censored string返回类型:string

对字符串中出现的敏感词进行审查。第一个参数为原始字符串，第二个参数为一个数组，包含你要禁用的单词，第三个参数（可选）可以设置将出现的敏感词替换成什么，如果未设置，默认替换为磅字符：#### 。

例如:

  1. $disallowed = array('darn', 'shucks', 'golly', 'phooey');
  2. $string = word_censor($string, $disallowed, 'Beep!');
  • highlightcode($str_)

参数:

  • $str (string) — Input string返回:String with code highlighted via HTML返回类型:string

对一段代码（PHP、HTML 等）进行着色。例如:

  1. $string = highlight_code($string);

该函数使用了 PHP 的 highlight_string() 函数，所以着色的颜色是在 php.ini 文件中设置的。

  • highlightphrase($str, $phrase[, $tagopen = ''[, $tag_close = '']])

参数:

  • $str (string) — Input string
  • $phrase (string) — Phrase to highlight
  • $tag_open (string) — Opening tag used for the highlight
  • $tag_close (string) — Closing tag for the highlight返回:String with a phrase highlighted via HTML返回类型:string

对字符串内的一个短语进行突出显示。第一个参数是原始字符串，第二个参数是你想要突出显示的短语。如果要用 HTML 标签对短语进行标记，那么第三个和第四个参数分别是你想要对短语使用的 HTML 开始和结束标签。

例如:

  1. $string = "Here is a nice text string about nothing in particular.";
  2. echo highlight_phrase($string, "nice text", '<span style="color:#990000;">', '</span>');

上面的代码将输出:

  1. Here is a <span style="color:#990000;">nice text</span> string about nothing in particular.

注解

该函数默认是使用 标签，老版本的浏览器可能不支持 这个 HTML5 新标签，所以如果你想支持这些老的浏览器，推荐你在你的样式文件中添加如下 CSS 代码:

  1. mark {
  2.     background: #ff0;
  3.     color: #000;
  4. };

  • wordwrap($str[, $charlim = 76_])

参数:

  • $str (string) — Input string
  • $charlim (int) — Character limit返回:Word-wrapped string返回类型:string

根据指定的 字符 数目对文本进行换行操作，并且保持单词的完整性。

例如:

  1. $string = "Here is a simple string of text that will help us demonstrate this function.";
  2. echo word_wrap($string, 25);
  3.  
  4. // Would produce:
  5. // Here is a simple string
  6. // of text that will help us
  7. // demonstrate this
  8. // function.
  • ellipsize($str, $max_length[, $position = 1[, $ellipsis = '…']])

参数:

  • $str (string) — Input string
  • $max_length (int) — String length limit
  • $position (mixed) — Position to split at (int or float)
  • $ellipsis (string) — What to use as the ellipsis character返回:Ellipsized string返回类型:string

该函数移除字符串中出现的标签，并根据指定的长度裁剪字符串，并插入省略号。

第一个参数是要处理的字符串，第二个参数为最终处理完后的字符串长度，第三个参数为插入省略号的位置，值为 0-1 表示从左到右。例如设置为 1省略号将插入到字符串的右侧，0.5 将插入到中间，0 将插入到左侧。

第四个参数是可选的，表示省略号的类型，默认是 … 。

例如:

  1. $str = 'this_string_is_entirely_too_long_and_might_break_my_design.jpg';
  2. echo ellipsize($str, 32, .5);

输出结果:

  1. this_string_is_e&hellip;ak_my_design.jpg