Класс Text

_removeLastWord()source protected static

_removeLastWord( string $text )

Удаляет последнее слово из входного текста.

Параметры

строка $text

Входной текст

Возвращает

строка

_strlen()source protected static

_strlen( string $text , array $options )

Получить длину строки.

Параметры:

• html Если true, HTML-сущности будут обрабатываться как декодированные символы.
• trimWidth Если true, будет возвращена ширина.

Параметры

строка $text

Строка, длина которой проверяется

массив $options

Массив опций.

Возвращает

целое число

_substr()source protected static

_substr( string $text , integer $start , integer $length , array $options )

Возвращает часть строки.

Параметры:

• html Если true, HTML-сущности будут обрабатываться как декодированные символы.
• trimWidth Если true, будет усечено с заданной шириной.

Параметры

строка $text

Входная строка.

целое число $start

Позиция начала извлечения.

целое число $length

Желаемая длина.

массив $options

Массив опций.

Возвращает

строка

_wordWrap()source protected static

_wordWrap( string $text , integer $width 72 , string $break "\n" , boolean $cut false )

Unicode-совместимая версия wordwrap как вспомогательный метод.

Параметры

строка $text

Текст для форматирования.

целое число $width опционально 72

Ширина обёртывания. По умолчанию 72.

строка $break опционально "\n"

Строка разрыва строки. По умолчанию '\n'.

булево $cut опционально false

Если cut = true, строка всегда обёртывается на указанной ширине.

Возвращает

строка
Отформатированный текст.

ascii()source public static

ascii( array $array )

Преобразует десятичное значение многобайтовой строковой переменной в строку.

Параметры

массив $array

Массив

Возвращает

строка

cleanInsert()source public static

cleanInsert( string $str , array $options )

Очищает строку, отформатированную с помощью Text::insert(), с заданными $options в зависимости от ключа 'clean' в $options. По умолчанию используется метод text, но также доступен метод html. Цель этой функции — заменить все пробелы и ненужные теги вокруг заглушек, которые не были заменены Text::insert().

Параметры

строка $str

Строка для очистки.

массив $options

Список опций.

Возвращает

строка

См. также

\Cake\Utility\Text::insert()

excerpt()source public static

excerpt( string $text , string $phrase , integer $radius 100 , string $ellipsis '...' )

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

Параметры

строка $text

Строка для поиска фразы

строка $phrase

Фраза, которая будет искаться

целое число $radius необязательно 100

Количество символов, которые будут возвращены по обеим сторонам найденной фразы

строка $ellipsis необязательно '...'

Окончание, которое будет добавлено

Возвращает

строка
Изменённая строка

Ссылка

http://book.cakephp.org/3.0/ru/core-libraries/string.html#extracting-an-excerpt

getTransliteratorId()source public static

getTransliteratorId( )

Получение идентификатора транслитератора по умолчанию.

Возвращает

строка
Идентификатор транслитератора.

highlight()source public static

highlight( string $text , string|array $phrase , array $options [] )

Выделяет заданную фразу в тексте. Вы можете указать любое выражение в выделении, которое может включать выражение \1 для включения найденной фразы.

Параметры:

• format Часть HTML, с помощью которой будет выделена фраза
• html Если true, игнорирует HTML-теги, гарантируя, что выделена только правильная фраза
• regex Пользовательское правило регулярного выражения для соответствия словам, по умолчанию '|$tag|iu'

Параметры

строка $text

Текст для поиска фразы.

строка|массив $phrase

Фраза или фразы, которые будут искаться.

массив $options необязательно []

Массив HTML-атрибутов и параметров.

Возвращает

строка
Выделенный текст

Ссылка

http://book.cakephp.org/3.0/ru/core-libraries/string.html#highlighting-substrings

insert()source public static

insert( string $str , array $data , array $options [] )

Заменяет переменные-заполнители внутри $str любыми заданными данными $data. Каждый ключ в массиве $data соответствует имени переменной-заполнителя в $str. Пример:

Text::insert(':name is :age years old.', ['name' => 'Bob', 'age' => '65']);

Возвращает: Боб 65 лет.

Доступные параметры $options:

