The Inflector class takes a string and can manipulate it to handle word
variations such as pluralizations or camelizing and is normally accessed
Inflector::pluralize('example') returns “examples”.
Quick summary of the Inflector built-in methods and the results they output when provided a multi-word argument:
|Big Apples||big apples|
|big apple||big apple|
|Big Apple||big apples|
singularize() work on most English nouns. If you need
to support other languages, you can use Inflection Configuration to
customize the rules used:
// Apples echo Inflector::pluralize('Apple');
pluralize() should not be used on a noun that is already in its plural form.
// Person echo Inflector::singularize('People');
singularize() should not be used on a noun that is already in its singular form.
These methods are useful when creating class names, or property names:
// ApplePie Inflector::camelize('Apple_pie') // apple_pie Inflector::underscore('ApplePie');
It should be noted that underscore will only convert camelCase formatted words. Words that contains spaces will be lower-cased, but will not contain an underscore.
This method is useful when converting underscored forms into “Title Case” forms for human readable values:
// Apple Pie Inflector::humanize('apple_pie');
When generating code, or using CakePHP’s conventions you may need to inflect table names or class names:
// UserProfileSetting Inflector::classify('user_profile_settings'); // user-profile-setting Inflector::dasherize('UserProfileSetting'); // user_profile_settings Inflector::tableize('UserProfileSetting');
Variable names are often useful when doing meta-programming tasks that involve generating code or doing work based on conventions:
// applePie Inflector::variable('apple_pie');
CakePHP’s naming conventions can be really nice - you can name your database
big_boxes, your model
BigBoxes, your controller
BigBoxesController, and everything just works together automatically. The
way CakePHP knows how to tie things together is by inflecting the words
between their singular and plural forms.
There are occasions (especially for our non-English speaking friends) where you may run into situations where CakePHP’s inflector (the class that pluralizes, singularizes, camelCases, and under_scores) might not work as you’d like. If CakePHP won’t recognize your Foci or Fish, you can tell CakePHP about your special cases.
rules($type, $rules, $reset = false)¶
Define new inflection and transliteration rules for Inflector to use. Often, this method is used in your config/bootstrap.php:
Inflector::rules('singular', ['/^(bil)er$/i' => '\1', '/^(inflec|contribu)tors$/i' => '\1ta']); Inflector::rules('uninflected', ['singulars']); Inflector::rules('irregular', ['phylum' => 'phyla']); // The key is singular form, value is plural form
The supplied rules will be merged into the respective inflection sets defined in
Cake/Utility/Inflector, with the added rules taking precedence over the core
rules. You can use
Inflector::reset() to clear rules and restore the
original Inflector state.