4 * This file is part of the symfony package.
5 * (c) 2004-2006 Fabien Potencier <fabien.potencier@symfony-project.com>
6 * (c) 2004 David Heinemeier Hansson
8 * For the full copyright and license information, please view the LICENSE
9 * file that was distributed with this source code.
17 * @author Fabien Potencier <fabien.potencier@symfony-project.com>
18 * @author David Heinemeier Hansson
19 * @version SVN: $Id: TextHelper.php 3699 2007-04-02 11:47:32Z fabien $
23 * Truncates +text+ to the length of +length+ and replaces the last three characters with the +truncate_string+
24 * if the +text+ is longer than +length+.
26 function truncate_text($text, $length = 30, $truncate_string = '...', $truncate_lastspace = false)
33 if (strlen($text) > $length)
35 $truncate_text = substr($text, 0, $length - strlen($truncate_string));
36 if ($truncate_lastspace)
38 $truncate_text = preg_replace('/\s+?(\S+)?$/', '', $truncate_text);
41 return $truncate_text.$truncate_string;
50 * Highlights the +phrase+ where it is found in the +text+ by surrounding it like
51 * <strong class="highlight">I'm a highlight phrase</strong>. The highlighter can be specialized by
52 * passing +highlighter+ as single-quoted string with \1 where the phrase is supposed to be inserted.
53 * N.B.: The +phrase+ is sanitized to include only letters, digits, and spaces before use.
55 function highlight_text($text, $phrase, $highlighter = '<strong class="highlight">\\1</strong>')
67 return preg_replace('/('.preg_quote($phrase, '/').')/i', $highlighter, $text);
71 * Extracts an excerpt from the +text+ surrounding the +phrase+ with a number of characters on each side determined
72 * by +radius+. If the phrase isn't found, nil is returned. Ex:
73 * excerpt("hello my world", "my", 3) => "...lo my wo..."
75 function excerpt_text($text, $phrase, $radius = 100, $excerpt_string = '...')
77 if ($text == '' || $phrase == '')
82 $found_pos = strpos(strtolower($text), strtolower($phrase));
83 if ($found_pos !== false)
85 $start_pos = max($found_pos - $radius, 0);
86 $end_pos = min($found_pos + strlen($phrase) + $radius, strlen($text));
88 $prefix = ($start_pos > 0) ? $excerpt_string : '';
89 $postfix = $end_pos < strlen($text) ? $excerpt_string : '';
91 return $prefix.substr($text, $start_pos, $end_pos - $start_pos).$postfix;
96 * Word wrap long lines to line_width.
98 function wrap_text($text, $line_width = 80)
100 return preg_replace('/(.{1,'.$line_width.'})(\s+|$)/s', "\\1\n", preg_replace("/\n/", "\n\n", $text));
104 # Returns +text+ transformed into html using very simple formatting rules
105 # Surrounds paragraphs with <tt><p></tt> tags, and converts line breaks into <tt><br /></tt>
106 # Two consecutive newlines(<tt>\n\n</tt>) are considered as a paragraph, one newline (<tt>\n</tt>) is
107 # considered a linebreak, three or more consecutive newlines are turned into two newlines
109 function simple_format_text($text, $options = array())
111 $css = (isset($options['class'])) ? ' class="'.$options['class'].'"' : '';
113 $text = sfToolkit::pregtr($text, array("/(\r\n|\r)/" => "\n", // lets make them newlines crossplatform
114 "/\n{3,}/" => "\n\n", // zap dupes
115 "/\n\n/" => "</p>\\0<p$css>", // turn two newlines into paragraph
116 "/([^\n])\n([^\n])/" => "\\1\n<br />\\2")); // turn single newline into <br/>
118 return '<p'.$css.'>'.$text.'</p>'; // wrap the first and last line in paragraphs before we're done
122 * Turns all urls and email addresses into clickable links. The +link+ parameter can limit what should be linked.
123 * Options are :all (default), :email_addresses, and :urls.
126 * auto_link("Go to http://www.symfony-project.com and say hello to fabien.potencier@example.com") =>
127 * Go to <a href="http://www.symfony-project.com">http://www.symfony-project.com</a> and
128 * say hello to <a href="mailto:fabien.potencier@example.com">fabien.potencier@example.com</a>
130 function auto_link_text($text, $link = 'all', $href_options = array())
134 return _auto_link_urls(_auto_link_email_addresses($text), $href_options);
136 else if ($link == 'email_addresses')
138 return _auto_link_email_addresses($text);
140 else if ($link == 'urls')
142 return _auto_link_urls($text, $href_options);
147 * Turns all links into words, like "<a href="something">else</a>" to "else".
149 function strip_links_text($text)
151 return preg_replace('/<a.*>(.*)<\/a>/m', '\\1', $text);
154 if (!defined('SF_AUTO_LINK_RE'))
156 define('SF_AUTO_LINK_RE', '~
158 <\w+.*?>| # leading HTML tag, or
159 [^=!:\'"/]| # leading punctuation, or
160 ^ # beginning of line
163 (?:https?://)| # protocol spec, or
167 [-\w]+ # subdomain or domain
168 (?:\.[-\w]+)* # remaining subdomains or domain
170 (?:/(?:(?:[\~\w\+%-]|(?:[,.;:][^\s$]))+)?)* # path
171 (?:\?[\w\+%&=.;-]+)? # query string
172 (?:\#[\w\-]*)? # trailing anchor
174 ([[:punct:]]|\s|<|$) # trailing text
179 * Turns all urls into clickable links.
181 function _auto_link_urls($text, $href_options = array())
183 $href_options = _tag_options($href_options);
184 return preg_replace_callback(
186 create_function('$matches', '
187 if (preg_match("/<a\s/i", $matches[1]))
193 return $matches[1].\'<a href="\'.($matches[2] == "www." ? "http://www." : $matches[2]).$matches[3].\'"'.$href_options.'>\'.$matches[2].$matches[3].\'</a>\'.$matches[4];
200 * Turns all email addresses into clickable links.
202 function _auto_link_email_addresses($text)
204 return preg_replace('/([\w\.!#\$%\-+.]+@[A-Za-z0-9\-]+(\.[A-Za-z0-9\-]+)+)/', '<a href="mailto:\\1">\\1</a>', $text);