Class Inflector
Pluralize and singularize English words.
Inflector pluralizes and singularizes English nouns. Used by Cake's naming conventions throughout the framework. Test with $i = new Inflector(); $i->test();
- Object
-
Inflector
Link: http://book.cakephp.org/view/491/Inflector
Copyright: Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
License: The MIT License
Location: inflector.php
Properties summary
-
$__irregularPluralpublicarrayIrregular plural rules from inflections.php -
$__irregularSingularpublicarrayIrregular singular rules from inflections.php -
$__pluralRulespublicarrayPlural rules from inflections.php -
$__singularRulespublicarraySingular rules from inflections.php -
$__uninflectedPluralpublicarrayUn-inflected plural rules from inflections.php -
$__uninflectedSingularpublicarrayUn-inflectd singular rules from inflections.php -
$pluralRulespublicarrayList of pluralization rules in the form of pattern => replacement. -
$pluralizedpublicarrayPluralized words. -
$singularRulespublicarrayList of singularization rules in the form of pattern => replacement. -
$singularizedpublicarraySingularized words.
Inherited Properties
Method Summary
-
__initPluralRules() public
Initializes plural inflection rules. -
__initSingularRules() public
Initializes singular inflection rules. -
camelize() public
Returns the given lower_case_and_underscored_word as a CamelCased word. -
classify() public
Returns Cake model class name ("Person" for the database table "people".) for given database table. -
getInstance() public
Gets a reference to the Inflector object instance -
humanize() public
Returns the given underscored_word_group as a Human Readable Word Group. (Underscores are replaced by spaces and capitalized following words.)
-
pluralize() public
Return $word in plural form. -
singularize() public
Return $word in singular form. -
slug() public
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
Returns corresponding table name for given model $className. ("people" for the model class "Person"). -
underscore() public
Returns the given camelCasedWord as an underscored_word. -
variable() public
Returns camelBacked version of an underscored string.
Method Detail
camelize() public ¶
camelize( string $lowerCaseAndUnderscoredWord )
Returns the given lower_case_and_underscored_word as a CamelCased word.
Parameters
- string $lowerCaseAndUnderscoredWord
- $lower_case_and_underscored_word Word to camelize
Returns
Camelized word. LikeThis.
Link
classify() public ¶
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
Class name
Link
getInstance() public ¶
getInstance( )
Gets a reference to the Inflector object instance
Returns
humanize() public ¶
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
- $lower_case_and_underscored_word String to be made more readable
Returns
Human-readable string
Link
pluralize() public ¶
pluralize( string $word )
Return $word in plural form.
Parameters
- string $word
- Word in singular
Returns
Word in plural
Link
singularize() public ¶
singularize( string $word )
Return $word in singular form.
Parameters
- string $word
- Word in plural
Returns
Word in singular
Link
slug() public ¶
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
- string $replacement optional '_'
Returns
Link
tableize() public ¶
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
Name of the database table for given class
Link
underscore() public ¶
underscore( string $camelCasedWord )
Returns the given camelCasedWord as an underscored_word.
Parameters
- string $camelCasedWord
- Camel-cased word to be "underscorized"
Returns
Underscore-syntaxed version of the $camelCasedWord
Link
variable() public ¶
variable( string $string )
Returns camelBacked version of an underscored string.
Parameters
- string $string
Returns
in variable form
Link
Methods inherited from Object
Object() public ¶
Object( )
A hack to support __construct() on PHP 4 Hint: descendant classes have no PHP4 class_name() constructors, so this constructor gets called first and calls the top-layer __construct() which (if present) should call parent::__construct()
Returns
__openPersistent() public ¶
__openPersistent( string $name , string $type = null )
Open the persistent class file for reading Used by Object::_persist()
Parameters
- string $name
- Name of persisted class
- string $type optional null
- Type of persistance (e.g: registry)
_persist() public ¶
_persist( string $name , string $return , $object , $type = null )
Checks for a persistent class file, if found file is opened and true returned If file is not found a file is created and false returned If used in other locations of the model you should choose a unique name for the persistent file There are many uses for this method, see manual for examples
Parameters
- string $name
- name of the class to persist
- string $return
- $object the object to persist
- $object
- $type optional null
Returns
Success
_savePersistent() public ¶
_savePersistent( string $name , object $object )
You should choose a unique name for the persistent file
There are many uses for this method, see manual for examples
Parameters
- string $name
- name used for object to cache
- object $object
- the object to persist
Returns
true on save, throws error if file can not be created
_set() public ¶
_set( array $properties = array() )
Allows setting of multiple properties of the object in a single line of code.
Parameters
- array $properties optional array()
- An associative array containing properties and corresponding values.
_stop() public ¶
_stop( $status = 0 )
Stop execution of the current script
Parameters
- $status optional 0
- http://php.net/exit for values
cakeError() public ¶
cakeError( string $method , array $messages = array() )
Used to report user friendly errors. If there is a file app/error.php or app/app_error.php this file will be loaded error.php is the AppError class it should extend ErrorHandler class.
Parameters
- string $method
- Method to be called in the error class (AppError or ErrorHandler classes)
- array $messages optional array()
- Message that is to be displayed by the error class
Returns
message
dispatchMethod() public ¶
dispatchMethod( string $method , array $params = array() )
Calls a method on this object with the given parameters. Provides an OO wrapper for call_user_func_array, and improves performance by using straight method calls in most cases.
Parameters
- string $method
- Name of the method to call
- array $params optional array()
- Parameter list to use when calling $method
Returns
Returns the result of the method call
log() public ¶
log( string $msg , integer $type = LOG_ERROR )
API for logging events.
Parameters
- string $msg
- Log message
- integer $type optional LOG_ERROR
- Error type constant. Defined in app/config/core.php.
Returns
Success of log write
requestAction() public ¶
requestAction( mixed $url , array $extra = array() )
Calls a controller's method from any location.
Parameters
- mixed $url
- String or array-based url.
- array $extra optional array()
- if array includes the key "return" it sets the AutoRender to true.
Returns
Boolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.
toString() public ¶
toString( )
Object-to-string conversion. Each class can override this method as necessary.
Returns
The name of this class
Properties detail
$pluralRules ¶
List of pluralization rules in the form of pattern => replacement.
Link
array()
$singularRules ¶
List of singularization rules in the form of pattern => replacement.
Link
array()