Класс Текст
Методы обработки текста.
Подробное описание метода
_wordWrapисходный код защищённый статический
_wordWrap( string $text , integer $width 72 , string $break "\n" , boolean $cut false )
Версия wordwrap, учитывающая Unicode, как вспомогательный метод.
Параметры
- строка
$text - Текст для форматирования.
- целое число
$widthнеобязательно 72 - Ширина обрезания. По умолчанию 72.
- строка
$breakнеобязательно "\n" - Строка разрыва строки. По умолчанию '\n'.
- логическое значение
$cutнеобязательно false - Если обрезка установлена в true, строка всегда обрезается до указанной ширины.
Возвращает
stringОтформатированный текст.
asciiисходный код публичный статический
ascii( array $array )
Преобразует десятичное значение строки символов с несколькими байтами в строку
Параметры
- массив
$array - Массив
Возвращает
stringстрока
cleanInsertисходный код публичный статический
cleanInsert( string $str , array $options )
Очищает строку, отформатированную Text::insert(), с заданными $options в зависимости от ключа 'clean' в $options. Используемый по умолчанию метод — текст, но также доступен html. Цель этой функции — заменить все пробелы и ненужные метки вокруг заготовок, которые не были заменены Text::insert().
Параметры
- строка
$str - Строка для очистки.
- массив
$options - Список опций.
Возвращает
stringстрока
См.
Cake\Utility\Text::insert()excerptисходный код публичный статический
excerpt( string $text , string $phrase , integer $radius 100 , string $ellipsis '...' )
Извлекает фрагмент из текста, окружающего фразу с количеством символов по обе стороны, определяемых радиусом.
Параметры
- строка
$text - Строка для поиска фразы
- строка
$phrase - Фраза, которая будет найдена
- целое число
$radiusнеобязательно 100 - Количество символов, которые будут возвращены по обе стороны от найденной фразы
- строка
$ellipsisнеобязательно '...' - Конец, который будет добавлен
Возвращает
stringИзменённая строка
Ссылка
http://book.cakephp.org/3.0/ru/core-libraries/string.html#extracting-an-excerpthighlightисходный код публичный статический
highlight( string $text , string|array $phrase , array $options [] )
Выделяет заданную фразу в тексте. Вы можете указать любое выражение в выделении, которое может включать выражение \1 для включения найденной $phrase.
Опции:
-
formatЧасть HTML, в которой будет выделена фраза -
htmlЕсли true, игнорирует теги HTML, гарантируя, что выделяется только правильный текст -
regexпользовательская регулярная выражение, используемая для сопоставления слов, по умолчанию '|$tag|iu'
Параметры
- строка
$text - Текст для поиска фразы в нём.
- строка|массив
$phrase - Фраза или фразы, которые будут искаться.
- массив
$optionsнеобязательно [] - Массив атрибутов и опций HTML.
Возвращает
stringВыделенный текст
Ссылка
http://book.cakephp.org/3.0/ru/core-libraries/string.html#highlighting-substringsinsertисходный код публичный статический
insert( string $str , array $data , array $options [] )
Заменяет переменные заготовки внутри $str на любые заданные $data. Каждый ключ в массиве $data соответствует имени переменной заготовки в $str. Пример:
Text::insert(':name is :age years old.', ['name' => 'Bob', '65']);
Возвращает: Боб — 65 лет.
Доступные $options:
- before: Символ или строка перед именем переменной заготовки (по умолчанию
:) - after: Символ или строка после имени переменной заготовки (по умолчанию null)
- escape: Символ или строка, используемая для экранирования символа/строки перед (по умолчанию
\) - format: Регулярное выражение для сопоставления переменных заготовок. По умолчанию:
/(?<!\)\:%s/(переопределяет before, after, breaks escape/clean) - clean: Логическое значение или массив с инструкциями для Text::cleanInsert
Параметры
- строка
$str - Строка, содержащая переменные заготовки
- массив
$data - Массив ключ => значение, где каждый ключ соответствует имени переменной заготовки, подлежащей замене значением
- массив
$optionsнеобязательно [] - Массив опций, см. описание выше
Возвращает
stringстрока
isMultibyteисходный код публичный статический
isMultibyte( string $string )
Проверка, содержит ли строка символы с несколькими байтами
Параметры
- строка
$string - значение для проверки
Возвращает
booleanлогическое значение
parseFileSizeисходный код публичный статический
parseFileSize( string $size , mixed $default false )
Преобразует размер файла из удобочитаемой строки в байты
Параметры
- строка
$size - Размер в удобочитаемой строке, например, '5МБ', '5М', '500Б', '50кб' и т. д.
- смешанный
$defaultнеобязательно false - Значение, которое будет возвращено при использовании недопустимого размера, например, 'Неизвестный тип'
Возвращает
mixedКоличество байтов в виде целого числа при успехе,
$default при ошибке, если не falseВызывает исключение
InvalidArgumentExceptionПри неверном типе единицы.
Ссылка
http://book.cakephp.org/3.0/ru/core-libraries/helpers/text.htmlstripLinksисходный код публичный статический
stripLinks( string $text )
Удаляет из данного текста все ссылки (<a href=....).
Параметры
- строка
$text - Текст
Возвращает
stringТекст без ссылок
tailисходный код публичный статический
tail( string $text , integer $length 100 , array $options [] )
Усекает текст, начиная с конца.
Усекает строку до длины $length и заменяет первые символы многоточием, если текст длиннее длины.
Опции:
-
ellipsisБудет использоваться как начало и предварять обрезанную строку -
exactЕсли false, $text не будет обрезаться посреди слова
Параметры
- строка
$text - Строка для усечения.
- целое число
$lengthнеобязательно 100 - Длина возвращаемой строки, включая многоточие.
- массив
$optionsнеобязательно [] - Массив опций.
Возвращает
stringОбрезанная строка.
toListsource public static
toList( array $list , string $and null , string $separator ', ' )
Создаёт список, разделённый запятыми, где последние два элемента соединены со словом «и», формируя естественный язык.
Параметры
- массив
$list - Список для объединения.
- строка
$andнеобязательно null - Слово, используемое для соединения последних двух элементов. По умолчанию «и».
- строка
$separatorнеобязательно ', ' - Разделитель, используемый для соединения остальных элементов. По умолчанию запятая и пробел.
Возвращает
stringОбъединённая строка.
Ссылка
http://book.cakephp.org/3.0/ru/core-libraries/string.html#converting-an-array-to-sentence-formtokenizesource public static
tokenize( string $data , string $separator ',' , string $leftBound '(' , string $rightBound ')' ) Токенизирует строку, используя $separator, игнорируя любые вхождения $separator, которые появляются между $leftBound и $rightBound.
Параметры
- строка
$data - Данные для токенизации.
- строка
$separatorнеобязательно ',' - Токен для разделения данных.
- строка
$leftBoundнеобязательно '(' - Левая граница для игнорирования разделителей.
- строка
$rightBoundнеобязательно ')' - Правая граница для игнорирования разделителей.
Возвращает
array|stringМассив токенов в $data или исходный ввод, если он пуст.
truncatesource public static
truncate( string $text , integer $length 100 , array $options [] )
Обрезает текст.
Усекает строку до длины $length и заменяет последние символы многоточием, если текст длиннее длины.
Опции:
-
ellipsisБудет использоваться в качестве окончания и добавлен к обрезанной строке -
exactЕсли false, $text не будет обрезаться по середине слова -
htmlЕсли true, теги HTML будут обработаны корректно
Параметры
- строка
$text - Строка для обрезки.
- целое число
$lengthнеобязательно 100 - Длина возвращаемой строки, включая многоточие.
- массив
$optionsнеобязательно [] - Массив атрибутов и опций HTML.
Возвращает
stringОбрезанная строка.
Ссылка
http://book.cakephp.org/3.0/ru/core-libraries/string.html#truncating-textutf8source public static
utf8( string $string )
Преобразует строку с многобайтовыми символами в десятичное значение символа
Параметры
- строка
$string - Строка для преобразования.
Возвращает
arrayмассив
uuidsource public static
uuid( )
Генерирует случайный UUID версии 4
Предупреждение: Этот метод не должен использоваться в качестве случайного зерна для каких-либо криптографических операций. Вместо этого используйте расширения openssl или mcrypt.
Возвращает
stringUUID RFC 4122
Авторские права
Matt Farina MIT License https://github.com/lootils/uuid/blob/master/LICENSEСм.
http://www.ietf.org/rfc/rfc4122.txtwordWrapsource public static
wordWrap( string $text , integer $width 72 , string $break "\n" , boolean $cut false )
Unicode и новая строка - осознанный вариант wordwrap.
Параметры
- строка
$text - Текст для форматирования.
- целое число
$widthнеобязательно 72 - Ширина для обрезки. По умолчанию 72.
- строка
$breakнеобязательно "\n" - Строка, используемая для разрыва строки. По умолчанию '\n'.
- логический тип
$cutнеобязательно false - Если обрезка установлена в true, строка всегда обрезается до указанной ширины.
Возвращает
stringОтформатированный текст.
wrapsource public static
wrap( string $text , array|integer $options [] )
Обрезает текст до определённой ширины, необязательно обрезая по словам.
Опции
-
widthШирина обрезки. По умолчанию 72. -
wordWrapОбрезать только по словам (пробелам). По умолчанию true. -
indentСтрока для отступа. По умолчанию null. -
indentAtИндекс отступа, начиная с 0. По умолчанию 0.
Параметры
- строка
$text - Текст для форматирования.
- массив|целое число
$optionsнеобязательно [] - Массив опций или целое число для обрезки текста.
Возвращает
stringОтформатированный текст.
wrapBlocksource public static
wrapBlock( string $text , array|integer $options [] )
Обрезает весь блок текста до определённой ширины, необязательно обрезая по словам.
Опции
-
widthШирина обрезки. По умолчанию 72. -
wordWrapОбрезать только по словам (пробелам). По умолчанию true. -
indentСтрока для отступа. По умолчанию null. -
indentAtИндекс отступа, начиная с 0. По умолчанию 0.
Параметры
- строка
$text - Текст для форматирования.
- массив|целое число
$optionsнеобязательно [] - Массив опций или целое число для обрезки текста.
Возвращает
stringОтформатированный текст.
© 2005–2016 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.
http://api.cakephp.org/3.1/class-Cake.Utility.Text.html