docs/api/Ext.util.Inflector.html

   1 <!DOCTYPE html><html><head><title>Ext.util.Inflector | Ext JS 4.0 Documentation</title><script type="text/javascript" src="../ext-all.js"></script><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../scrollbars.css" type="text/css"><link rel="stylesheet" href="../docs.css" type="text/css"><link id="styleCss" rel="stylesheet" href="../style.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script><link rel="stylesheet" href="../prettify.css" type="text/css"><!-- link(rel: 'stylesheet', href: req.baseURL + '/css/ext4.css', type: 'text/css')--><link rel="shortcut icon" type="image/ico" href="../favicon.ico"><!--[if IE]>
   2 <style type="text/css">.head-band { display: none; }
   3 .header { border: 0; top: 0; left: 0px; background: url(../header.gif) repeat-x; }
   4 .doc-tab .members .member a.more { background-color: #efefef; }
   5 </style><link rel="stylesheet" href="/new/css/ie.css" type="text/css"><![endif]-->
   6 </head><body id="ext-body" class="iScroll"><div id="notice" class="notice">For up to date documentation and features, visit
   7 <a href="http://docs.sencha.com/ext-js/4-0">http://docs.sencha.com/ext-js/4-0</a></div><div class="wrapper"><div class="head-band"></div><div class="header"><h2><a href="../index.html">Sencha Documentation</a></h2></div><div id="search"><form><input type="text" placeholder="Search" id="search-field" autocomplete="off" name="q"></form><div id="search-box"></div></div><div id="treePanel"></div><div id="container"><script type="text/javascript">
   8
   9     req = {
  10         liveURL: '.',
  11         standAloneMode: true,
  12         origDocClass: 'Ext.util.Inflector',
  13         docClass: 'Ext.util.Inflector',
  14         docReq: 'Ext.util.Inflector',
  15         version: '4.0',
  16         baseURL: '.',
  17         baseDocURL: '.',
  18         baseProdURL: '.'
  19     };
  20
  21     clsInfo = {};
  22
  23
  24
  25 </script>
  26
  27 <script type="text/javascript" src="../search.js"></script>
  28 <!--script type="text/javascript" src="/new/javascripts/app/examples.js"></script-->
  29 <script type="text/javascript" src="../class_tree.js"></script>
  30 <script type="text/javascript" src="../class_doc.js"></script>
  31 <script type="text/javascript">
  32     req.source = 'Inflector.html#Ext-util.Inflector';
  33     clsInfo = {"methods":["classify","clearPlurals","clearSingulars","isTransnumeral","ordinalize","plural","pluralize","singular","singularize"],"cfgs":[],"properties":[],"events":[],"subclasses":[]};
  34     Ext.onReady(function() {
  35         Ext.create('Docs.classPanel');
  36     });
  37 </script><div id="top-block" class="top-block"><h1 id="clsTitle" class="cls"><a href="../source/Inflector.html#Ext-util.Inflector" target="_blank">Ext.util.Inflector</a></h1></div><div id="docContent"><div id="doc-overview-content"><div class="lft"><p>General purpose inflector class that <a href="Ext.util.Inflector.html#pluralize" rel="Ext.util.Inflector#pluralize" class="docClass">pluralizes</a>, <a href="Ext.util.Inflector.html#singularize" rel="Ext.util.Inflector#singularize" class="docClass">singularizes</a> and
  38 <a href="Ext.util.Inflector.html#ordinalize" rel="Ext.util.Inflector#ordinalize" class="docClass">ordinalizes</a> words. Sample usage:</p>
  39
  40
  41
  42
  43 <pre class="prettyprint"><code>//turning singular words into plurals
  44 Ext.util.Inflector.pluralize('word'); //'words'
  45 Ext.util.Inflector.pluralize('person'); //'people'
  46 Ext.util.Inflector.pluralize('sheep'); //'sheep'
  47
  48 //turning plurals into singulars
  49 Ext.util.Inflector.singularize('words'); //'word'
  50 Ext.util.Inflector.singularize('people'); //'person'
  51 Ext.util.Inflector.singularize('sheep'); //'sheep'
  52
  53 //ordinalizing numbers
  54 Ext.util.Inflector.ordinalize(11); //"11th"
  55 Ext.util.Inflector.ordinalize(21); //"21th"
  56 Ext.util.Inflector.ordinalize(1043); //"1043rd"
  57 </code></pre>
  58
  59
  60
  61
  62 <p><u>Customization</u></p>
  63
  64
  65
  66
  67 <p>The Inflector comes with a default set of US English pluralization rules. These can be augmented with additional
  68 rules if the default rules do not meet your application's requirements, or swapped out entirely for other languages.
  69 Here is how we might add a rule that pluralizes "ox" to "oxen":</p>
  70
  71
  72
  73
  74 <pre class="prettyprint"><code>Ext.util.Inflector.plural(/^(ox)$/i, "$1en");
  75 </code></pre>
  76
  77
  78
  79
  80 <p>Each rule consists of two items - a regular expression that matches one or more rules, and a replacement string.
  81 In this case, the regular expression will only match the string "ox", and will replace that match with "oxen".
  82 Here's how we could add the inverse rule:</p>
  83
  84
  85
  86
  87 <pre class="prettyprint"><code>Ext.util.Inflector.singular(/^(ox)en$/i, "$1");
  88 </code></pre>
  89
  90
  91
  92
  93 <p>Note that the ox/oxen rules are present by default.</p>
  94
  95 <div class="members"><div class="m-methods"><a name="methods"></a><div class="definedBy">Defined By</div><h3 class="mth p">Methods</h3><div id="method-classify" class="member f ni"><a href="Ext.util.Inflector.html#method-classify" rel="method-classify" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Inflector.html" class="definedIn docClass">Ext.util.Inflector</a><br/><a href="../source/Inflector.html#Ext-util.Inflector-method-classify" class="viewSource">view source</a></div><a name="classify"></a><a name="method-classify"></a><a href="Ext.util.Inflector.html#" rel="method-classify" class="cls expand">classify</a>(
  96 <span class="pre">String word</span>)
  97  : String</div><div class="description"><div class="short"><p>Returns the correct <a href="Ext.data.Model.html" rel="Ext.data.Model" class="docClass">Model</a> name for a given string. Mostly used internally by the data
  98 package</p>
  99 </div><div class="long"><p>Returns the correct <a href="Ext.data.Model.html" rel="Ext.data.Model" class="docClass">Model</a> name for a given string. Mostly used internally by the data
 100 package</p>
 101 <h3 class="pa">Parameters</h3><ul><li><span class="pre">word</span> : String<div class="sub-desc"><p>The word to classify</p>
 102 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">String</span>&nbsp; &nbsp;<p>The classified version of the word</p>
 103 </li></ul></div></div></div><div id="method-clearPlurals" class="member ni"><a href="Ext.util.Inflector.html#method-clearPlurals" rel="method-clearPlurals" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Inflector.html" class="definedIn docClass">Ext.util.Inflector</a><br/><a href="../source/Inflector.html#Ext-util.Inflector-method-clearPlurals" class="viewSource">view source</a></div><a name="clearPlurals"></a><a name="method-clearPlurals"></a><a href="Ext.util.Inflector.html#" rel="method-clearPlurals" class="cls expand">clearPlurals</a> : void</div><div class="description"><div class="short"><p>Removes all registered pluralization rules</p>
 104 </div><div class="long"><p>Removes all registered pluralization rules</p>
 105 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 106 </li></ul></div></div></div><div id="method-clearSingulars" class="member ni"><a href="Ext.util.Inflector.html#method-clearSingulars" rel="method-clearSingulars" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Inflector.html" class="definedIn docClass">Ext.util.Inflector</a><br/><a href="../source/Inflector.html#Ext-util.Inflector-method-clearSingulars" class="viewSource">view source</a></div><a name="clearSingulars"></a><a name="method-clearSingulars"></a><a href="Ext.util.Inflector.html#" rel="method-clearSingulars" class="cls expand">clearSingulars</a> : void</div><div class="description"><div class="short"><p>Removes all registered singularization rules</p>
 107 </div><div class="long"><p>Removes all registered singularization rules</p>
 108 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 109 </li></ul></div></div></div><div id="method-isTransnumeral" class="member ni"><a href="Ext.util.Inflector.html#method-isTransnumeral" rel="method-isTransnumeral" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Inflector.html" class="definedIn docClass">Ext.util.Inflector</a><br/><a href="../source/Inflector.html#Ext-util.Inflector-method-isTransnumeral" class="viewSource">view source</a></div><a name="isTransnumeral"></a><a name="method-isTransnumeral"></a><a href="Ext.util.Inflector.html#" rel="method-isTransnumeral" class="cls expand">isTransnumeral</a>(
 110 <span class="pre">String word</span>)
 111  : Boolean</div><div class="description"><div class="short"><p>Returns true if the given word is transnumeral (the word is its own singular and plural form - e.g. sheep, fish)</p>
 112 </div><div class="long"><p>Returns true if the given word is transnumeral (the word is its own singular and plural form - e.g. sheep, fish)</p>
 113 <h3 class="pa">Parameters</h3><ul><li><span class="pre">word</span> : String<div class="sub-desc"><p>The word to test</p>
 114 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>True if the word is transnumeral</p>
 115 </li></ul></div></div></div><div id="method-ordinalize" class="member ni"><a href="Ext.util.Inflector.html#method-ordinalize" rel="method-ordinalize" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Inflector.html" class="definedIn docClass">Ext.util.Inflector</a><br/><a href="../source/Inflector.html#Ext-util.Inflector-method-ordinalize" class="viewSource">view source</a></div><a name="ordinalize"></a><a name="method-ordinalize"></a><a href="Ext.util.Inflector.html#" rel="method-ordinalize" class="cls expand">ordinalize</a>(
 116 <span class="pre">Number number</span>)
 117  : String</div><div class="description"><div class="short">Ordinalizes a given number by adding a prefix such as 'st', 'nd', 'rd' or 'th' based on the last digit of the
 118 number....</div><div class="long"><p>Ordinalizes a given number by adding a prefix such as 'st', 'nd', 'rd' or 'th' based on the last digit of the
 119 number. 21 -> 21st, 22 -> 22nd, 23 -> 23rd, 24 -> 24th etc</p>
 120 <h3 class="pa">Parameters</h3><ul><li><span class="pre">number</span> : Number<div class="sub-desc"><p>The number to ordinalize</p>
 121 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">String</span>&nbsp; &nbsp;<p>The ordinalized number</p>
 122 </li></ul></div></div></div><div id="method-plural" class="member ni"><a href="Ext.util.Inflector.html#method-plural" rel="method-plural" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Inflector.html" class="definedIn docClass">Ext.util.Inflector</a><br/><a href="../source/Inflector.html#Ext-util.Inflector-method-plural" class="viewSource">view source</a></div><a name="plural"></a><a name="method-plural"></a><a href="Ext.util.Inflector.html#" rel="method-plural" class="cls expand">plural</a>(
 123 <span class="pre">RegExp matcher, String replacer</span>)
 124  : void</div><div class="description"><div class="short"><p>Adds a new pluralization rule to the Inflector. See the intro docs for more information</p>
 125 </div><div class="long"><p>Adds a new pluralization rule to the Inflector. See the intro docs for more information</p>
 126 <h3 class="pa">Parameters</h3><ul><li><span class="pre">matcher</span> : RegExp<div class="sub-desc"><p>The matcher regex</p>
 127 </div></li><li><span class="pre">replacer</span> : String<div class="sub-desc"><p>The replacement string, which can reference matches from the matcher argument</p>
 128 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 129 </li></ul></div></div></div><div id="method-pluralize" class="member ni"><a href="Ext.util.Inflector.html#method-pluralize" rel="method-pluralize" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Inflector.html" class="definedIn docClass">Ext.util.Inflector</a><br/><a href="../source/Inflector.html#Ext-util.Inflector-method-pluralize" class="viewSource">view source</a></div><a name="pluralize"></a><a name="method-pluralize"></a><a href="Ext.util.Inflector.html#" rel="method-pluralize" class="cls expand">pluralize</a>(
 130 <span class="pre">String word</span>)
 131  : String</div><div class="description"><div class="short"><p>Returns the pluralized form of a word (e.g. Ext.util.Inflector.pluralize('word') returns 'words')</p>
 132 </div><div class="long"><p>Returns the pluralized form of a word (e.g. Ext.util.Inflector.pluralize('word') returns 'words')</p>
 133 <h3 class="pa">Parameters</h3><ul><li><span class="pre">word</span> : String<div class="sub-desc"><p>The word to pluralize</p>
 134 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">String</span>&nbsp; &nbsp;<p>The pluralized form of the word</p>
 135 </li></ul></div></div></div><div id="method-singular" class="member ni"><a href="Ext.util.Inflector.html#method-singular" rel="method-singular" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Inflector.html" class="definedIn docClass">Ext.util.Inflector</a><br/><a href="../source/Inflector.html#Ext-util.Inflector-method-singular" class="viewSource">view source</a></div><a name="singular"></a><a name="method-singular"></a><a href="Ext.util.Inflector.html#" rel="method-singular" class="cls expand">singular</a>(
 136 <span class="pre">RegExp matcher, String replacer</span>)
 137  : void</div><div class="description"><div class="short"><p>Adds a new singularization rule to the Inflector. See the intro docs for more information</p>
 138 </div><div class="long"><p>Adds a new singularization rule to the Inflector. See the intro docs for more information</p>
 139 <h3 class="pa">Parameters</h3><ul><li><span class="pre">matcher</span> : RegExp<div class="sub-desc"><p>The matcher regex</p>
 140 </div></li><li><span class="pre">replacer</span> : String<div class="sub-desc"><p>The replacement string, which can reference matches from the matcher argument</p>
 141 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 142 </li></ul></div></div></div><div id="method-singularize" class="member ni"><a href="Ext.util.Inflector.html#method-singularize" rel="method-singularize" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Inflector.html" class="definedIn docClass">Ext.util.Inflector</a><br/><a href="../source/Inflector.html#Ext-util.Inflector-method-singularize" class="viewSource">view source</a></div><a name="singularize"></a><a name="method-singularize"></a><a href="Ext.util.Inflector.html#" rel="method-singularize" class="cls expand">singularize</a>(
 143 <span class="pre">String word</span>)
 144  : String</div><div class="description"><div class="short"><p>Returns the singularized form of a word (e.g. Ext.util.Inflector.singularize('words') returns 'word')</p>
 145 </div><div class="long"><p>Returns the singularized form of a word (e.g. Ext.util.Inflector.singularize('words') returns 'word')</p>
 146 <h3 class="pa">Parameters</h3><ul><li><span class="pre">word</span> : String<div class="sub-desc"><p>The word to singularize</p>
 147 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">String</span>&nbsp; &nbsp;<p>The singularized form of the word</p>
 148 </li></ul></div></div></div></div></div></div></div><div id="pageContent"></div></div></div></div></body></html>