====== Astra.CMS функции добавленные в язык шаблонов Smarty ======

В рамках Astra.CMS язык шаблонов расширен дополнительными функциями, которые вы можете использовать в шаблонах.

==== attachfile ====
Может использоваться только в шаблонах писем. Прикрепляет к письму файл.

^Имя аттрибута ^Тип ^Обязателен ^По умолчанию ^Описание ^
|id |целое число (integer) |Да |n/a  |Идентификатор зарегистрированного файла. |

==== block ====
Вставляет содержимое любого существующего блока по его идентификатору.

^Имя аттрибута ^Тип ^Обязателен ^По умолчанию ^Описание ^
|id |строка (string) |Да |n/a  |Идентификатор блока. |
|??? |строка (string) |Нет |Установленное для блока значение |Любой параметр для блока. Позволяет динамически менять значения параметров блока. |

<code smarty>
{* Вывод блока "список материалов" с идентифкатором articles и 
   указанием выборки по нужной категории. *}
{block id="articles" idcat=$idcat}
</code>

==== button ====
Формирует html код обычной кнопки.

^Имя аттрибута ^Тип ^Обязателен ^По умолчанию ^Описание ^
|caption |строка (string) |Нет |n/a  |Надпись на кнопке. |
|onclick |строка (string) |Нет |n/a  |javascript обработчик на нажатие. |
|width |целое число (integer) |Нет |120  |Ширина кнопки в пикселях. |
|class |строка (string) |Нет |button  |Класс стилей |
|??? |строка (string) |Нет |n/a |Любой дополнительный атрибут. |

==== captcha ====
Формирует html код картинки с контрольным кодом.

^Имя аттрибута ^Тип ^Обязателен ^По умолчанию ^Описание ^
|width |целое число (integer) |Нет |160  |Ширина картинки. |
|height |целое число (integer) |Нет |50  |Высота картинки. |
|??? |строка (string) |Нет |n/a |Любой дополнительный атрибут. |

==== counters ====
Вставляет код счетчиков на сайте. Содержимое берется из поля в настройках сайта (главная панели управления, закладка "Настройки").

==== dateselect ====
Формирует html код элемента управления для ввода даты/времени. 

^Имя аттрибута ^Тип ^Обязателен ^По умолчанию ^Описание ^
|name |строка (string) |Да |n/a  |Название поля. |
|time |timestamp |Нет |Текущее время  |Заданное время. |
|usetime |логическое (boolean) |Нет | false  | Использовать кроме даты выбор времени. |
|onchange |строка (string) |Нет |n/a  |javascript обработчик на событие выбора даты/времени |

Для использования на сайте необходимо подключить js скрипты:
  * /system/jsaculous/prototype.js 
  * /system/jsaculous/dateselect.js

А так же добавить стили следующего вида: {{:smarty:date_select_css.zip}}.

==== download ====
Используется для добавления ссылки на скачивание зарегистрированного файла.

^Имя аттрибута ^Тип ^Обязателен ^По умолчанию ^Описание ^
|id |целое число (integer) |Да, если не указан data |n/a  |Идентификатор зарегистрированного файла. |
|data |массив (array) |Да, если не указан id |n/a  |Массив с данными о файлах. |
|caption |строка (string) |Нет |Название файла |Текст ссылки.  |
|title |строка (string) |Нет |Скачать |Текст подсказки.  |
|size |логическое (boolean) |Нет |false  |Показывать размер файла. |
|dwnl |логическое (boolean) |Нет |false  |Показывать количество скачиваний. |
|separator |строка (string) |Нет |,  |Разделитель при выводе нескольких ссылок, если используется массив data. |
|max |целое число (integer) |Нет |n/a |Максимальное количество ссылок для вывода, если используется массив data. |
|??? |строка (string) |Нет |n/a |Любой дополнительный атрибут для ссылок. |

==== editbox ====
Формирует html код элемента управления для ввода строки.

^Имя аттрибута ^Тип ^Обязателен ^По умолчанию ^Описание ^
|name |строка (string) |Да |n/a  |Название поля. |
|text |строка (string) |Нет |n/a  |Заданный текст. |
|max |целое число (integer) |Нет |255  |Максимальная длина строки для ввода. |
|width |строка (string) |Нет |100%  |Ширина элемента |
|??? |строка (string) |Нет |n/a |Любой дополнительный атрибут. |

