0 关注者

类 yii\helpers\Inflector

继承yii\helpers\Inflector » yii\helpers\BaseInflector
可用版本2.0
源代码 https://github.com/yiisoft/yii2/blob/master/framework/helpers/Inflector.php

Inflector 将英语名词进行复数化和单数化。它还包含一些其他有用的方法。

公共属性

隐藏继承属性

属性 类型 描述 定义于
$plurals array 将单词转换为复数形式的规则。 yii\helpers\BaseInflector
$singulars array 将单词转换为单数形式的规则。 yii\helpers\BaseInflector
$specials array 将单词在复数形式和单数形式之间转换的特殊规则。 yii\helpers\BaseInflector
$transliteration array 当 intl 不可用时,transliterate() 用到的音译回退映射。 yii\helpers\BaseInflector
$transliterator mixed 一个 Transliterator 或一个可以用来构建 Transliterator 用于音译的字符串。 yii\helpers\BaseInflector

公共方法

隐藏继承方法

方法 描述 定义于
camel2id() 将驼峰式命名转换为小写 ID。 yii\helpers\BaseInflector
camel2words() 将驼峰式命名转换为用空格分隔的单词。 yii\helpers\BaseInflector
camelize() 返回给定单词的驼峰式命名。 yii\helpers\BaseInflector
classify() 将表名转换为类名。 yii\helpers\BaseInflector
humanize() 从 $word 返回一个人类可读的字符串。 yii\helpers\BaseInflector
id2camel() 将 ID 转换为驼峰式命名。 yii\helpers\BaseInflector
ordinalize() 将数字转换为序数英语形式。例如,将 13 转换为 13th,2 转换为 2nd。 yii\helpers\BaseInflector
pluralize() 将单词转换为复数形式。 yii\helpers\BaseInflector
sentence() 将单词列表转换为句子。 yii\helpers\BaseInflector
singularize() 返回 $word 的单数形式。 yii\helpers\BaseInflector
slug() 返回一个字符串,其中所有空格都转换为给定的替换,非单词字符都被移除,其余字符被音译。 yii\helpers\BaseInflector
tableize() 将类名转换为表名(复数形式),遵循命名约定。 yii\helpers\BaseInflector
titleize() 将下划线或驼峰式命名单词转换为英语句子。 yii\helpers\BaseInflector
transliterate() 返回字符串的音译版本。 yii\helpers\BaseInflector
underscore() 将任何“驼峰式命名”转换为“下划线_单词”。 yii\helpers\BaseInflector
variablize() 与 camelize 相同,但第一个字符是小写。 yii\helpers\BaseInflector

受保护方法

隐藏继承方法

方法 描述 定义于
hasIntl() yii\helpers\BaseInflector

常量

隐藏继承常量

常量 描述 定义于
TRANSLITERATE_LOOSE 'Any-Latin; Latin-ASCII; [\u0080-\uffff] remove' Any-Latin; Latin-ASCII; [\u0080-\uffff] remove 音译规则的快捷方式。该规则比较宽松,字母将使用基本拉丁 Unicode 块的字符进行音译。例如:获取到 どちら Українська: ґ,є, Српска: ђ, њ, џ! ¿Español? 将被音译为 huo qu dao dochira Ukrainska: g,e, Srpska: d, n, d! Espanol?。在 transliterate() 中使用。有关详细信息,请参阅 unicode 规范化形式 yii\helpers\BaseInflector
TRANSLITERATE_MEDIUM 'Any-Latin; Latin-ASCII' Any-Latin; Latin-ASCII 音译规则的快捷方式。该规则比较适中,字母将被音译为 Latin-1 (ISO 8859-1) ASCII 表的字符。例如:获取到 どちら Українська: ґ,є, Српска: ђ, њ, џ! ¿Español? 将被音译为 huo qu dao dochira Ukrainsʹka: g,e, Srpska: d, n, d! ¿Espanol?。在 transliterate() 中使用。有关详细信息,请参阅 unicode 规范化形式 yii\helpers\BaseInflector
TRANSLITERATE_STRICT 'Any-Latin; NFKD' Any-Latin; NFKD 音译规则的快捷方式。该规则比较严格,字母将使用最接近的发音表示字符进行音译。结果可能包含任何 UTF-8 字符。例如:获取到 どちら Українська: ґ,є, Српска: ђ, њ, џ! ¿Español? 将被音译为 huò qǔ dào dochira Ukraí̈nsʹka: g̀,ê, Srpska: đ, n̂, d̂! ¿Español?。在 transliterate() 中使用。有关详细信息,请参阅 unicode 规范化形式 yii\helpers\BaseInflector

