CFLib.org – abbreviate

abbreviate(string, len)

Last updated September 6, 2005

author

Version: 3 | Requires: ColdFusion 5 | Library: StrLib

Rated 4 time(s). Average Rating: 3.8

Description:
Similar to the MaxLength UDF, but designed for outputting abbreviated lengths of HTML code (e.g. in list tables). Strips all tags, and makes sure any abbreviation is done to the last space within the given length. Also appends a properly escaped ellipsis character to the returned string.

Return Values:
Returns a string.

Example:

<cfoutput>
#abbreviate("<p>This bit of HTML copy is going to get <em>real</em> chopped up!</p>", 40)#
</cfoutput>

Parameters:

Name	Description	Required
string	String to use.	Yes
len	Length to use.	Yes

Full UDF Source:

	
	<cfscript>
/**
 * Abbreviates a given string to roughly the given length, stripping any tags, making sure the ending doesn't chop a word in two, and adding an ellipsis character at the end.
 * Fix by Patrick McElhaney
 * v3 by Ken Fricklas kenf@accessnet.net, takes care of too many spaces in text.
 * 
 * @param string      String to use. (Required)
 * @param len      Length to use. (Required)
 * @return Returns a string. 
 * @author Gyrus (kenf@accessnet.netgyrus@norlonto.net) 
 * @version 3, September 6, 2005 
 */
function abbreviate(string,len) {
    var newString = REReplace(string, "<[^>]*>", " ", "ALL");
    var lastSpace = 0;
    newString = REReplace(newString, " \s*", " ", "ALL");
    if (len(newString) gt len) {
        newString = left(newString, len-2);
        lastSpace = find(" ", reverse(newString));
        lastSpace = len(newString) - lastSpace;
        newString = left(newString, lastSpace) & "  &##8230;";
    }    
    return newString;
}
</cfscript>