^Status|Draft|
^Todo|Proof read|

====== Inflector Helper ======

Provides methods for working with the pluralization and singularization of words as well as other methods to work with phrases.

===== Methods =====


==== uncountable() ====
''uncountable($string)'' checks whether the given string is an uncountable word. Returns TRUE or FALSE. This method uses a words list from the inflector.php file, located into the system/config folder 

  * [string] word to check

<code php>
inflector::uncountable('money'); //returns TRUE
inflector::uncountable('book'); //returns FALSE
</code>

==== singular() ====
''singular($str, $count = NULL)'' will attempt to singularize the given string. Returns the string. If a string is uncountable it will return the string without modification. 

__Note__: this function works for English words only.

  * [string] word to singularize
  * [integer] number of things - default NULL

<code php>
inflector::singular('books'); //returns 'book'
inflector::singular('books',0); //returns 'books'
</code>

==== plural() ====
''plural($str, $count = NULL)'' will attempt to pluralize the given string. Returns the string. If a string is uncountable it will return the string without modification. 

__Note__: this function works for English words only.

  * [string] word to pluralize
  * [integer] number of things - default NULL

<code php>
inflector::plural('book'); //returns 'books'
inflector::plural('book',1); //returns 'book'
</code>

==== camelize() ====
''camelize($str)'' will attempt to camelize the given string. Returns the string. 

  * [string] phrase to camelize

<code php>

inflector::camelize('system_initialization'); //returns 'systemInitialization'
inflector::camelize('system initialization'); //returns 'systemInitialization'

</code>

==== underscore() ====
''underscore($str)'' makes a phrase underscored instead of spaced. Returns the string.

  * [string] phrase to underscore

<code php>
inflector::underscore('Underscores a phrase.'); //returns Underscores_a_phrase.'
</code>

==== humanize() ====
''humanize($str)'' makes a phrase human-readable instead of dashed or underscored. Returns the string. 

  * [string] phrase to make human-readable

<code php>
inflector::humanize('Remove_underscores_from_a_phrase.'); //returns 'Remove underscores from a phrase.'
inflector::humanize('Remove-dashes-from-a-phrase.'); //returns 'Remove dashes from a phrase.'
</code>