==== fckeditor ====
Формирует html код визуального редактора.

^Имя аттрибута ^Тип ^Обязателен ^По умолчанию ^Описание ^
|name |строка (string) |Да |n/a  |Название поля. |
|text |строка (string) |Нет |n/a  |Заданный текст. |
|height |целое число (integer) |Нет |300  |Высота редактора. |
|toolbar |строка (string) |Нет |Default |Тип панели, может принимать значения: Basic, Medium, Default. Не учитывается, если включена опция "Упрощенный визуальный редактор". |

==== filedata ====
Позволяет получить подробные данные о зарегистрированом файле по его идентификатору.

^Имя аттрибута ^Тип ^Обязателен ^По умолчанию ^Описание ^
|id |целое число (integer) |Да |n/a  |Идентификатор зарегистрированного файла. |
|var |строка (string) |Да |n/a  |Переменная шаблона в которую будет занесен массив данных. |

Формат полученного массива: [name, caption, path, link, mime, size, dwnl]
  * **name** - имя файла.
  * **caption** - описание файла.
  * **path** - путь к файлу на сервере.
  * **link** - ссылка для скачивания.
  * **mime** - тип файла.
  * **size** - размер файла.
  * **dwnl** - количество скачиваний.

<code smarty>
{filedata var="file" id=$idfile}

Файл <a href="{$file.link}" title="Скачать">{$file.name}</a> с размером {$file.size}
</code>

==== help ====
Позволяет добавить к любому html элементу всплывающую подсказку.

^Имя аттрибута ^Тип ^Обязателен ^По умолчанию ^Описание ^
|text |строка (string) |Да |n/a  |Текст или html код, который будет появляться при наведении на элемент. |
|width |целое число (integer) |Нет |300  |Ширина области. |
|fgcolor |строка (string) |Нет |#ffffee  |Цвет фона. |
|bgcolor |строка (string) |Нет |#cccccc  |Цвет рамки. |

<code smarty>
<span {help text="текст или код подсказки"}>текст надписи</span>
</code>

Для использования на сайте необходимо подключить js скрипт /system/jsoverlib/overlib.js

==== hidden ====
Формирует html код скрытого (hidden) поля. 

^Имя аттрибута ^Тип ^Обязателен ^По умолчанию ^Описание ^
|name |строка (string) |Да |n/a  |Название поля. |
|value |строка (string) |Нет |n/a  |Значение поля. |

==== ie6warning ====
Формирует html код предупреждения, в случае, если браузером пользователя является IE6. 

==== image ====
Формирует html код для вывода изображений, поддерживает автоматическое масштабирование картинок на стороне сервера с последующим кэшированием.

