fenom/docs/mods/truncate.md
bzick 281757b902 Add documentation for length modifier
Fix documentation for truncate modifier
2013-03-18 10:45:07 +04:00

22 lines
1.5 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

Modifier truncate [RU]
=======================
Обрезает строку до указанной длины. Может обрезать как ровно по символу так и завершивемогуся слову, где итоговоя строка не привыет указанной длины.
```smarty
{$long_string|truncate:$length:$etc:$by_words:$middle}
```
* `$length` обязательный параметр, указывающий максимальную длину выводимой сроки
* `$etc`, по умолчанию `...`, содержащий строку которой будет заменены "лишние" символы.
* `$by_word`, по умолчанию **FALSE**. Флаг указывает модификатору не разбивать слово, а найти ближайший (в меньшую строну) пробельный символ, после которого строка буде обрезана
* `$middle`, по умочанию **FALSE**. Включенный флаг, который указывает, что "лишние" данные нужно вырезать из середины строки, а не из конца.
```smarty
{var $str = "very very long string"}
{$str|truncate:10:" read more..."} output: very very read more...
{$str|truncate:5:" ... ":true:true} output: very ... string
```
Модификатор работает отлично с UTF8 и не требует расширения `mbstring`