Subversion Repositories SmartDukaan

<?php

/**

 * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)

 * Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)

 *

 * Licensed under The MIT License

 * For full copyright and license information, please see the LICENSE.txt

 * Redistributions of files must retain the above copyright notice.

 *

 * @copyright     Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)

 * @link          http://cakephp.org CakePHP(tm) Project

 * @package       Cake.Utility

 * @since         CakePHP(tm) v 0.2.9

 * @license       http://www.opensource.org/licenses/mit-license.php MIT License

 */

/**

 * Pluralize and singularize English words.

 *

 * Inflector pluralizes and singularizes English nouns.

 * Used by CakePHP's naming conventions throughout the framework.

 *

 * @package       Cake.Utility

 * @link          http://book.cakephp.org/2.0/en/core-utility-libraries/inflector.html

 */

class Inflector {

/**

 * Plural inflector rules

 *

 * @var array

 */

	protected static $_plural = array(

		'rules' => array(

			'/(s)tatus$/i' => '\1tatuses',

			'/(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|([lre])f)$/i' => '\1\2ves',

			'/sis$/i' => 'ses',

			'/([ti])um$/i' => '\1a',

			'/(p)erson$/i' => '\1eople',

			'/(?<!u)(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',

			'.*data',

			'.*deer',

			'.*fish',

			'.*measles',

			'.*ois',

			'.*pox',

			'.*sheep',

			'people',

			'feedback',

			'stadia'

		),

		'irregular' => array(

			'atlas' => 'atlases',

			'beef' => 'beefs',

			'brief' => 'briefs',

			'brother' => 'brothers',

			'cafe' => 'cafes',

			'child' => 'children',

			'cookie' => 'cookies',

			'corpus' => 'corpuses',

			'cow' => 'cows',

			'criterion' => 'criteria',

			'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',

			'potato' => 'potatoes',

			'hero' => 'heroes',

			'tooth' => 'teeth',

			'goose' => 'geese',

			'foot' => 'feet',

			'sieve' => 'sieves'

		)

	);

/**

 * Singular inflector rules

 *

 * @var array

 */

	protected static $_singular = 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)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',

			'/(tive)s$/i' => '\1',

			'/(hive)s$/i' => '\1',

			'/(drive)s$/i' => '\1',

			'/([le])ves$/i' => '\1f',

			'/([^rfoa])ves$/i' => '\1fe',

			'/(^analy)ses$/i' => '\1sis',

			'/(analy|diagno|^ba|(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(

			'.*data',

			'.*[nrlm]ese', '.*deer', '.*fish', '.*measles', '.*ois', '.*pox', '.*sheep', '.*ss', 'feedback'

		),

		'irregular' => array(

			'foes' => 'foe',

		)

	);

/**

 * Words that should not be inflected

 *

 * @var array

 */

	protected static $_uninflected = 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', 'research', 'rice', 'rhinoceros', 'salmon', 'Sarawakese', 'scissors',

		'sea[- ]bass', 'series', 'Shavese', 'shears', 'siemens', 'species', 'swine', 'testes',

		'trousers', 'trout', 'tuna', 'Vermontese', 'Wenchowese', 'whiting', 'wildebeest',

		'Yengeese'

	);

