Класс String

_wordWrap()исходный код защищённый статический

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

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

Параметры

строка $text

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

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

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

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

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

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

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

Возвращает

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

cleanInsert( string $str , array $options )

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

Параметры

строка $str

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

массив $options

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

Возвращает

См. также

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

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

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

Параметры

строка $text

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

строка $phrase

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

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

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

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

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

Возвращает

Ссылка

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

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

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

Опции:

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

Параметры

строка $text

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

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

Искомая фраза или фразы.

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

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

Возвращает

Ссылка

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

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

Параметры

строка $str

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

массив $data

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

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

Массив опций, см. описание выше

Возвращает

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

stripLinks( string $text )

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

Параметры

строка $text

Текст

Возвращает

Ссылка

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

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

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

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

Опции:

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

Параметры

строка $text

CakeText для обрезки.

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

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

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

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

Возвращает

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

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

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

Параметры

массив $list

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

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

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

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

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

Возвращает

Ссылка

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

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.

Параметры

строка $text

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

массив|целое число $options необязательно массив()

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

Возвращает