Spec-Zone.ru › CakePHP 3.1

Класс Текст

Методы обработки текста.

Пространство имён: Cake\Утилиты
Расположено в Utility/Text.php

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

_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-excerpt

highlightисходный код публичный статический

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-substrings

insertисходный код публичный статический

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: Регулярное выражение для сопоставления переменных заготовок. По умолчанию: /(?<!\&#x29;\:%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.html

stripLinksисходный код публичный статический

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
Обрезанная строка.
END_OF_DOCUMENT_MARKER

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-form

tokenizesource 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-text

utf8source public static

utf8( string $string )

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

Параметры

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

Возвращает

array
массив

uuidsource public static

uuid( )

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

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

Возвращает

string
UUID RFC 4122

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

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

См.

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

wordWrapsource 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

Spec-Zone.ru

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