• before: Символ или строка перед именем переменной-заполнителя (По умолчанию :)
• after: Символ или строка после имени переменной-заполнителя (По умолчанию null)
• escape: Символ или строка, используемая для экранирования символа/строки before (По умолчанию \)
• format: Регулярное выражение для сопоставления переменных-заполнителей. По умолчанию: /(?<!\\)\:%s/ (Перезаписывает before, after, нарушает escape/очищает)
• clean: Логическое значение или массив с инструкциями для Text::cleanInsert

Параметры

строка $str

Строка, содержащая переменные-заполнители

массив $data

Массив ключ => значение, где каждый ключ представляет имя переменной-заполнителя, которую нужно заменить на значение

массив $options необязательно []

Массив параметров, см. описание выше

Возвращает

строка

isMultibyte()source public static

isMultibyte( string $string )

Проверка, содержит ли строка многобайтовые символы

Параметры

строка $string

значение для проверки

Возвращает

boolean

parseFileSize()source public static

parseFileSize( string $size , mixed $default false )

Преобразование размера файла из удобочитаемой строки в байты

Параметры

строка $size

Размер в удобочитаемой строке, например '5MB', '5M', '500B', '50kb' и т.д.

смешанный $default необязательно false

Значение, которое должно быть возвращено при использовании некорректного размера, например 'Неизвестный тип'

Возвращает

смешанный
Количество байтов как целое число при успехе, $default при ошибке, если не false

Исключения

InvalidArgumentException
При некорректном типе единицы измерения.

Ссылка

http://book.cakephp.org/3.0/ru/core-libraries/helpers/text.html

setTransliteratorId()source public static

setTransliteratorId( string $transliteratorId )

Устанавливает идентификатор транслитератора по умолчанию.

Параметры

строка $transliteratorId

Идентификатор транслитератора.

slug()source public static

slug( string $string , array $options [] )

Возвращает строку, в которой все пробелы преобразованы в дефисы (по умолчанию), символы транслитерированы в ASCII-символы, а небуквенные символы удалены.

Параметры:

• replacement: Строка замены. По умолчанию '-'.
• transliteratorId: Действительный идентификатор транслитератора. Если по умолчанию используется null Text::$_defaultTransliteratorId. Если false транслитерация не будет выполнена, будут удалены только небуквенные символы.
• preserve: Конкретный небуквенный символ для сохранения. По умолчанию null. Например, этот параметр может быть установлен на '.' для создания чистых имён файлов.

Параметры

строка $string

строка, которую вы хотите привести к слэгу

массив $options необязательно []

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

Возвращает

строка

stripLinks()source public static

stripLinks( string $text )

Удаляет из заданного текста все ссылки (<a href=....).

Предупреждение Этот метод не является надёжным решением для предотвращения XSS или вредоносного HTML.

Устаревший

3.2.12 Этот метод будет удалён в версии 4.0.0

Параметры

строка $text

Текст

Возвращает

строка
Текст без ссылок

tail()source public static

tail( string $text , integer $length 100 , array $options [] )

Обрезает текст, начиная с конца.

Обрезает строку до длины $length и заменяет первые символы многоточием, если текст длиннее длины.

Параметры:

• ellipsis Будет использоваться как начало и предваряет обрезанную строку
• exact Если false, $text не будет обрезаться посередине слова

Параметры

строка $text

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

целое число $length необязательно 100

Длина возвращаемой строки, включая многоточие.

массив $options необязательно []

Массив параметров.

Возвращает

строка
Обрезанная строка.

toList()source public static

toList( array $list , string|null $and null , string $separator ', ' )

Создаёт список, разделённый запятыми, где последние два элемента соединены со словом 'и', образуя естественный язык.

Параметры

массив $list

Список для соединения.

строка|null $and необязательно null

Слово, используемое для соединения последних двух элементов вместе. По умолчанию 'и'.

строка $separator необязательно ', '

Разделитель, используемый для соединения всех остальных элементов. По умолчанию ', '.

Возвращает

строка
Склеенная строка.

Ссылка

http://book.cakephp.org/3.0/ru/core-libraries/string.html#converting-an-array-to-sentence-form

tokenize()source public static

tokenize( string $data , string $separator ',' , string $leftBound '(' , string $rightBound ')' )

Разбивает строку на токены, используя $separator, игнорируя любые вхождения $separator, которые появляются между $leftBound и $rightBound.

Параметры

