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

Возвращает

string
Отформатированный текст.

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

cleanInsert( string $str , array $options )

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

Параметры

строка $str

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

массив $options

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

Возвращает

string
строка

См. также

CakeText::insert()

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

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

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

Параметры

строка $text

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

строка $phrase

Фраза, для которой будет осуществляться поиск

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

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

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

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

Возвращает

string
Изменённая строка

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/text.html#TextHelper::excerpt

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

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

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

Параметры:

• format Часть html, с которой будет выделена фраза
• html Если true, игнорирует все теги HTML, гарантируя, что выделяется только правильный текст
• regex пользовательское правило regex, используемое для сопоставления слов, по умолчанию '|$tag|iu'

Параметры

строка $text

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

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

Фраза или фразы, которые будут искаться.

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

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

Возвращает

string
Выделенный текст

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/text.html#TextHelper::highlight

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

Параметры

строка $str

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

массив $data

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

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

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

Возвращает

string
строка

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

stripLinks( string $text )

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

Параметры

строка $text

Текст

Возвращает

string
Текст без ссылок

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/text.html#TextHelper::stripLinks

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

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

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

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

Параметры:

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

Параметры

строка $text

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

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

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

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

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

Возвращает

string
Обрезанная строка.

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

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

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

Параметры

массив $list

Список, который нужно объединить.

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

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

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

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

Возвращает

string
Объединённая строка.

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/text.html#TextHelper::toList

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

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

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

Параметры

строка $data

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

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

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

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

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

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

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

Возвращает

mixed
Массив токенов в $data или исходный ввод, если он пуст.

truncatesource public static

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

Усекает текст.

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

Параметры:

• ellipsis Будет использоваться в качестве окончательного символа и добавляться к обрезанной строке (ending устарело)
• exact Если ложь, $text не будет обрезаться в середине слова
• html Если истина, HTML-теги будут обработаны правильно

Параметры

строка $text

Текст, подлежащий усечению.

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

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

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

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

Возвращаемое значение

string
Обрезанная строка.

Ссылка

http://book.cakephp.org/2.0/en/core-libraries/helpers/text.html#TextHelper::truncate

uuidsource public static

uuid( )

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

Возвращаемое значение

string
UUID по RFC 4122

См. также

http://www.ietf.org/rfc/rfc4122.txt

wordWrapsource public static

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

Многоязычная версия wordwrap.

Параметры

строка $text

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

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

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

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

Символ переноса строки. По умолчанию '\n'.

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

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

Возвращаемое значение

string
Отформатированный текст.

wrapsource public static

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

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

Параметры

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

Параметры

строка $text

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

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

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

Возвращаемое значение

string
Отформатированный текст.