方法详情

隐藏继承方法

camel2id() 公共静态方法

定义于: yii\helpers\BaseInflector::camel2id()

将驼峰式命名转换为小写 ID。

ID 中的单词可以使用指定的字符连接起来(默认为“-”)。例如,'PostTag' 将转换为 'post-tag'。

public static string camel2id ( $name, $separator '-', $strict false )
$name string

要转换的字符串

$separator string

用于连接 ID 中单词的字符

$strict boolean|string

是否在两个连续的大写字符之间插入分隔符,默认为 false

返回值 string

生成的 ID

                public static function camel2id($name, $separator = '-', $strict = false)
{
    if (empty($name)) {
        return (string) $name;
    }
    $regex = $strict ? '/\p{Lu}/u' : '/(?<!\p{Lu})\p{Lu}/u';
    if ($separator === '_') {
        return mb_strtolower(trim(preg_replace($regex, '_\0', $name), '_'), self::encoding());
    }
    return mb_strtolower(trim(str_replace('_', $separator, preg_replace($regex, $separator . '\0', $name)), $separator), self::encoding());
}

            
camel2words() 公共静态方法

定义于: yii\helpers\BaseInflector::camel2words()

将驼峰式命名转换为用空格分隔的单词。

例如,'PostTag' 将转换为 'Post Tag'。

public static string camel2words ( $name, $ucwords true )
$name string

要转换的字符串

$ucwords boolean

是否将每个单词的首字母大写

返回值 string

生成的单词

                public static function camel2words($name, $ucwords = true)
{
    if (empty($name)) {
        return (string) $name;
    }
    // Add a space before any uppercase letter preceded by a lowercase letter (xY => x Y)
    // and any uppercase letter preceded by an uppercase letter and followed by a lowercase letter (XYz => X Yz)
    $label = preg_replace('/(?<=\p{Ll})\p{Lu}|(?<=\p{L})\p{Lu}(?=\p{Ll})/u', ' \0', $name);
    $label = mb_strtolower(trim(str_replace(['-', '_', '.'], ' ', $label)), self::encoding());
    return $ucwords ? StringHelper::mb_ucwords($label, self::encoding()) : $label;
}

            
camelize() 公共静态方法

定义于: yii\helpers\BaseInflector::camelize()

返回给定单词的驼峰式命名。

将类似 "send_email" 的单词转换为 "SendEmail"。它将删除单词中的非字母数字字符,因此 "who's online" 将转换为 "WhoSOnline"。

另见 variablize().

public static string camelize ( $word )
$word string

要转换为驼峰式的单词

                public static function camelize($word)
{
    if (empty($word)) {
        return (string) $word;
    }
    return str_replace(' ', '', StringHelper::mb_ucwords(preg_replace('/[^\pL\pN]+/u', ' ', $word), self::encoding()));
}

            
classify() 公共静态方法

定义于: yii\helpers\BaseInflector::classify()

将表名转换为类名。

例如,将 "people" 转换为 "Person"。

public static string classify ( $tableName )
$tableName string

                public static function classify($tableName)
{
    if (empty($tableName)) {
        return (string) $tableName;
    }
    return static::camelize(static::singularize($tableName));
}

            
hasIntl() 受保护静态方法
protected static boolean hasIntl ( )
返回值 boolean

如果 intl 扩展已加载

                protected static function hasIntl()
{
    return extension_loaded('intl');
}

            
humanize() 公共静态方法

定义于: yii\helpers\BaseInflector::humanize()

从 $word 返回一个人类可读的字符串。

public static string humanize ( $word, $ucAll false )
$word string

要人性化的字符串

$ucAll boolean

是否将所有单词设置为大写

                public static function humanize($word, $ucAll = false)
{
    if (empty($word)) {
        return (string) $word;
    }
    $word = str_replace('_', ' ', preg_replace('/_id$/', '', $word));
    $encoding = self::encoding();
    return $ucAll ? StringHelper::mb_ucwords($word, $encoding) : StringHelper::mb_ucfirst($word, $encoding);
}

            
id2camel() 公共静态方法