string $data

Данные для разбиения на токены.

string $separator необязательно ','

Разделитель для разбиения данных.

string $leftBound необязательно '('

Левая граница для игнорирования разделителей.

string $rightBound необязательно ')'

Правая граница для игнорирования разделителей.

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

array|string
Массив токенов в $data или исходный входной параметр, если он пуст.

transliterate()source public static

transliterate( string $string , string|null $transliteratorId null )

Транслитерация строки.

Параметры

string $string

Строка для транслитерации.

string|null $transliteratorId необязательно null

Идентификатор транслитератора. Если null, будет использован Text::$_defaultTransliteratorId.

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

string

См. также

http://php.net/manual/ru/transliterator.transliterate.php

truncate()source public static

truncate( string $text , integer $length 100 , array $options [] )

Усечение текста.

Урезает строку до длины $length и заменяет последние символы многоточием, если текст длиннее длины.

Опции:

• ellipsis Будет использоваться в качестве окончания и добавлен к обрезанной строке
• exact Если false, $text не будет обрезан посреди слова
• html Если true, HTML-теги будут обработаны корректно
• trimWidth Если true, $text будет усечён с заданной шириной

Параметры

string $text

Строка для усечения.

integer $length необязательно 100

Длина возвращаемой строки, включая многоточие.

array $options необязательно []

Массив HTML-атрибутов и опций.

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

string
Обрезанная строка.

Ссылка

http://book.cakephp.org/3.0/ru/core-libraries/string.html#truncating-text

truncateByWidth()source public static

truncateByWidth( string $text , integer $length 100 , array $options [] )

Усечение текста с заданной шириной.

Параметры

string $text

Строка для усечения.

integer $length необязательно 100

Длина возвращаемой строки, включая многоточие.

array $options необязательно []

Массив HTML-атрибутов и опций.

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

string
Обрезанная строка.

См. также

\Cake\Utility\Text::truncate()

utf8()source public static

utf8( string $string )

Преобразует строку с многобайтовыми символами в десятичное значение символа

Параметры

string $string

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

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

array

uuid()source public static

uuid( )

Генерирует случайный UUID версии 4.

Предупреждение: Этот метод не следует использовать в качестве случайного семени для криптографических операций. Вместо этого используйте расширения openssl или mcrypt.

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

string
UUID в формате RFC 4122

См. также

http://www.ietf.org/rfc/rfc4122.txt

Авторские права

Matt Farina MIT License https://github.com/lootils/uuid/blob/master/LICENSE

wordWrap()source public static

wordWrap( string $text , integer $width 72 , string $break "\n" , boolean $cut false )

Unicode и newline-ориентированная версия wordwrap.

Параметры

string $text

Текст для форматирования.

integer $width необязательно 72

Ширина для обрезки. По умолчанию 72.

string $break необязательно "\n"

Строка, используемая для разрыва строки. По умолчанию '\n'.

boolean $cut необязательно false

Если значение true, строка всегда будет обрезана по указанной ширине.

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

string
Отформатированный текст.

wrap()source public static

wrap( string $text , array|integer $options [] )

Обрезает текст до заданной ширины, с опцией обрезки по словам.

Опции

• width Ширина обрезки. По умолчанию 72.
• wordWrap Обрезка только по словам (пробелам). По умолчанию true.
• indent Строка для отступа. По умолчанию null.
• indentAt 0-индексированный номер, с которого начинать отступ. По умолчанию 0.

Параметры

string $text

Текст для форматирования.

array|integer $options необязательно []

Массив опций или целое число для ширины обрезки.

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

string
Отформатированный текст.

wrapBlock()source public static

wrapBlock( string $text , array|integer $options [] )

Обрезает весь блок текста до заданной ширины, с опцией обрезки по словам.

Опции

• width Ширина обрезки. По умолчанию 72.
• wordWrap Обрезка только по словам (пробелам). По умолчанию true.
• indent Строка для отступа. По умолчанию null.
• indentAt 0-индексированный номер, с которого начинать отступ. По умолчанию 0.

Параметры

string $text

Текст для форматирования.

array|integer $options необязательно []

Массив опций или целое число для ширины обрезки.

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

string
Отформатированный текст.

'Any-Latin; Latin-ASCII; [\u0080-\u7fff] remove'