Класс 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. По умолчанию используется метод text, но также доступен метод 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() )

Выделяет заданную фразу в тексте. Вы можете указать любое выражение в highlighter, которое может включать выражение \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() )

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

Доступные $options:

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

Параметры

строка $str

Строка, содержащая placeholder переменных

массив $data

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

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

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

Возвращает

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

stripLinks( string $text )

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

Параметры

строка $text

Текст

Возвращает

Ссылка

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

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

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

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

Опции:

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

Параметры

строка $text

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

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

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

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

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

Возвращает

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

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

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

Параметры

массив $list

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

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

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

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

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

Возвращает

Ссылка

tokenizeисходный код public static

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

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

Параметры

строка $data

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

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

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

строка $leftBound необязательно '('

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

строка $rightBound необязательно ')'

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

Возвращает

truncatesource 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.

Возвращает

Ссылка

uuidsource public static

uuid( )

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

Возвращает

См. также

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, строка всегда обрезается на указанную ширину.

Возвращает

wrapsource public static

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

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

Параметры

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

Параметры

строка $text

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

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

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

Возвращает