定义于: yii\helpers\BaseInflector::id2camel()

将 ID 转换为驼峰式命名。

ID 中用 $separator(默认为 '-')分隔的单词将被连接成驼峰式名称。例如,'post-tag' 将转换为 'PostTag'。

public static string id2camel ( $id, $separator '-' )
$id string

要转换的 ID

$separator string

用于分隔 ID 中单词的字符

返回值 string

生成的驼峰式名称

                public static function id2camel($id, $separator = '-')
{
    if (empty($id)) {
        return (string) $id;
    }
    return str_replace(' ', '', StringHelper::mb_ucwords(str_replace($separator, ' ', $id), self::encoding()));
}

            
ordinalize() 公共静态方法

定义于: yii\helpers\BaseInflector::ordinalize()

将数字转换为序数英语形式。例如,将 13 转换为 13th,2 转换为 2nd。

..

public static string ordinalize ( $number )
$number integer

要获取序数值的数字

                public static function ordinalize($number)
{
    if (in_array($number % 100, range(11, 13))) {
        return $number . 'th';
    }
    switch ($number % 10) {
        case 1:
            return $number . 'st';
        case 2:
            return $number . 'nd';
        case 3:
            return $number . 'rd';
        default:
            return $number . 'th';
    }
}

            
pluralize() 公共静态方法

定义于: yii\helpers\BaseInflector::pluralize()

将单词转换为复数形式。

请注意,这仅适用于英语!例如,'apple' 将变为 'apples',而 'child' 将变为 'children'。

public static string pluralize ( $word )
$word string

要变为复数的单词

返回值 string

复数形式的单词

                public static function pluralize($word)
{
    if (empty($word)) {
        return (string) $word;
    }
    if (isset(static::$specials[$word])) {
        return static::$specials[$word];
    }
    foreach (static::$plurals as $rule => $replacement) {
        if (preg_match($rule, $word)) {
            return preg_replace($rule, $replacement, $word);
        }
    }
    return $word;
}

            
sentence() 公共静态方法 (自版本 2.0.1 起可用)

定义于: yii\helpers\BaseInflector::sentence()

将单词列表转换为句子。

对最后几个词进行特殊处理。例如,

$words = ['Spain', 'France'];
echo Inflector::sentence($words);
// output: Spain and France

$words = ['Spain', 'France', 'Italy'];
echo Inflector::sentence($words);
// output: Spain, France and Italy

$words = ['Spain', 'France', 'Italy'];
echo Inflector::sentence($words, ' & ');
// output: Spain, France & Italy
public static string sentence ( array $words, $twoWordsConnector null, $lastWordConnector null, $connector ', ' )
$words array

要转换为字符串的单词

$twoWordsConnector string|null

仅当有两个单词时连接单词的字符串

$lastWordConnector string|null

连接最后两个单词的字符串。如果为 null,则将采用 $twoWordsConnector 的值。

$connector string

连接除 $lastWordConnector 和 $twoWordsConnector 连接的单词之外的单词的字符串

返回值 string

生成的句子

                public static function sentence(array $words, $twoWordsConnector = null, $lastWordConnector = null, $connector = ', ')
{
    if ($twoWordsConnector === null) {
        $twoWordsConnector = Yii::t('yii', ' and ');
    }
    if ($lastWordConnector === null) {
        $lastWordConnector = $twoWordsConnector;
    }
    switch (count($words)) {
        case 0:
            return '';
        case 1:
            return reset($words);
        case 2:
            return implode($twoWordsConnector, $words);
        default:
            return implode($connector, array_slice($words, 0, -1)) . $lastWordConnector . end($words);
    }
}

            
singularize() 公共静态方法

定义于: yii\helpers\BaseInflector::singularize()

返回 $word 的单数形式。

public static string singularize ( $word )
$word string

要变为单数的英文单词

返回值 string

单数名词。

                public static function singularize($word)
{
    if (empty($word)) {
        return (string) $word;
    }
    $result = array_search($word, static::$specials, true);
    if ($result !== false) {
        return $result;
    }
    foreach (static::$singulars as $rule => $replacement) {
        if (preg_match($rule, $word)) {
            return preg_replace($rule, $replacement, $word);
        }
    }
    return $word;
}

            
slug() 公共静态方法

定义于: yii\helpers\BaseInflector::slug()