/**

 * Default map of accented and special characters to ASCII characters

 *

 * @var array

 */

	protected static $_transliteration = array(

		'/À|Á|Â|Ã|Å|Ǻ|Ā|Ă|Ą|Ǎ/' => 'A',

		'/Æ|Ǽ/' => 'AE',

		'/Ä/' => 'Ae',

		'/Ç|Ć|Ĉ|Ċ|Č/' => 'C',

		'/Ð|Ď|Đ/' => 'D',

		'/È|É|Ê|Ë|Ē|Ĕ|Ė|Ę|Ě/' => 'E',

		'/Ĝ|Ğ|Ġ|Ģ|Ґ/' => 'G',

		'/Ĥ|Ħ/' => 'H',

		'/Ì|Í|Î|Ï|Ĩ|Ī|Ĭ|Ǐ|Į|İ|І/' => 'I',

		'/IJ/' => 'IJ',

		'/Ĵ/' => 'J',

		'/Ķ/' => 'K',

		'/Ĺ|Ļ|Ľ|Ŀ|Ł/' => 'L',

		'/Ñ|Ń|Ņ|Ň/' => 'N',

		'/Ò|Ó|Ô|Õ|Ō|Ŏ|Ǒ|Ő|Ơ|Ø|Ǿ/' => 'O',

		'/Œ/' => 'OE',

		'/Ö/' => 'Oe',

		'/Ŕ|Ŗ|Ř/' => 'R',

		'/Ś|Ŝ|Ş|Ș|Š/' => 'S',

		'/ẞ/' => 'SS',

		'/Ţ|Ț|Ť|Ŧ/' => 'T',

		'/Þ/' => 'TH',

		'/Ù|Ú|Û|Ũ|Ū|Ŭ|Ů|Ű|Ų|Ư|Ǔ|Ǖ|Ǘ|Ǚ|Ǜ/' => 'U',

		'/Ü/' => 'Ue',

		'/Ŵ/' => 'W',

		'/Ý|Ÿ|Ŷ/' => 'Y',

		'/Є/' => 'Ye',

		'/Ї/' => 'Yi',

		'/Ź|Ż|Ž/' => 'Z',

		'/à|á|â|ã|å|ǻ|ā|ă|ą|ǎ|ª/' => 'a',

		'/ä|æ|ǽ/' => 'ae',

		'/ç|ć|ĉ|ċ|č/' => 'c',

		'/ð|ď|đ/' => 'd',

		'/è|é|ê|ë|ē|ĕ|ė|ę|ě/' => 'e',

		'/ƒ/' => 'f',

		'/ĝ|ğ|ġ|ģ|ґ/' => 'g',

		'/ĥ|ħ/' => 'h',

		'/ì|í|î|ï|ĩ|ī|ĭ|ǐ|į|ı|і/' => 'i',

		'/ij/' => 'ij',

		'/ĵ/' => 'j',

		'/ķ/' => 'k',

		'/ĺ|ļ|ľ|ŀ|ł/' => 'l',

		'/ñ|ń|ņ|ň|ʼn/' => 'n',

		'/ò|ó|ô|õ|ō|ŏ|ǒ|ő|ơ|ø|ǿ|º/' => 'o',

		'/ö|œ/' => 'oe',

		'/ŕ|ŗ|ř/' => 'r',

		'/ś|ŝ|ş|ș|š|ſ/' => 's',

		'/ß/' => 'ss',

		'/ţ|ț|ť|ŧ/' => 't',

		'/þ/' => 'th',

		'/ù|ú|û|ũ|ū|ŭ|ů|ű|ų|ư|ǔ|ǖ|ǘ|ǚ|ǜ/' => 'u',

		'/ü/' => 'ue',

		'/ŵ/' => 'w',

		'/ý|ÿ|ŷ/' => 'y',

		'/є/' => 'ye',

		'/ї/' => 'yi',

		'/ź|ż|ž/' => 'z',

	);

/**

 * Method cache array.

 *

 * @var array

 */

	protected static $_cache = array();

/**

 * The initial state of Inflector so reset() works.

 *

 * @var array

 */

	protected static $_initialState = array();

/**

 * Cache inflected values, and return if already available

 *

 * @param string $type Inflection type

 * @param string $key Original value

 * @param string $value Inflected value

 * @return string Inflected value, from cache

 */

	protected static function _cache($type, $key, $value = false) {

		$key = '_' . $key;

		$type = '_' . $type;

		if ($value !== false) {

			self::$_cache[$type][$key] = $value;

			return $value;

		}

		if (!isset(self::$_cache[$type][$key])) {

			return false;

		}

		return self::$_cache[$type][$key];

	}

/**

 * Clears Inflectors inflected value caches. And resets the inflection

 * rules to the initial values.

 *

 * @return void

 */

	public static function reset() {

		if (empty(self::$_initialState)) {

			self::$_initialState = get_class_vars('Inflector');

			return;

		}

		foreach (self::$_initialState as $key => $val) {

			if ($key !== '_initialState') {

				self::${$key} = $val;

			}

		}

	}

