Ext JS 4.0.7 Sencha Docs

Ext.util.Inflector

Hierarchy

Ext.Base
Ext.util.Inflector

Files

General purpose inflector class that pluralizes, singularizes and 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, "en");

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, "");

Note that the ox/oxen rules are present by default.

Available since: 4.0.0

Defined By

Properties

Available since: 4.0.0

Ext.util.Inflector
view source
: Arrayprivate
The registered plural tuples. ...

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 plural method.

Defaults to: [[/(quiz)$/i, "zes"], [/^(ox)$/i, "en"], [/([m|l])ouse$/i, "ice"], [/(matr|vert|ind)ix|ex$/i, "ices"], [/(x|ch|ss|sh)$/i, "es"], [/([^aeiouy]|qu)y$/i, "ies"], [/(hive)$/i, "s"], [/(?:([^f])fe|([lr])f)$/i, "ves"], [/sis$/i, "ses"], [/([ti])um$/i, "a"], [/(buffal|tomat|potat)o$/i, "oes"], [/(bu)s$/i, "ses"], [/(alias|status|sex)$/i, "es"], [/(octop|vir)us$/i, "i"], [/(ax|test)is$/i, "es"], [/^person$/, "people"], [/^man$/, "men"], [/^(child)$/, "ren"], [/s$/i, "s"], [/$/, "s"]]

Available since: 4.0.0

Get the reference to the current class from which this object was instantiated. ...

Get the reference to the current class from which this object was instantiated. Unlike statics, this.self is scope-dependent and it's meant to be used for dynamic inheritance. See statics for a detailed comparison

Ext.define('My.Cat', {
    statics: {
        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'
    },

    constructor: function() {
        alert(this.self.speciesName); / dependent on 'this'

        return this;
    },

    clone: function() {
        return new this.self();
    }
});


Ext.define('My.SnowLeopard', {
    extend: 'My.Cat',
    statics: {
        speciesName: 'Snow Leopard'         // My.SnowLeopard.speciesName = 'Snow Leopard'
    }
});

var cat = new My.Cat();                     // alerts 'Cat'
var snowLeopard = new My.SnowLeopard();     // alerts 'Snow Leopard'

var clone = snowLeopard.clone();
alert(Ext.getClassName(clone));             // alerts 'My.SnowLeopard'

Available since: 4.0.0

Ext.util.Inflector
view source
: Arrayprivate
The set of registered singular matchers. ...

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 singular method.

Defaults to: [[/(quiz)zes$/i, ""], [/(matr)ices$/i, "ix"], [/(vert|ind)ices$/i, "ex"], [/^(ox)en/i, ""], [/(alias|status)es$/i, ""], [/(octop|vir)i$/i, "us"], [/(cris|ax|test)es$/i, "is"], [/(shoe)s$/i, ""], [/(o)es$/i, ""], [/(bus)es$/i, ""], [/([m|l])ice$/i, "ouse"], [/(x|ch|ss|sh)es$/i, ""], [/(m)ovies$/i, "ovie"], [/(s)eries$/i, "eries"], [/([^aeiouy]|qu)ies$/i, "y"], [/([lr])ves$/i, "f"], [/(tive)s$/i, ""], [/(hive)s$/i, ""], [/([^f])ves$/i, "fe"], [/(^analy)ses$/i, "sis"], [/((a)naly|(b)a|(d)iagno|(p)arenthe|(p)rogno|(s)ynop|(t)he)ses$/i, "sis"], [/([ti])a$/i, "um"], [/(n)ews$/i, "ews"], [/people$/i, "person"], [/s$/i, ""]]

Available since: 4.0.0

Ext.util.Inflector
view source
: String[]private
The registered uncountable words ...

The registered uncountable words

Defaults to: ["sheep", "fish", "series", "species", "money", "rice", "information", "equipment", "grass", "mud", "offspring", "deer", "means"]

Available since: 4.0.0

Methods

Defined By

Instance Methods

...

Available since: 4.0.6

Parameters

Returns