返回一个字符串,其中所有空格都转换为给定的替换,非单词字符都被移除,其余字符被音译。

如果 intl 扩展不可用,则使用回退,该回退仅转换拉丁字符并删除其余字符。您可以通过辅助程序的 $transliteration 属性自定义字符映射。

public static string slug ( $string, $replacement '-', $lowercase true )
$string string

要转换的任意字符串

$replacement string

用于替换空格的替换项

$lowercase boolean

是否以小写形式返回字符串。默认为 true

返回值 string

转换后的字符串。

                public static function slug($string, $replacement = '-', $lowercase = true)
{
    if (empty($string)) {
        return (string) $string;
    }
    if ((string)$replacement !== '') {
        $parts = explode($replacement, static::transliterate($string));
    } else {
        $parts = [static::transliterate($string)];
    }
    $replaced = array_map(function ($element) use ($replacement) {
        $element = preg_replace('/[^a-zA-Z0-9=\s—–-]+/u', '', $element);
        return preg_replace('/[=\s—–-]+/u', $replacement, $element);
    }, $parts);
    $string = trim(implode($replacement, $replaced), $replacement);
    if ((string)$replacement !== '') {
        $string = preg_replace('#' . preg_quote($replacement, '#') . '+#', $replacement, $string);
    }
    return $lowercase ? strtolower($string) : $string;
}

            
tableize() 公共静态方法

定义于: yii\helpers\BaseInflector::tableize()

将类名转换为表名(复数形式),遵循命名约定。

例如,将 "Person" 转换为 "people"。

public static string tableize ( $className )
$className string

用于获取相关表名的类名

                public static function tableize($className)
{
    if (empty($className)) {
        return (string) $className;
    }
    return static::pluralize(static::underscore($className));
}

            
titleize() 公共静态方法

定义于: yii\helpers\BaseInflector::titleize()

将下划线或驼峰式命名单词转换为英语句子。

public static string titleize ( $words, $ucAll false )
$words string
$ucAll boolean

是否将所有单词设置为大写

                public static function titleize($words, $ucAll = false)
{
    if (empty($words)) {
        return (string) $words;
    }
    $words = static::humanize(static::underscore($words), $ucAll);
    return $ucAll ? StringHelper::mb_ucwords($words, self::encoding()) : StringHelper::mb_ucfirst($words, self::encoding());
}

            
transliterate() 公共静态方法

定义于: yii\helpers\BaseInflector::transliterate()

返回字符串的音译版本。

如果 intl 扩展不可用,则使用回退,该回退仅转换拉丁字符并删除其余字符。您可以通过辅助程序的 $transliteration 属性自定义字符映射。

public static string transliterate ( $string, $transliterator null )
$string string

输入字符串

$transliterator string|Transliterator|null

可以是 Transliterator 或用于构建 Transliterator 的字符串。

版本 描述
2.0.7 此方法是公共的。

                public static function transliterate($string, $transliterator = null)
{
    if (empty($string)) {
        return (string) $string;
    }
    if (static::hasIntl()) {
        if ($transliterator === null) {
            $transliterator = static::$transliterator;
        }
        return transliterator_transliterate($transliterator, $string);
    }
    return strtr($string, static::$transliteration);
}

            
underscore() 公共静态方法

定义于: yii\helpers\BaseInflector::underscore()

将任何“驼峰式命名”转换为“下划线_单词”。

public static string underscore ( $words )
$words string

要加下划线的单词(组)

                public static function underscore($words)
{
    if (empty($words)) {
        return (string) $words;
    }
    return mb_strtolower(preg_replace('/(?<=\\pL)(\\p{Lu})/u', '_\\1', $words), self::encoding());
}

            
variablize() 公共静态方法

定义于: yii\helpers\BaseInflector::variablize()

与 camelize 相同,但第一个字符是小写。

将类似 "send_email" 的单词转换为 "sendEmail"。它将移除单词中的非字母数字字符,因此 "who's online" 将被转换为 "whoSOnline"。

public static string variablize ( $word )
$word string

转换为 lowerCamelCase

                public static function variablize($word)
{
    if (empty($word)) {
        return (string) $word;
    }
    $word = static::camelize($word);
    return mb_strtolower(mb_substr($word, 0, 1, self::encoding())) . mb_substr($word, 1, null, self::encoding());
}