/**

 * 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'));

 * ```

 *

 * @param string $type The type of inflection, either 'plural', 'singular' or 'transliteration'

 * @param array $rules Array of rules to be added.

 * @param bool $reset If true, will unset default inflections for all

 *        new rules that are being defined in $rules.

 * @return void

 */

	public static function rules($type, $rules, $reset = false) {

		$var = '_' . $type;

		switch ($type) {

			case 'transliteration':

				if ($reset) {

					self::$_transliteration = $rules;

				} else {

					self::$_transliteration = $rules + self::$_transliteration;

				}

				break;

			default:

				foreach ($rules as $rule => $pattern) {

					if (is_array($pattern)) {

						if ($reset) {

							self::${$var}[$rule] = $pattern;

						} else {

							if ($rule === 'uninflected') {

								self::${$var}[$rule] = array_merge($pattern, self::${$var}[$rule]);

							} else {

								self::${$var}[$rule] = $pattern + self::${$var}[$rule];

							}

						}

						unset($rules[$rule], self::${$var}['cache' . ucfirst($rule)]);

						if (isset(self::${$var}['merged'][$rule])) {

							unset(self::${$var}['merged'][$rule]);

						}

						if ($type === 'plural') {

							self::$_cache['pluralize'] = self::$_cache['tableize'] = array();

						} elseif ($type === 'singular') {

							self::$_cache['singularize'] = array();

						}

					}

				}

				self::${$var}['rules'] = $rules + self::${$var}['rules'];

		}

	}

/**

 * Return $word in plural form.

 *

 * @param string $word Word in singular

 * @return string Word in plural

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

 */

	public static function pluralize($word) {

		if (isset(self::$_cache['pluralize'][$word])) {

			return self::$_cache['pluralize'][$word];

		}

		if (!isset(self::$_plural['merged']['irregular'])) {

			self::$_plural['merged']['irregular'] = self::$_plural['irregular'];

		}

		if (!isset(self::$_plural['merged']['uninflected'])) {

			self::$_plural['merged']['uninflected'] = array_merge(self::$_plural['uninflected'], self::$_uninflected);

		}

		if (!isset(self::$_plural['cacheUninflected']) || !isset(self::$_plural['cacheIrregular'])) {

			self::$_plural['cacheUninflected'] = '(?:' . implode('|', self::$_plural['merged']['uninflected']) . ')';

			self::$_plural['cacheIrregular'] = '(?:' . implode('|', array_keys(self::$_plural['merged']['irregular'])) . ')';

		}

		if (preg_match('/(.*(?:\\b|_))(' . self::$_plural['cacheIrregular'] . ')$/i', $word, $regs)) {

			self::$_cache['pluralize'][$word] = $regs[1] . substr($regs[2], 0, 1) . substr(self::$_plural['merged']['irregular'][strtolower($regs[2])], 1);

			return self::$_cache['pluralize'][$word];

		}

		if (preg_match('/^(' . self::$_plural['cacheUninflected'] . ')$/i', $word, $regs)) {

			self::$_cache['pluralize'][$word] = $word;

			return $word;

		}

		foreach (self::$_plural['rules'] as $rule => $replacement) {

			if (preg_match($rule, $word)) {

				self::$_cache['pluralize'][$word] = preg_replace($rule, $replacement, $word);

				return self::$_cache['pluralize'][$word];

			}

		}

	}

/**

 * Return $word in singular form.

 *

 * @param string $word Word in plural

 * @return string Word in singular

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

 */

	public static function singularize($word) {

		if (isset(self::$_cache['singularize'][$word])) {

			return self::$_cache['singularize'][$word];

		}

		if (!isset(self::$_singular['merged']['uninflected'])) {

			self::$_singular['merged']['uninflected'] = array_merge(

				self::$_singular['uninflected'],

				self::$_uninflected

			);

		}

		if (!isset(self::$_singular['merged']['irregular'])) {

			self::$_singular['merged']['irregular'] = array_merge(

				self::$_singular['irregular'],

				array_flip(self::$_plural['irregular'])

			);

		}

		if (!isset(self::$_singular['cacheUninflected']) || !isset(self::$_singular['cacheIrregular'])) {

			self::$_singular['cacheUninflected'] = '(?:' . implode('|', self::$_singular['merged']['uninflected']) . ')';

			self::$_singular['cacheIrregular'] = '(?:' . implode('|', array_keys(self::$_singular['merged']['irregular'])) . ')';

		}

		if (preg_match('/(.*(?:\\b|_))(' . self::$_singular['cacheIrregular'] . ')$/i', $word, $regs)) {

			self::$_cache['singularize'][$word] = $regs[1] . substr($regs[2], 0, 1) . substr(self::$_singular['merged']['irregular'][strtolower($regs[2])], 1);

			return self::$_cache['singularize'][$word];

		}

		if (preg_match('/^(' . self::$_singular['cacheUninflected'] . ')$/i', $word, $regs)) {

			self::$_cache['singularize'][$word] = $word;

			return $word;

		}

		foreach (self::$_singular['rules'] as $rule => $replacement) {

			if (preg_match($rule, $word)) {

				self::$_cache['singularize'][$word] = preg_replace($rule, $replacement, $word);

				return self::$_cache['singularize'][$word];

			}

		}

		self::$_cache['singularize'][$word] = $word;

		return $word;

	}

