Yahoo! UI Library

unicode  3.3.0pr1

Yahoo! UI Library > unicode > Unicode.AccentFold
Search:
 
Filters

static Class Unicode.AccentFold

Provides a basic Unicode accent folding implementation that converts common accented letters (like "รก") to their non-accented forms (like "a").

This implementation is not comprehensive, and should only be used as a last resort when accent folding can't be done on the server. A comprehensive accent folding implementation would require much more character data to be sent to the browser, resulting in a significant performance penalty. This implementation strives for a compromise between usefulness and performance.

Accent folding is a destructive operation that can't be reversed, and may change or destroy the actual meaning of the text depending on the language. It should not be used on strings that will later be displayed to a user, unless this is done with the understanding that linguistic meaning may be lost and that you may in fact confuse or insult the user by doing so.

Methods

canFold

static Boolean canFold ( string )
Returns true if the specified string contains one or more characters that can be folded, false otherwise.
Parameters:
string <String> String to test.

compare

static Boolean compare ( a , b , func )
Compares the accent-folded versions of two strings and returns true if they're the same, false otherwise. If a custom comparison function is supplied, the accent-folded strings will be passed to that function for comparison.
Parameters:
a <String> First string to compare.
b <String> Second string to compare.
func <Function> (optional) Custom comparison function. Should return a truthy or falsy value.
Returns: Boolean
Results of the comparison.

filter

static Array filter ( haystack , func )

Returns a copy of haystack containing only the strings for which the supplied function returns true.

While comparisons will be made using accent-folded strings, the returned array of matches will contain the original strings that were passed in.

Parameters:
haystack <Array> Array of strings to filter.
func <Function> Comparison function. Will receive an accent-folded haystack string as an argument, and should return a truthy or falsy value.
Returns: Array
Filtered copy of haystack.

fold

static String|Array fold ( input )
Accent-folds the specified string or array of strings and returns a copy in which common accented letters have been converted to their closest non-accented, lowercase forms.
Parameters:
input <String|Array> String or array of strings to be folded.
Returns: String|Array
Folded string or array of strings.


Copyright © 2010 Yahoo! Inc. All rights reserved.