General purpose inflector class that {@link #pluralize pluralizes}, {@link #singularize singularizes} and - * {@link #ordinalize ordinalizes} words. Sample usage:
- * -
-//turning singular words into plurals
-Ext.util.Inflector.pluralize('word'); //'words'
-Ext.util.Inflector.pluralize('person'); //'people'
-Ext.util.Inflector.pluralize('sheep'); //'sheep'
-
-//turning plurals into singulars
-Ext.util.Inflector.singularize('words'); //'word'
-Ext.util.Inflector.singularize('people'); //'person'
-Ext.util.Inflector.singularize('sheep'); //'sheep'
-
-//ordinalizing numbers
-Ext.util.Inflector.ordinalize(11); //"11th"
-Ext.util.Inflector.ordinalize(21); //"21th"
-Ext.util.Inflector.ordinalize(1043); //"1043rd"
-Customization
- * - *The Inflector comes with a default set of US English pluralization rules. These can be augmented with additional + * General purpose inflector class that {@link #pluralize pluralizes}, {@link #singularize singularizes} and + * {@link #ordinalize ordinalizes} words. Sample usage: + * + * //turning singular words into plurals + * Ext.util.Inflector.pluralize('word'); //'words' + * Ext.util.Inflector.pluralize('person'); //'people' + * Ext.util.Inflector.pluralize('sheep'); //'sheep' + * + * //turning plurals into singulars + * Ext.util.Inflector.singularize('words'); //'word' + * Ext.util.Inflector.singularize('people'); //'person' + * Ext.util.Inflector.singularize('sheep'); //'sheep' + * + * //ordinalizing numbers + * Ext.util.Inflector.ordinalize(11); //"11th" + * Ext.util.Inflector.ordinalize(21); //"21th" + * Ext.util.Inflector.ordinalize(1043); //"1043rd" + * + * # Customization + * + * The Inflector comes with a default set of US English pluralization rules. These can be augmented with additional * rules if the default rules do not meet your application's requirements, or swapped out entirely for other languages. - * Here is how we might add a rule that pluralizes "ox" to "oxen":
- * -
-Ext.util.Inflector.plural(/^(ox)$/i, "$1en");
-Each rule consists of two items - a regular expression that matches one or more rules, and a replacement string. - * In this case, the regular expression will only match the string "ox", and will replace that match with "oxen". - * Here's how we could add the inverse rule:
- * -
-Ext.util.Inflector.singular(/^(ox)en$/i, "$1");
-Note that the ox/oxen rules are present by default.
- * - * @singleton + * Here is how we might add a rule that pluralizes "ox" to "oxen": + * + * Ext.util.Inflector.plural(/^(ox)$/i, "$1en"); + * + * Each rule consists of two items - a regular expression that matches one or more rules, and a replacement string. In + * this case, the regular expression will only match the string "ox", and will replace that match with "oxen". Here's + * how we could add the inverse rule: + * + * Ext.util.Inflector.singular(/^(ox)en$/i, "$1"); + * + * Note that the ox/oxen rules are present by default. */ - Ext.define('Ext.util.Inflector', { /* Begin Definitions */ @@ -71,8 +60,7 @@ Ext.define('Ext.util.Inflector', { * The registered plural tuples. Each item in the array should contain two items - the first must be a regular * expression that matchers the singular form of a word, the second must be a String that replaces the matched * part of the regular expression. This is managed by the {@link #plural} method. - * @property plurals - * @type Array + * @property {Array} plurals */ plurals: [ [(/(quiz)$/i), "$1zes" ], @@ -96,14 +84,13 @@ Ext.define('Ext.util.Inflector', { [(/s$/i), "s" ], [(/$/), "s" ] ], - + /** * @private - * The set of registered singular matchers. Each item in the array should contain two items - the first must be a - * regular expression that matches the plural form of a word, the second must be a String that replaces the + * The set of registered singular matchers. Each item in the array should contain two items - the first must be a + * regular expression that matches the plural form of a word, the second must be a String that replaces the * matched part of the regular expression. This is managed by the {@link #singular} method. - * @property singulars - * @type Array + * @property {Array} singulars */ singulars: [ [(/(quiz)zes$/i), "$1" ], @@ -132,12 +119,11 @@ Ext.define('Ext.util.Inflector', { [(/people$/i), "person" ], [(/s$/i), "" ] ], - + /** * @private * The registered uncountable words - * @property uncountable - * @type Array + * @property {String[]} uncountable */ uncountable: [ "sheep", @@ -154,7 +140,7 @@ Ext.define('Ext.util.Inflector', { "deer", "means" ], - + /** * Adds a new singularization rule to the Inflector. See the intro docs for more information * @param {RegExp} matcher The matcher regex @@ -163,7 +149,7 @@ Ext.define('Ext.util.Inflector', { singular: function(matcher, replacer) { this.singulars.unshift([matcher, replacer]); }, - + /** * Adds a new pluralization rule to the Inflector. See the intro docs for more information * @param {RegExp} matcher The matcher regex @@ -172,21 +158,21 @@ Ext.define('Ext.util.Inflector', { plural: function(matcher, replacer) { this.plurals.unshift([matcher, replacer]); }, - + /** * Removes all registered singularization rules */ clearSingulars: function() { this.singulars = []; }, - + /** * Removes all registered pluralization rules */ clearPlurals: function() { this.plurals = []; }, - + /** * Returns true if the given word is transnumeral (the word is its own singular and plural form - e.g. sheep, fish) * @param {String} word The word to test @@ -209,19 +195,19 @@ Ext.define('Ext.util.Inflector', { var plurals = this.plurals, length = plurals.length, tuple, regex, i; - + for (i = 0; i < length; i++) { tuple = plurals[i]; regex = tuple[0]; - + if (regex == word || (regex.test && regex.test(word))) { return word.replace(regex, tuple[1]); } } - + return word; }, - + /** * Returns the singularized form of a word (e.g. Ext.util.Inflector.singularize('words') returns 'word') * @param {String} word The word to singularize @@ -235,21 +221,21 @@ Ext.define('Ext.util.Inflector', { var singulars = this.singulars, length = singulars.length, tuple, regex, i; - + for (i = 0; i < length; i++) { tuple = singulars[i]; regex = tuple[0]; - + if (regex == word || (regex.test && regex.test(word))) { return word.replace(regex, tuple[1]); } } - + return word; }, - + /** - * Returns the correct {@link Ext.data.Model Model} name for a given string. Mostly used internally by the data + * Returns the correct {@link Ext.data.Model Model} name for a given string. Mostly used internally by the data * package * @param {String} word The word to classify * @return {String} The classified version of the word @@ -257,9 +243,9 @@ Ext.define('Ext.util.Inflector', { classify: function(word) { return Ext.String.capitalize(this.singularize(word)); }, - + /** - * Ordinalizes a given number by adding a prefix such as 'st', 'nd', 'rd' or 'th' based on the last digit of the + * Ordinalizes a given number by adding a prefix such as 'st', 'nd', 'rd' or 'th' based on the last digit of the * number. 21 -> 21st, 22 -> 22nd, 23 -> 23rd, 24 -> 24th etc * @param {Number} number The number to ordinalize * @return {String} The ordinalized number @@ -268,7 +254,7 @@ Ext.define('Ext.util.Inflector', { var parsed = parseInt(number, 10), mod10 = parsed % 10, mod100 = parsed % 100; - + //11 through 13 are a special case if (11 <= mod100 && mod100 <= 13) { return number + "th"; @@ -317,7 +303,7 @@ Ext.define('Ext.util.Inflector', { vita: 'vitae' }, singular; - + for (singular in irregulars) { this.plural(singular, irregulars[singular]); this.singular(irregulars[singular], singular);