Call the original method that was previously overridden with override Ext.define('My.Cat', { constructor: functi...

Call the original method that was previously overridden with override

Ext.define('My.Cat', {
    constructor: function() {
        alert("I'm a cat!");

        return this;
    }
});

My.Cat.override({
    constructor: function() {
        alert("I'm going to be a cat!");

        var instance = this.callOverridden();

        alert("Meeeeoooowwww");

        return instance;
    }
});

var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
                          // alerts "I'm a cat!"
                          // alerts "Meeeeoooowwww"

Available since: 4.0.0

Parameters

  • args : Array/Arguments

    The arguments, either an array or the arguments object

Returns

  • Object

    Returns the result after calling the overridden method

Call the parent's overridden method. ...

Call the parent's overridden method. For example:

Ext.define('My.own.A', {
    constructor: function(test) {
        alert(test);
    }
});

Ext.define('My.own.B', {
    extend: 'My.own.A',

    constructor: function(test) {
        alert(test);

        this.callParent([test + 1]);
    }
});

Ext.define('My.own.C', {
    extend: 'My.own.B',

    constructor: function() {
        alert("Going to call parent's overriden constructor...");

        this.callParent(arguments);
    }
});

var a = new My.own.A(1); // alerts '1'
var b = new My.own.B(1); // alerts '1', then alerts '2'
var c = new My.own.C(2); // alerts "Going to call parent's overriden constructor..."
                         // alerts '2', then alerts '3'

Available since: 4.0.0

Parameters

  • args : Array/Arguments

    The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments)

Returns

  • Object

    Returns the result from the superclass' method

Ext.util.Inflector
view source
( word ) : String
Returns the correct Model name for a given string. ...

Returns the correct Model name for a given string. Mostly used internally by the data package

Available since: 4.0.0

Parameters

  • word : String

    The word to classify

Returns

  • String

    The classified version of the word

Ext.util.Inflector
view source
( )
Removes all registered pluralization rules ...

Removes all registered pluralization rules

Available since: 4.0.0

Ext.util.Inflector
view source
( )
Removes all registered singularization rules ...

Removes all registered singularization rules

Available since: 4.0.0

( config ) : Objectchainableprotected
Initialize configuration for this class. ...

Initialize configuration for this class. a typical example:

Ext.define('My.awesome.Class', {
    // The default config
    config: {
        name: 'Awesome',
        isAwesome: true
    },

    constructor: function(config) {
        this.initConfig(config);

        return this;
    }
});

var awesome = new My.awesome.Class({
    name: 'Super Awesome'
});

alert(awesome.getName()); // 'Super Awesome'

Available since: 4.0.0

Parameters

Returns

  • Object

    mixins The mixin prototypes as key - value pairs

Ext.util.Inflector
view source
( word ) : Boolean
Returns true if the given word is transnumeral (the word is its own singular and plural form - e.g. ...

Returns true if the given word is transnumeral (the word is its own singular and plural form - e.g. sheep, fish)

Available since: 4.0.0

Parameters

  • word : String

    The word to test

Returns

  • Boolean

    True if the word is transnumeral

( name, cls )private
Used internally by the mixins pre-processor ...

Used internally by the mixins pre-processor

Available since: 4.0.6

Parameters

Ext.util.Inflector
view source
( number ) : String
Ordinalizes a given number by adding a prefix such as 'st', 'nd', 'rd' or 'th' based on the last digit of the number. ...

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

Available since: 4.0.0

Parameters

  • number : Number

    The number to ordinalize

Returns

( name, value )private
...

Available since: 4.0.6

Parameters

( name, fn )private
...

Available since: 4.0.0

Parameters

Ext.util.Inflector
view source
( matcher, replacer )
Adds a new pluralization rule to the Inflector. ...

Adds a new pluralization rule to the Inflector. See the intro docs for more information

Available since: 4.0.0

Parameters

  • matcher : RegExp

    The matcher regex

  • replacer : String

    The replacement string, which can reference matches from the matcher argument

Ext.util.Inflector
view source
( word ) : String
Returns the pluralized form of a word (e.g. ...

Returns the pluralized form of a word (e.g. Ext.util.Inflector.pluralize('word') returns 'words')

Available since: 4.0.0

Parameters

  • word : String

    The word to pluralize

Returns

  • String

    The pluralized form of the word

( config ) : Ext.Basechainableprivate
...

Available since: 4.0.0

Parameters

Returns

Ext.util.Inflector
view source
( matcher, replacer )
Adds a new singularization rule to the Inflector. ...

Adds a new singularization rule to the Inflector. See the intro docs for more information

Available since: 4.0.0

Parameters

  • matcher : RegExp

    The matcher regex

  • replacer : String

    The replacement string, which can reference matches from the matcher argument

Ext.util.Inflector
view source
( word ) : String
Returns the singularized form of a word (e.g. ...

Returns the singularized form of a word (e.g. Ext.util.Inflector.singularize('words') returns 'word')

Available since: 4.0.0

Parameters

  • word : String

    The word to singularize

Returns

  • String

    The singularized form of the word

Get the reference to the class from which this object was instantiated. ...

Get the reference to the class from which this object was instantiated. Note that unlike self, this.statics() is scope-independent and it always returns the class from which it was called, regardless of what this points to during run-time

Ext.define('My.Cat', {
    statics: {
        totalCreated: 0,
        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'
    },

    constructor: function() {
        var statics = this.statics();

        alert(statics.speciesName);     // always equals to 'Cat' no matter what 'this' refers to
                                        // equivalent to: My.Cat.speciesName

        alert(this.self.speciesName);   // dependent on 'this'

        statics.totalCreated++;

        return this;
    },

    clone: function() {
        var cloned = new this.self;                      // dependent on 'this'

        cloned.groupName = this.statics().speciesName;   // equivalent to: My.Cat.speciesName

        return cloned;
    }
});


Ext.define('My.SnowLeopard', {
    extend: 'My.Cat',

    statics: {
        speciesName: 'Snow Leopard'     // My.SnowLeopard.speciesName = 'Snow Leopard'
    },

    constructor: function() {
        this.callParent();
    }
});

var cat = new My.Cat();                 // alerts 'Cat', then alerts 'Cat'

var snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'

var clone = snowLeopard.clone();
alert(Ext.getClassName(clone));         // alerts 'My.SnowLeopard'
alert(clone.groupName);                 // alerts 'Cat'

alert(My.Cat.totalCreated);             // alerts 3

Available since: 4.0.0

Returns

Defined By

Static Methods

( members ) : Ext.Basechainablestatic
Add / override static properties of this class. ...

Add / override static properties of this class.

Ext.define('My.cool.Class', {
    ...
});

My.cool.Class.addStatics({
    someProperty: 'someValue',      // My.cool.Class.someProperty = 'someValue'
    method1: function() { ... },    // My.cool.Class.method1 = function() { ... };
    method2: function() { ... }     // My.cool.Class.method2 = function() { ... };
});

Available since: 4.0.2

Parameters

Returns

( fromClass, members ) : Ext.Basechainablestatic
Borrow another class' members to the prototype of this class. ...

Borrow another class' members to the prototype of this class.

Ext.define('Bank', {
    money: '$$$',
    printMoney: function() {
        alert('$$$$$$$');
    }
});

Ext.define('Thief', {
    ...
});

Thief.borrow(Bank, ['money', 'printMoney']);

var steve = new Thief();

alert(steve.money); // alerts '$$$'
steve.printMoney(); // alerts '$$$$$$$'

Available since: 4.0.2

Parameters

  • fromClass : Ext.Base

    The class to borrow members from

  • members : String/String[]

    The names of the members to borrow

Returns

Create a new instance of this Class. ...

Create a new instance of this Class.

Ext.define('My.cool.Class', {
    ...
});

My.cool.Class.create({
    someConfig: true
});

All parameters are passed to the constructor of the class.

Available since: 4.0.2

Returns

( alias, origin )static
Create aliases for existing prototype methods. ...

Create aliases for existing prototype methods. Example:

Ext.define('My.cool.Class', {
    method1: function() { ... },
    method2: function() { ... }
});

var test = new My.cool.Class();

My.cool.Class.createAlias({
    method3: 'method1',
    method4: 'method2'
});

test.method3(); // test.method1()

My.cool.Class.createAlias('method5', 'method3');

test.method5(); // test.method3() -> test.method1()

Available since: 4.0.2

Parameters

Get the current class' name in string format. ...

Get the current class' name in string format.

Ext.define('My.cool.Class', {
    constructor: function() {
        alert(this.self.getName()); // alerts 'My.cool.Class'
    }
});

My.cool.Class.getName(); // 'My.cool.Class'

Available since: 4.0.4

Returns

Add methods / properties to the prototype of this class. ...

Add methods / properties to the prototype of this class.

Ext.define('My.awesome.Cat', {
    constructor: function() {
        ...
    }
});

 My.awesome.Cat.implement({
     meow: function() {
        alert('Meowww...');
     }
 });

 var kitty = new My.awesome.Cat;
 kitty.meow();

Available since: 4.0.2

Parameters

( members ) : Ext.Basechainablestatic
Override prototype members of this class. ...

Override prototype members of this class. Overridden methods can be invoked via callOverridden

Ext.define('My.Cat', {
    constructor: function() {
        alert("I'm a cat!");

        return this;
    }
});

My.Cat.override({
    constructor: function() {
        alert("I'm going to be a cat!");

        var instance = this.callOverridden();

        alert("Meeeeoooowwww");

        return instance;
    }
});

var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
                          // alerts "I'm a cat!"
                          // alerts "Meeeeoooowwww"

Available since: 4.0.2

Parameters

Returns