Class Inflector

Pluralize and singularize English words.

Inflector pluralizes and singularizes English nouns. Used by Cake's naming conventions throughout the framework.

Package: Cake\Utility
Link: http://book.cakephp.org/2.0/en/core-utility-libraries/inflector.html
Copyright: Copyright 2005-2011, Cake Software Foundation, Inc. (http://cakefoundation.org)
License: License (http://www.opensource.org/licenses/mit-license.php)
Location: Cake/Utility/Inflector.php

Properties summary

$_cache protected static

array

Method cache array.
$_initialState protected static

array

The initial state of Inflector so reset() works.
$_plural protected static

array

Plural inflector rules
$_singular protected static

array

Singular inflector rules
$_transliteration protected static

array

Default map of accented and special characters to ASCII characters
$_uninflected protected static

array

Words that should not be inflected

Method Summary

_cache() protected static

Cache inflected values, and return if already available
camelize() public static

Returns the given lower_case_and_underscored_word as a CamelCased word.
classify() public static

Returns Cake model class name ("Person" for the database table "people".) for given database table.
humanize() public static

Returns the given underscored_word_group as a Human Readable Word Group. (Underscores are replaced by spaces and capitalized following words.)
pluralize() public static

Return $word in plural form.
reset() public static

Clears Inflectors inflected value caches. And resets the inflection rules to the initial values.
rules() public static

Adds custom inflection $rules, of either 'plural', 'singular' or 'transliteration' $type.
singularize() public static

Return $word in singular form.
slug() public static

Returns a string with all spaces converted to underscores (by default), accented characters converted to non-accented characters, and non word characters removed.
tableize() public static

Returns corresponding table name for given model $className. ("people" for the model class "Person").
underscore() public static

Returns the given camelCasedWord as an underscored_word.
variable() public static

Returns camelBacked version of an underscored string.

Method Detail

_cache() protected static ¶

_cache( string $type , string $key , string $value = false )

Cache inflected values, and return if already available

Parameters

string $type: Inflection type
string $key: Original value
string $value optional false: Inflected value

Returns

string
Inflected value, from cache

camelize() public static ¶

camelize( string $lowerCaseAndUnderscoredWord )

Returns the given lower_case_and_underscored_word as a CamelCased word.

Parameters

string $lowerCaseAndUnderscoredWord: Word to camelize

Returns

string
Camelized word. LikeThis.

Link

http://book.cakephp.org/2.0/en/core-utility-libraries/inflector.html#Inflector::camelize

classify() public static ¶

classify( string $tableName )

Returns Cake model class name ("Person" for the database table "people".) for given database table.

Parameters

string $tableName: Name of database table to get class name for

Returns

string
Class name

Link

http://book.cakephp.org/2.0/en/core-utility-libraries/inflector.html#Inflector::classify

humanize() public static ¶

humanize( string $lowerCaseAndUnderscoredWord )

Returns the given underscored_word_group as a Human Readable Word Group. (Underscores are replaced by spaces and capitalized following words.)

Parameters

string $lowerCaseAndUnderscoredWord: String to be made more readable

Returns

string
Human-readable string

Link

http://book.cakephp.org/2.0/en/core-utility-libraries/inflector.html#Inflector::humanize

pluralize() public static ¶

pluralize( string $word )

Return $word in plural form.

Parameters

string $word: Word in singular

Returns

string
Word in plural

Link

http://book.cakephp.org/2.0/en/core-utility-libraries/inflector.html#Inflector::pluralize

reset() public static ¶

reset( )

Clears Inflectors inflected value caches. And resets the inflection rules to the initial values.

rules() public static ¶

rules( string $type , array $rules , boolean $reset = false )

Adds custom inflection $rules, of either 'plural', 'singular' or 'transliteration' $type.

Usage:

{{{ Inflector::rules('plural', array('/^(inflect)or$/i' => '\1ables')); Inflector::rules('plural', array( 'rules' => array('/^(inflect)ors$/i' => '\1ables'), 'uninflected' => array('dontinflectme'), 'irregular' => array('red' => 'redlings') )); Inflector::rules('transliteration', array('/å/' => 'aa')); }}}

Parameters

string $type: The type of inflection, either 'plural', 'singular' or 'transliteration'
array $rules: Array of rules to be added.
boolean $reset optional false: If true, will unset default inflections for all new rules that are being defined in $rules.

singularize() public static ¶

singularize( string $word )

Return $word in singular form.

Parameters

string $word: Word in plural

Returns

string
Word in singular

Link

http://book.cakephp.org/2.0/en/core-utility-libraries/inflector.html#Inflector::singularize

slug() public static ¶

slug( string $string , string $replacement = '_' )

Returns a string with all spaces converted to underscores (by default), accented characters converted to non-accented characters, and non word characters removed.

Parameters

string $string: the string you want to slug
string $replacement optional '_': will replace keys in map

Returns

string

Link

http://book.cakephp.org/2.0/en/core-utility-libraries/inflector.html#Inflector::slug

tableize() public static ¶

tableize( string $className )

Returns corresponding table name for given model $className. ("people" for the model class "Person").

Parameters

string $className: Name of class to get database table name for

Returns

string
Name of the database table for given class

Link

http://book.cakephp.org/2.0/en/core-utility-libraries/inflector.html#Inflector::tableize

underscore() public static ¶

underscore( string $camelCasedWord )

Returns the given camelCasedWord as an underscored_word.

Parameters

string $camelCasedWord: Camel-cased word to be "underscorized"

Returns

string
Underscore-syntaxed version of the $camelCasedWord

Link

http://book.cakephp.org/2.0/en/core-utility-libraries/inflector.html#Inflector::underscore

variable() public static ¶

variable( string $string )

Returns camelBacked version of an underscored string.

Parameters

string $string

Returns

string
in variable form

Link

http://book.cakephp.org/2.0/en/core-utility-libraries/inflector.html#Inflector::variable

Properties detail

`$_cache` ¶

protected static array

Method cache array.

array()

`$_initialState` ¶

protected static array

The initial state of Inflector so reset() works.

array()

`$_plural` ¶

protected static array

Plural inflector rules

array(
    'rules' => array(
        '/(s)tatus$/i' => '\1\2tatuses',
        '/(quiz)$/i' => '\1zes',
        '/^(ox)$/i' => '\1\2en',
        '/([m|l])ouse$/i' => '\1ice',
        '/(matr|vert|ind)(ix|ex)$/i' => '\1ices',
        '/(x|ch|ss|sh)$/i' => '\1es',
        '/([^aeiouy]|qu)y$/i' => '\1ies',
        '/(hive)$/i' => '\1s',
        '/(?:([^f])fe|([lr])f)$/i' => '\1\2ves',
        '/sis$/i' => 'ses',
        '/([ti])um$/i' => '\1a',
        '/(p)erson$/i' => '\1eople',
        '/(m)an$/i' => '\1en',
        '/(c)hild$/i' => '\1hildren',
        '/(buffal|tomat)o$/i' => '\1\2oes',
        '/(alumn|bacill|cact|foc|fung|nucle|radi|stimul|syllab|termin|vir)us$/i' => '\1i',
        '/us$/i' => 'uses',
        '/(alias)$/i' => '\1es',
        '/(ax|cris|test)is$/i' => '\1es',
        '/s$/' => 's',
        '/^$/' => '',
        '/$/' => 's',
    ),
    'uninflected' => array(
        '.*[nrlm]ese', '.*deer', '.*fish', '.*measles', '.*ois', '.*pox', '.*sheep', 'people'
    ),
    'irregular' => array(
        'atlas' => 'atlases',
        'beef' => 'beefs',
        'brother' => 'brothers',
        'cafe' => 'cafes',
        'child' => 'children',
        'corpus' => 'corpuses',
        'cow' => 'cows',
        'ganglion' => 'ganglions',
        'genie' => 'genies',
        'genus' => 'genera',
        'graffito' => 'graffiti',
        'hoof' => 'hoofs',
        'loaf' => 'loaves',
        'man' => 'men',
        'money' => 'monies',
        'mongoose' => 'mongooses',
        'move' => 'moves',
        'mythos' => 'mythoi',
        'niche' => 'niches',
        'numen' => 'numina',
        'occiput' => 'occiputs',
        'octopus' => 'octopuses',
        'opus' => 'opuses',
        'ox' => 'oxen',
        'penis' => 'penises',
        'person' => 'people',
        'sex' => 'sexes',
        'soliloquy' => 'soliloquies',
        'testis' => 'testes',
        'trilby' => 'trilbys',
        'turf' => 'turfs'
    )
)

`$_singular` ¶

protected static array

Singular inflector rules

array(
    'rules' => array(
        '/(s)tatuses$/i' => '\1\2tatus',
        '/^(.*)(menu)s$/i' => '\1\2',
        '/(quiz)zes$/i' => '\\1',
        '/(matr)ices$/i' => '\1ix',
        '/(vert|ind)ices$/i' => '\1ex',
        '/^(ox)en/i' => '\1',
        '/(alias)(es)*$/i' => '\1',
        '/(alumn|bacill|cact|foc|fung|nucle|radi|stimul|syllab|termin|viri?)i$/i' => '\1us',
        '/([ftw]ax)es/i' => '\1',
        '/(cris|ax|test)es$/i' => '\1is',
        '/(shoe|slave)s$/i' => '\1',
        '/(o)es$/i' => '\1',
        '/ouses$/' => 'ouse',
        '/([^a])uses$/' => '\1us',
        '/([m|l])ice$/i' => '\1ouse',
        '/(x|ch|ss|sh)es$/i' => '\1',
        '/(m)ovies$/i' => '\1\2ovie',
        '/(s)eries$/i' => '\1\2eries',
        '/([^aeiouy]|qu)ies$/i' => '\1y',
        '/([lr])ves$/i' => '\1f',
        '/(tive)s$/i' => '\1',
        '/(hive)s$/i' => '\1',
        '/(drive)s$/i' => '\1',
        '/([^fo])ves$/i' => '\1fe',
        '/(^analy)ses$/i' => '\1sis',
        '/(analy|ba|diagno|(p)arenthe|(p)rogno|(s)ynop|(t)he)ses$/i' => '\1\2sis',
        '/([ti])a$/i' => '\1um',
        '/(p)eople$/i' => '\1\2erson',
        '/(m)en$/i' => '\1an',
        '/(c)hildren$/i' => '\1\2hild',
        '/(n)ews$/i' => '\1\2ews',
        '/eaus$/' => 'eau',
        '/^(.*us)$/' => '\\1',
        '/s$/i' => ''
    ),
    'uninflected' => array(
        '.*[nrlm]ese', '.*deer', '.*fish', '.*measles', '.*ois', '.*pox', '.*sheep', '.*ss'
    ),
    'irregular' => array(
        'foes' => 'foe',
        'waves' => 'wave',
        'curves' => 'curve'
    )
)

`$_transliteration` ¶

protected static array

Default map of accented and special characters to ASCII characters

array(
    '/ä|æ|ǽ/' => 'ae',
    '/ö|œ/' => 'oe',
    '/ü/' => 'ue',
    '/Ä/' => 'Ae',
    '/Ü/' => 'Ue',
    '/Ö/' => 'Oe',
    '/À|Á|Â|Ã|Ä|Å|Ǻ|Ā|Ă|Ą|Ǎ/' => 'A',
    '/à|á|â|ã|å|ǻ|ā|ă|ą|ǎ|ª/' => 'a',
    '/Ç|Ć|Ĉ|Ċ|Č/' => 'C',
    '/ç|ć|ĉ|ċ|č/' => 'c',
    '/Ð|Ď|Đ/' => 'D',
    '/ð|ď|đ/' => 'd',
    '/È|É|Ê|Ë|Ē|Ĕ|Ė|Ę|Ě/' => 'E',
    '/è|é|ê|ë|ē|ĕ|ė|ę|ě/' => 'e',
    '/Ĝ|Ğ|Ġ|Ģ/' => 'G',
    '/ĝ|ğ|ġ|ģ/' => 'g',
    '/Ĥ|Ħ/' => 'H',
    '/ĥ|ħ/' => 'h',
    '/Ì|Í|Î|Ï|Ĩ|Ī|Ĭ|Ǐ|Į|İ/' => 'I',
    '/ì|í|î|ï|ĩ|ī|ĭ|ǐ|į|ı/' => 'i',
    '/Ĵ/' => 'J',
    '/ĵ/' => 'j',
    '/Ķ/' => 'K',
    '/ķ/' => 'k',
    '/Ĺ|Ļ|Ľ|Ŀ|Ł/' => 'L',
    '/ĺ|ļ|ľ|ŀ|ł/' => 'l',
    '/Ñ|Ń|Ņ|Ň/' => 'N',
    '/ñ|ń|ņ|ň|ŉ/' => 'n',
    '/Ò|Ó|Ô|Õ|Ō|Ŏ|Ǒ|Ő|Ơ|Ø|Ǿ/' => 'O',
    '/ò|ó|ô|õ|ō|ŏ|ǒ|ő|ơ|ø|ǿ|º/' => 'o',
    '/Ŕ|Ŗ|Ř/' => 'R',
    '/ŕ|ŗ|ř/' => 'r',
    '/Ś|Ŝ|Ş|Š/' => 'S',
    '/ś|ŝ|ş|š|ſ/' => 's',
    '/Ţ|Ť|Ŧ/' => 'T',
    '/ţ|ť|ŧ/' => 't',
    '/Ù|Ú|Û|Ũ|Ū|Ŭ|Ů|Ű|Ų|Ư|Ǔ|Ǖ|Ǘ|Ǚ|Ǜ/' => 'U',
    '/ù|ú|û|ũ|ū|ŭ|ů|ű|ų|ư|ǔ|ǖ|ǘ|ǚ|ǜ/' => 'u',
    '/Ý|Ÿ|Ŷ/' => 'Y',
    '/ý|ÿ|ŷ/' => 'y',
    '/Ŵ/' => 'W',
    '/ŵ/' => 'w',
    '/Ź|Ż|Ž/' => 'Z',
    '/ź|ż|ž/' => 'z',
    '/Æ|Ǽ/' => 'AE',
    '/ß/' => 'ss',
    '/Ĳ/' => 'IJ',
    '/ĳ/' => 'ij',
    '/Œ/' => 'OE',
    '/ƒ/' => 'f'
)

`$_uninflected` ¶

protected static array

Words that should not be inflected

array(
    'Amoyese', 'bison', 'Borghese', 'bream', 'breeches', 'britches', 'buffalo', 'cantus',
    'carp', 'chassis', 'clippers', 'cod', 'coitus', 'Congoese', 'contretemps', 'corps',
    'debris', 'diabetes', 'djinn', 'eland', 'elk', 'equipment', 'Faroese', 'flounder',
    'Foochowese', 'gallows', 'Genevese', 'Genoese', 'Gilbertese', 'graffiti',
    'headquarters', 'herpes', 'hijinks', 'Hottentotese', 'information', 'innings',
    'jackanapes', 'Kiplingese', 'Kongoese', 'Lucchese', 'mackerel', 'Maltese', '.*?media',
    'mews', 'moose', 'mumps', 'Nankingese', 'news', 'nexus', 'Niasese',
    'Pekingese', 'Piedmontese', 'pincers', 'Pistoiese', 'pliers', 'Portuguese',
    'proceedings', 'rabies', 'rice', 'rhinoceros', 'salmon', 'Sarawakese', 'scissors',
    'sea[- ]bass', 'series', 'Shavese', 'shears', 'siemens', 'species', 'swine', 'testes',
    'trousers', 'trout', 'tuna', 'Vermontese', 'Wenchowese', 'whiting', 'wildebeest',
    'Yengeese'
)

Packages

Classes

Class Inflector

Properties summary

Method Summary

_cache() protected static

camelize() public static

classify() public static

humanize() public static

pluralize() public static

reset() public static

rules() public static

singularize() public static

slug() public static

tableize() public static

underscore() public static

variable() public static

Method Detail

_cache() protected static ¶

Parameters

Returns

camelize() public static ¶

Parameters

Returns

Link

classify() public static ¶

Parameters

Returns

Link

humanize() public static ¶

Parameters

Returns

Link

pluralize() public static ¶

Parameters

Returns

Link

reset() public static ¶

rules() public static ¶

Usage:

Parameters

singularize() public static ¶

Parameters

Returns

Link

slug() public static ¶

Parameters

Returns

Link

tableize() public static ¶

Parameters

Returns

Link

underscore() public static ¶

Parameters

Returns

Link

variable() public static ¶

Parameters

Returns

Link

Properties detail

$_cache ¶

$_initialState ¶

$_plural ¶

$_singular ¶

$_transliteration ¶

$_uninflected ¶

`$_cache` ¶

`$_initialState` ¶

`$_plural` ¶

`$_singular` ¶

`$_transliteration` ¶

`$_uninflected` ¶