Add documentation for length modifier

Fix documentation for truncate modifier
This commit is contained in:
bzick 2013-03-18 10:45:07 +04:00
parent 3fe541029c
commit 281757b902
2 changed files with 13 additions and 3 deletions

8
docs/mods/length.md Normal file
View File

@ -0,0 +1,8 @@
Modifier length [RU]
====================
Модификатор возвращает длину значения переменной
* если массив - длина массива
* если итератор - длина итератора
* если строка - длина строки (поддерживается UTF8 и не требует `mbstring`)

View File

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