/**

 * Returns the given lower_case_and_underscored_word as a CamelCased word.

 *

 * @param string $lowerCaseAndUnderscoredWord Word to camelize

 * @return string Camelized word. LikeThis.

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

 */

	public static function camelize($lowerCaseAndUnderscoredWord) {

		if (!($result = self::_cache(__FUNCTION__, $lowerCaseAndUnderscoredWord))) {

			$result = str_replace(' ', '', Inflector::humanize($lowerCaseAndUnderscoredWord));

			self::_cache(__FUNCTION__, $lowerCaseAndUnderscoredWord, $result);

		}

		return $result;

	}

/**

 * Returns the given camelCasedWord as an underscored_word.

 *

 * @param string $camelCasedWord Camel-cased word to be "underscorized"

 * @return string Underscore-syntaxed version of the $camelCasedWord

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

 */

	public static function underscore($camelCasedWord) {

		if (!($result = self::_cache(__FUNCTION__, $camelCasedWord))) {

			$result = strtolower(preg_replace('/(?<=\\w)([A-Z])/', '_\\1', $camelCasedWord));

			self::_cache(__FUNCTION__, $camelCasedWord, $result);

		}

		return $result;

	}

/**

 * Returns the given underscored_word_group as a Human Readable Word Group.

 * (Underscores are replaced by spaces and capitalized following words.)

 *

 * @param string $lowerCaseAndUnderscoredWord String to be made more readable

 * @return string Human-readable string

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

 */

	public static function humanize($lowerCaseAndUnderscoredWord) {

		if (!($result = self::_cache(__FUNCTION__, $lowerCaseAndUnderscoredWord))) {

			$result = ucwords(str_replace('_', ' ', $lowerCaseAndUnderscoredWord));

			self::_cache(__FUNCTION__, $lowerCaseAndUnderscoredWord, $result);

		}

		return $result;

	}

/**

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

 *

 * @param string $className Name of class to get database table name for

 * @return string Name of the database table for given class

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

 */

	public static function tableize($className) {

		if (!($result = self::_cache(__FUNCTION__, $className))) {

			$result = Inflector::pluralize(Inflector::underscore($className));

			self::_cache(__FUNCTION__, $className, $result);

		}

		return $result;

	}

/**

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

 *

 * @param string $tableName Name of database table to get class name for

 * @return string Class name

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

 */

	public static function classify($tableName) {

		if (!($result = self::_cache(__FUNCTION__, $tableName))) {

			$result = Inflector::camelize(Inflector::singularize($tableName));

			self::_cache(__FUNCTION__, $tableName, $result);

		}

		return $result;

	}

/**

 * Returns camelBacked version of an underscored string.

 *

 * @param string $string String to convert.

 * @return string in variable form

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

 */

	public static function variable($string) {

		if (!($result = self::_cache(__FUNCTION__, $string))) {

			$camelized = Inflector::camelize(Inflector::underscore($string));

			$replace = strtolower(substr($camelized, 0, 1));

			$result = preg_replace('/\\w/', $replace, $camelized, 1);

			self::_cache(__FUNCTION__, $string, $result);

		}

		return $result;

	}

/**

 * Returns a string with all spaces converted to underscores (by default), accented

 * characters converted to non-accented characters, and non word characters removed.

 *

 * @param string $string the string you want to slug

 * @param string $replacement will replace keys in map

 * @return string

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

 */

	public static function slug($string, $replacement = '_') {

		$quotedReplacement = preg_quote($replacement, '/');

		$merge = array(

			'/[^\s\p{Zs}\p{Ll}\p{Lm}\p{Lo}\p{Lt}\p{Lu}\p{Nd}]/mu' => ' ',

			'/[\s\p{Zs}]+/mu' => $replacement,

			sprintf('/^[%s]+|[%s]+$/', $quotedReplacement, $quotedReplacement) => '',

		);

		$map = self::$_transliteration + $merge;

		return preg_replace(array_keys($map), array_values($map), $string);

	}

}

// Store the initial state

Inflector::reset();