Класс 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() )

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

Параметры

строка $str

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

массив $data

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

массив $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

Текст, который нужно усечь.

целое число $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.

Параметры

строка $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 Текст для отступа. По умолчанию null.
• indentAt Индекс для начала отступа. По умолчанию 0.

Параметры

строка $text

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

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

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

Возвращает