Spec-Zone.ru › CakePHP 4.3

Класс Inflector

Склонение и возвращение английских слов в единственном и множественном числе.

Inflector склоняет и возвращает английские существительные в единственном и множественном числе. Используется в CakePHP для согласования имён по всей системе.

Пространство имён: Cake\Utility
Ссылка: https://book.cakephp.org/4/ru/core-libraries/inflector.html

Краткое описание свойств

  • $_cache protected static
    array

    Массив кэша методов.

  • $_initialState protected static
    array

    Начальное состояние Inflector, для работы reset().

  • $_irregular protected static
    array<string, string>

    Неправильные правила

  • $_plural protected static
    array<string, string>

    Правила склонения во множественном числе

  • $_singular protected static
    array<string, string>

    Правила склонения в единственном числе

  • $_uninflected protected static
    array<string>

    Слова, которые не должны склоняться

Краткое описание методов

  • _cache() protected static

    Кэширование склоненных значений и возврат, если уже доступно

  • camelize() public static

    Возвращает входную строку с нижним регистром и дефисами как строку с заглавными буквами в начале каждого слова.

  • classify() public static

    Возвращает имя класса модели Cake (например, "Человек" для таблицы базы данных "люди") для заданной таблицы базы данных.

  • dasherize() public static

    Возвращает строку с заглавными буквами в начале каждого слова в виде строки с дефисами.

  • delimit() public static

    Ожидает строку с заглавными буквами в начале каждого слова и возвращает строку с нижним регистром и дефисами.

  • humanize() public static

    Возвращает входную строку с нижним регистром и дефисами как «Читабельную строку». (Подчёркивания заменяются пробелами, а слова с заглавной буквы следуют за словами с прописной).

  • pluralize() public static

    Возвращает слово $word во множественном числе.

  • reset() public static

    Очищает кэши склоненных значений Inflector и сбрасывает правила склонения до начальных значений.

  • rules() public static

    Добавляет пользовательские правила склонения $rules для типов 'plural', 'singular', 'uninflected' или 'irregular'.

  • singularize() public static

    Возвращает слово $word в единственном числе.

  • tableize() public static

    Возвращает соответствующее имя таблицы для заданного класса модели $className (например, «люди» для класса модели «Человек»).

  • underscore() public static

    Возвращает строку с заглавными буквами в начале каждого слова в виде строки с нижним регистром и дефисами.

  • variable() public static

    Возвращает версию со строчными буквами в начале каждого слова заданной строки с нижним регистром и дефисами.

Подробное описание методов

_cache() protected static 

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

Кэширование склоненных значений и возврат, если значение уже доступно

Параметры

string $type

Тип склонения

string $key

Исходное значение

string|false $value optional

Склоненное значение

Возвращаемое значение

string|false

camelize() public static 

camelize(string $string, string $delimiter = '_'): string

Возвращает строку с нижним регистром и разделителями, преобразованную в строку со стилем CamelCase.

Параметры

string $string

Строка для преобразования

string $delimiter optional

разделитель в исходной строке

Возвращаемое значение

string

Ссылки

https://book.cakephp.org/4/en/core-libraries/inflector.html#creating-camelcase-and-under-scored-forms

classify() public static 

classify(string $tableName): string

Возвращает имя класса модели Cake (например, "Человек" для таблицы базы данных "люди") для заданной таблицы базы данных.

Параметры

string $tableName

Имя таблицы базы данных, для которой необходимо получить имя класса

Возвращаемое значение

string

Ссылки

https://book.cakephp.org/4/en/core-libraries/inflector.html#creating-table-and-class-name-forms

dasherize() public static 

dasherize(string $string): string

Возвращает строку со стилем CamelCase в виде строки с дефисами.

Также заменяет символы подчеркивания на дефисы.

Параметры

string $string

Строка, которую нужно преобразовать.

Возвращаемое значение

string

delimit() public static 

delimit(string $string, string $delimiter = '_'): string

Ожидает строку со стилем CamelCase и создает строку с нижним регистром и разделителями.

Параметры

string $string

Строка для разграничения

string $delimiter optional

символ, который будет использоваться в качестве разделителя

Возвращаемое значение

string

humanize() public static 

humanize(string $string, string $delimiter = '_'): string

Возвращает строку с нижним регистром и разделителями как 'Строка для удобного чтения'. (Символы подчеркивания заменяются пробелами, а слова после пробелов капитализируются.)

Параметры

string $string

Строка, которая должна быть преобразованна

string $delimiter optional

символ, который заменяется пробелом

Возвращаемое значение

string

Ссылки

https://book.cakephp.org/4/en/core-libraries/inflector.html#creating-human-readable-forms

pluralize() public static 

pluralize(string $word): string

Возвращает $word во множественном числе.

Параметры

string $word

Слово в единственном числе

Возвращаемое значение

string

Ссылки

https://book.cakephp.org/4/en/core-libraries/inflector.html#creating-plural-singular-forms

reset() public static 

reset(): void

Очищает кэш склоненных значений и сбрасывает правила склонения до начальных значений.

Возвращаемое значение

void

rules() public static 

rules(string $type, array $rules, bool $reset = false): void

Добавляет пользовательские правила склонения ($rules) для типов 'plural', 'singular', 'uninflected' или 'irregular'.

Использование:

Inflector::rules('plural', ['/^(inflect)or$/i' => '\1ables']);
Inflector::rules('irregular', ['red' => 'redlings']);
Inflector::rules('uninflected', ['dontinflectme']);

Параметры

string $type

Тип склонения ('plural', 'singular' или 'uninflected').

array $rules

Массив правил для добавления.

bool $reset optional

Если true, сбросит значения по умолчанию для всех новых правил, определённых в $rules.

Возвращаемое значение

void

singularize() public static 

singularize(string $word): string

Возвращает $word в единственном числе.

Параметры

string $word

Слово во множественном числе

Возвращаемое значение

string

Ссылки

https://book.cakephp.org/4/en/core-libraries/inflector.html#creating-plural-singular-forms

tableize() public static 

tableize(string $className): string

Возвращает соответствующее имя таблицы для заданного класса модели (например, "люди" для класса модели "Человек").

Параметры

string $className

Имя класса для получения имени таблицы базы данных

Возвращаемое значение

string

Ссылки

https://book.cakephp.org/4/en/core-libraries/inflector.html#creating-table-and-class-name-forms

underscore() public static 

underscore(string $string): string

Возвращает строку со стилем CamelCase в виде строки с символами подчеркивания.

Также заменяет дефисы на символы подчеркивания.

Параметры

string $string

Строка со стилем CamelCase для преобразования

Возвращаемое значение

string

Ссылки

https://book.cakephp.org/4/en/core-libraries/inflector.html#creating-camelcase-and-under-scored-forms

variable() public static 

variable(string $string): string

Возвращает версию со стилем camelBack строки с подчеркиваниями.

Параметры

string $string

Строка для преобразования.

Возвращаемое значение

string

Ссылки

https://book.cakephp.org/4/en/core-libraries/inflector.html#creating-variable-names

Подробное описание свойств

$_cache protected static

Массив кэша методов.

Тип

array

$_initialState protected static

Начальное состояние Inflector, для работы reset().

Тип

array

$_irregular protected static

Правила исключений

Тип

array<string, string>

$_plural protected static

Правила склонения во множественном числе

Тип

array<string, string>

$_singular protected static

Правила склонения в единственном числе

Тип

array<string, string>

$_uninflected protected static

Слова, которые не должны склоняться

Тип

array<string>

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.3/class-Cake.Utility.Inflector.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API