Класс CakeText

_wordWrap()source защищенное статическое

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

Вспомогательный метод для wordWrap().

Параметры

строка $text

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

целое число $width необязательный 72

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

строка $break необязательный "\n"

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

логическое значение $cut необязательный false

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

Возвращает

cleanInsert()source публичное статическое

cleanInsert( string $str , array $options )

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

Параметры

строка $str

CakeText для очистки.

массив $options

Список параметров.

Возвращает

См. также

excerpt()source публичное статическое

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

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

Параметры

строка $text

CakeText для поиска фразы в нём

строка $phrase

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

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

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

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

Заключительный символ, который будет добавлен

Возвращает

Ссылка

highlight()source публичное статическое

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

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

Параметры:

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

Параметры

строка $text

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

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

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

массив $options необязательный массив()

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

Возвращает

Ссылка

insert()source публичное статическое

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

Заменяет переменные заполнители внутри $str любыми заданными $data. Каждый ключ в массиве $data соответствует имени переменного заполнителя в $str. Пример: CakeText::insert(':name is :age years old.', array('name' => 'Bob', '65')); Возвращает: Боб — 65 лет.

Доступны следующие $options:

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

Параметры

строка $str

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

массив $data

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

массив $options необязательный массив()

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

Возвращает

stripLinks()source публичное статическое

stripLinks( string $text )

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

Параметры

строка $text

Текст

Возвращает

Ссылка

tail()source public static

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

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

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

Параметры:

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

Параметры

строка $text

Обрезаемый CakeText.

целое число $length опционально 100

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

массив $options опционально массив()

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

Возвращает

toList()source public static

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

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

Параметры

массив $list

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

строка $and опционально null

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

строка $separator опционально ', '

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

Возвращает

Ссылка

tokenize()source public static

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

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

Параметры

строка $data

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

строка $separator опционально ','

Токен для разделения данных.

строка $leftBound опционально '('

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

строка $rightBound опционально ')'

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

Возвращает

truncate()source public static

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

Укорачивает текст.

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

Параметры:

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

Параметры

строка $text

CakeText для укорачивания.

целое число $length опционально 100

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

массив $options опционально массив()

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

Возвращает

Ссылка

uuid()source public static

uuid( )

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

Возвращает

См.

wordWrap()source public static

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

Многоязычная версия wordwrap.

Параметры

строка $text

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

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

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

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

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

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

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

Возвращает

wrap()source public static

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

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

Параметры

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

Параметры

строка $text

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

массив|целое число $options опционально массив()

Массив параметров для использования, или целое число для обрезки текста.

Возвращает