^Имя аттрибута ^Тип ^Обязателен ^По умолчанию ^Описание ^
|id |целое число (integer) |Да, если не указан data |n/a  |Идентификатор зарегистрированного изображения. |
|data |массив (array) |Да, если не указан id |n/a  |Массив с данными об изображениях. |
|src |строка (string) |Нет |n/a |Путь к файлу изображения (если не указаны id и data). |
|width |целое число (integer) |Нет |Реальная ширина, либо, если указан параметр height - полученное значение в результате масштабирования. |Требуемая ширина картинки. |
|height |целое число (integer) |Нет |Реальная высота, либо, если указан параметр width - полученное значение в результате масштабирования. |Требуемая высота картинки. |
|bevel |целое число (integer) |Нет |n/a |Добавляет эффект объемной рамки. Может принимать значения от 1 до 5. |
|imgid |строка (string) |Нет |n/a |Позволяет добавить атрибут id к формируемому тегу img. |
|popup |логическое (boolean) |Нет |false  |Позволяет открывать изображение в полном размере при клике на нем. |
|lightbox |логическое (boolean) |Нет |false  |Позволяет открывать изображение в полном размере с помощью lightbox при клике на нем (поддерживается режим слайдов при использовании параметра data). Для использования нужно задействовать в шаблоне [[smarty:smarty6#lightbox_init|lightbox_init]]. |
|??? |строка (string) |Нет |n/a |Любой дополнительный атрибут для формируемого тега img. |

<note tip>
Порядок параметров width и height влияет на способ масштабирования. Если первым идет параметр width, а затем height то картинка будет отмасштабирована по ширине и потом обрезана по высоте. Если наоборот, то масштабирование будет происходить по высоте без обрезания, при этом ширина картинки может получиться меньше заданной.
</note>

==== imagedata ====
Позволяет получить подробные данные о зарегистрированом изображении по его идентификатору. Используется в случаях, где недостаточно только показать изображение с помощью [[smarty:smarty6#image|image]], например если нужны полные пути картинок для использования в js скриптах.

^Имя аттрибута ^Тип ^Обязателен ^По умолчанию ^Описание ^
|id |целое число (integer) |Да |n/a  |Идентификатор зарегистрированного изображения. |
|var |строка (string) |Да |n/a  |Переменная шаблона в которую будет занесен массив данных. |

Формат полученного массива: [name, caption, path, mime, width, height]
  * **name** - имя файла.
  * **caption** - описание файла.
  * **path** - путь к файлу на сервере.
  * **mime** - тип файла.
  * **width** - ширина картинки.
  * **height** - высота картинки.

==== leftblocks ====
Выводит все блоки, для которых задано расположение "Слева".

^Имя аттрибута ^Тип ^Обязателен ^По умолчанию ^Описание ^
|separator |строка (string) |Нет |n/a  |Разделитель между блоками. |

==== lightbox_init ====
Добавляет необходимый html код для подключения стилей и скриптов при использовании lightbox.

==== loadlist ====
Загружает в указанную переменную список значений в виде ассоциированного массива.

^Имя аттрибута ^Тип ^Обязателен ^По умолчанию ^Описание ^
|var |строка (string) |Да |n/a  |Переменная шаблона в которую будет занесен массив значений. |
|list |строка (string) |Да |n/a  |Строковой идентификатор списка значений, созданного в [[:admin:site#дополнения|дополнениях]] панели управления. |

<code smarty>
{loadlist var="names" list="names"}

<select name="name">
    {html_options options=$names}
</select>
</code>

==== object ====
Используется для вывода переменных-объектов. Например для вывода объектов A_Pager или A_Navigation, которые могут присутствовать на странице. Проверяет существование объекта.

^Имя аттрибута ^Тип ^Обязателен ^По умолчанию ^Описание ^
|obj |объект (object) |Да |n/a  |Специальный объект. |

==== rightblocks ====
Выводит все блоки, для которых задано расположение "Справа".

^Имя аттрибута ^Тип ^Обязателен ^По умолчанию ^Описание ^
|separator |строка (string) |Нет |n/a  |Разделитель между блоками. |

==== selectnamebyid ====
Выводит значение из списка по заданному идентификатору.
^Имя аттрибута ^Тип ^Обязателен ^По умолчанию ^Описание ^
|id |целое число (integer) |Да |n/a  |Идентификатор значения в списке. |
|list |строка (string) |Да |n/a  |Строковой идентификатор списка значений, созданного в [[:admin#дополнения|дополнениях]] панели управления. |

==== submit ====
Формирует html код кнопки отправки для формы.

^Имя аттрибута ^Тип ^Обязателен ^По умолчанию ^Описание ^
|caption |строка (string) |Нет |n/a  |Надпись на кнопке. |
|width |целое число (integer) |Нет |120  |Ширина кнопки в пикселях. |
|class |строка (string) |Нет |submit  |Класс стилей |
|??? |строка (string) |Нет |n/a |Любой дополнительный атрибут. |

==== textarea ====
Формирует html код поля для редактирования текста.

^Имя аттрибута ^Тип ^Обязателен ^По умолчанию ^Описание ^
|name |строка (string) |Да |n/a  |Название поля. |
|text |строка (string) |Нет |n/a  |Заданный текст. |
|rows |целое число (integer) |Нет |5  |Количество строк в редакторе. |
|width |строка (string) |Нет |100%  |Ширина элемента |
|??? |строка (string) |Нет |n/a |Любой дополнительный атрибут. |