Класс CakeText

_wordWrap()source protected static

_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 public static

cleanInsert( string $str , array $options )

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

Параметры

строка $str

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

массив $options

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

Возвращает

См. также

excerpt()source public static

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

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

Параметры

строка $text

CakeText, в котором будет производиться поиск фразы

строка $phrase

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

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

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

строка $ellipsis опционально '...'

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

Возвращает

Ссылка

highlight()source public static

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 public static

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

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

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

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

Возвращает

stripLinks()source public static

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 ', ' )

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

Параметры

массив $list

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

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

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

строка $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 необязательно массив()

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

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