Класс String

_wordWrap()исходный код 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()исходный код public static

cleanInsert( string $str , array $options )

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

Параметры

строка $str

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

массив $options

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

Возвращает

См. также

excerpt()исходный код public static

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

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

Параметры

строка $text

CakeText для поиска фразы

строка $phrase

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

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

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

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

Конец, который будет добавлен

Возвращает

Ссылка

highlight()исходный код 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()исходный код 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: boolean или массив с инструкциями для CakeText::cleanInsert

Параметры

строка $str

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

массив $data

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

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

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

Возвращает

stripLinks()исходный код public static

stripLinks( string $text )

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

Параметры

строка $text

Текст

Возвращает

Ссылка

tail()исходный код public static

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

Усекает текст, начиная с конца.

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

Параметры:

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

Параметры

строка $text

CakeText для усечения.

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

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

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

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

Возвращает

toList()исходный код public static

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

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

Параметры

массив $list

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

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

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

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

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

Возвращает

Ссылка

tokenize()исходный код 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 Если ложь, $text не будет обрезаться посреди слова
• html Если истина, HTML-теги будут обработаны корректно

Параметры

строка $text

Текст CakeText для усечения.

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

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

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

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

Возвращает

Ссылка

uuid()source public static

uuid( )

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

Возвращает

См. также

wordWrap()source public static

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

Версия wordwrap, учитывающая Unicode.

Параметры

строка $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-based). По умолчанию 0.

Параметры

строка $text

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

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

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

Возвращает