Класс CakeText

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

Параметры

строка $str

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

массив $data

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

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

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

Возвращает

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

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 )

Unicode-совместимая версия 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. По умолчанию 0.

Параметры

строка $text

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

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

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

Возвращает