* Copyright (c) 2006, Cake Software Foundation, Inc.
* 1785 E. Sahara Avenue, Suite 490-204
* Las Vegas, Nevada 89104
*
* Licensed under The MIT License
* Redistributions of files must retain the above copyright notice.
*
* @filesource
* @copyright Copyright (c) 2006, Cake Software Foundation, Inc.
* @link http://www.cakefoundation.org/projects/info/cakephp CakePHP Project
* @package cake
* @subpackage cake.cake.libs.view.helpers
* @since CakePHP v 0.10.0.1076
* @version $Revision$
* @modifiedby $LastChangedBy$
* @lastmodified $Date$
* @license http://www.opensource.org/licenses/mit-license.php The MIT License
*/
/**
* Included libraries.
*
*/
if (!class_exists('HtmlHelper')) {
uses(DS . 'view' . DS . 'helpers' . DS . 'html');
}
/**
* Text helper library.
*
* Text manipulations: Highlight, excerpt, truncate, strip of links, convert email addresses to mailto: links...
*
* @package cake
* @subpackage cake.cake.libs.view.helpers
*/
class TextHelper extends Helper {
/**
* Highlights a given phrase in a text.
*
* @param string $text Text to search the phrase in
* @param string $phrase The phrase that will be searched
* @param string $highlighter The piece of html with that the phrase will be highlighted
* @return string The highlighted text
*/
function highlight($text, $phrase, $highlighter = '\1') {
if (empty($phrase)) {
return $text;
}
if (is_array($phrase)) {
$replace = array();
$with = array();
foreach($phrase as $key => $value) {
if (empty($key)) {
$key = $value;
$value = $highlighter;
}
$replace[] = '|(' . $key . ')|';
$with[] = empty($value) ? $highlighter : $value;
}
return preg_replace($replace, $with, $text);
} else {
return preg_replace("|({$phrase})|i", $highlighter, $text);
}
}
/**
* Strips given text of all links ((.*)<\/a>|im', '\1', $text);
}
/**
* Adds links ( $value) {
$options .= "'$option' => '$value', ";
}
$options .= ')';
$text = preg_replace_callback('#((?:http|https|ftp|nntp)://[^ ]+)#', create_function('$matches',
'$Html = new HtmlHelper(); $Html->tags = $Html->loadConfig(); return $Html->linkOut($matches[0], $matches[0],' . $options . ');'), $text);
return preg_replace_callback('#(?tags = $Html->loadConfig(); return $Html->linkOut($matches[0], "http://" . $matches[0],' . $options . ');'), $text);
}
/**
* Adds email links ( '$value', ";
}
$options .= ')';
return preg_replace_callback('#([_A-Za-z0-9+-+]+(?:\.[_A-Za-z0-9+-]+)*@[A-Za-z0-9-]+(?:\.[A-Za-z0-9-]+)*)#',
create_function('$matches', '$Html = new HtmlHelper(); $Html->tags = $Html->loadConfig(); return $Html->linkEmail($matches[0], $matches[0],' . $options . ');'), $text);
}
/**
* Convert all links and email adresses to HTML links.
*
* @param string $text Text
* @param array $htmlOptions Array of HTML options.
* @return string The text with links
*/
function autoLink($text, $htmlOptions = array()) {
return $this->autoLinkEmails($this->autoLinkUrls($text, $htmlOptions), $htmlOptions);
}
/**
* Truncates text.
*
* Cuts a string to the length of $length and replaces the last characters
* with the ending if the text is longer than length.
*
* @param string $text String to truncate.
* @param integer $length Length of returned string, including ellipsis.
* @param string $ending Ending to be appended to the trimmed string.
* @param boolean $exact If false, $test will not be cut mid-word
* @return string Trimmed string.
*/
function truncate($text, $length = 100, $ending = '...', $exact = true) {
if (strlen($text) <= $length) {
return $text;
} else {
$truncate = substr($text, 0, $length - strlen($ending));
if (!$exact) {
$spacepos = strrpos($truncate, ' ');
if (isset($spacepos)) {
return substr($truncate, 0, $spacepos) . $ending;
}
}
return $truncate . $ending;
}
}
/**
* Alias for truncate().
*
* @see TextHelper::truncate()
*/
function trim() {
$args = func_get_args();
return call_user_func_array(array(&$this, 'truncate'), $args);
}
/**
* Extracts an excerpt from the text surrounding the phrase with a number of characters on each side determined by radius.
*
* @param string $text String to search the phrase in
* @param string $phrase Phrase that will be searched for
* @param integer $radius The amount of characters that will be returned on each side of the founded phrase
* @param string $ending Ending that will be appended
* @return string Enter description here...
*/
function excerpt($text, $phrase, $radius = 100, $ending = "...") {
if (empty($text) or empty($phrase)) {
return $this->truncate($text, $radius * 2, $ending);
}
if ($radius < strlen($phrase)) {
$radius = strlen($phrase);
}
$pos = strpos($text, $phrase);
$startPos = $pos <= $radius ? 0 : $pos - $radius;
$endPos = $pos + strlen($phrase) + $radius >= strlen($text) ? strlen($text) : $pos + strlen($phrase) + $radius;
$excerpt = substr($text, $startPos, $endPos - $startPos);
if ($startPos != 0) {
$excerpt = substr_replace($excerpt, $ending, 0, strlen($phrase));
}
if ($endPos != strlen($text)) {
$excerpt = substr_replace($excerpt, $ending, -strlen($phrase));
}
return $excerpt;
}
/**
* Creates a comma separated list where the last two items are joined with 'and', forming natural English
*
* @param array $list The list to be joined
* @return string
*/
function toList($list) {
$r = '';
$c = count($list) - 1;
foreach ($list as $i => $item) {
$r .= $item;
if ($c > 0 && $i < $c)
{
$r .= ($i < $c - 1 ? ', ' : ' and ');
}
}
return $r;
}
/**
* Text-to-html parser, similar to Textile or RedCloth, only with a little different syntax.
*
* @param string $text String to "flay"
* @param boolean $allowHtml Set to true if if html is allowed
* @return string "Flayed" text
* @todo Change this. We need a real Textile parser.
*/
function flay($text, $allowHtml = false) {
if (!class_exists('Flay')) {
uses('flay');
}
return Flay::toHtml($text, false, $allowHtml);
}
}
?>