Документация для разработчиков
Недоступно в редакциях: Старт

Веб-форма (комплексный компонент)

Комплексный компонент, создавая физически только одну страницу, позволяет получить несколько страниц: заполнение веб-формы, со списком результатов, редактирование результата, просмотр результата и т.д. Компонент стандартный и входит в дистрибутив модуля.

В структуре визуального редактора компонент расположен по пути Сервисы > Веб-формы > Веб-форма.

Компонент относится к модулю Веб-формы.

Пример вызова компонента form

Секции настроек компонента:

  • Основные параметры
  • Источник данных
  • Внешний вид
  • Управление адресами страниц
  • Управление режимом AJAX
  • Настройки кеширования
  • Дополнительные настройки
  • Описание параметров

    Поле Параметр Описание
    Основные параметры
    Начальная страница START_PAGE Указывается начальная страница:
    • new - страница добавления результата, т.е. будет представлена выбранная веб-форма для заполнения;
    • list - страница со списком результатов данной формы.
    Показывать страницу со списком результатов SHOW_LIST_PAGE [Y|N] Если значение параметра START_PAGE равно new, то при отмеченной опции пользователь после заполнения результата будет переведен на страницу со списком результатов. Если же в качестве начальной страницы указано list, то вне зависимости от этой опции выведется страница результатов.
    Показывать страницу редактирования результата SHOW_EDIT_PAGE [Y|N] При отмеченной опции на странице со списком результатов будет присутствовать ссылка Изменить на редактирование результата.

    Примечание:количество записей на странице со списком результатов зависит от прав доступа пользователя, установленных в настройках формы и в настройках ее статуса.

    Показывать страницу просмотра результата SHOW_VIEW_PAGE [Y|N] При отмеченной опции на странице со списком результатов будет присутствовать ссылка на просмотр результата.

    Примечание: количество записей на странице со списком результатов зависит от прав доступа пользователя, установленных в настройках формы и в настройках ее статуса.

    Страница с сообщением об успешной отправке SUCCESS_URL Указывается путь к странице с сообщением об успешной отправке результата формы. Используется при отправке результата пользователем без прав редактирования результата.
    Источник данных
    ID веб-формы WEB_FORM_ID Указывается идентификатор веб-формы.
    ID результата RESULT_ID Указывается идентификатор результата заполнения формы. По умолчанию указано $_REQUEST["RESULT_ID"], но также может быть записан php-код, возвращающий RESULT_ID.
    Внешний вид
    Показать значение параметра ANSWER_VALUE SHOW_ANSWER_VALUE [Y|N] При отмеченной опции для показа будет выведено значение параметра ANSWER_VALUE вопроса веб-формы (выводится рядом со значением ответа).
    Показать дополнительные поля веб-формы SHOW_ADDITIONAL [Y|N] При отмеченной опции будут выведены дополнительные поля формы при их наличии.
    Показать текущий статус результата SHOW_STATUS [Y|N] При отмеченной опции статус текущего результата будет отображатся на странице со списком результатов.
    Выводить на редактирование дополнительные поля EDIT_ADDITIONAL [Y|N] При отмеченной опции дополнительные поля будут выводиться на редактирование.
    Выводить форму смены статуса EDIT_STATUS [Y|N] При отмеченной опции с учётом того, что значение параметра SHOW_STATUS равно Y, будет отображена форма смены статуса. Список доступных статусов в форме зависит от прав доступа, установленных для данной группы в настройках статусов формы.
    Коды полей, которые нельзя показывать в фильтре NOT_SHOW_FILTER Указываются коды полей, которые нельзя показывать в фильтре. Можно исключить те поля веб-формы, которые не должны отображаться в фильтре на странице со списком результатов.

    Примечание: чтобы поле отображалось в фильтре на странице со списком результатов, для данного вопроса должна быть заполнена закладка Фильтр в форме редактирования вопроса веб-формы в расширенном режиме.

    Коды полей, которые нельзя показывать в таблице NOT_SHOW_TABLE Указываются коды полей, которые нельзя показывать в таблице. Можно исключить те поля веб-формы, которые не должны отображаться в таблице на странице со списком результатов веб-формы.
    Игнорировать свой шаблон IGNORE_CUSTOM_TEMPLATE [Y|N] При отмеченной опции для отображения веб-формы будет использоваться шаблон формы по умолчанию, даже если создан свой шаблон.
    Использовать расширенный вывод сообщений об ошибках USE_EXTENDED_ERRORS [Y|N] При отмеченной опции будет использован расширенный вывод сообщений об ошибках.
    Управление адресами страниц
    Включить поддержку ЧПУ SEF_MODE [Y|N] При отмеченной опции будет включена поддержка ЧПУ.

    Если режим поддержки ЧПУ включен, то необходимо настроить следующие параметры:
    Каталог ЧПУ (относительно корня сайта) SEF_FOLDER Каталог ЧПУ: путь до папки, с которой работает компонент. Этот путь может как совпадать с физическим путём, так и не совпадать.
    Адреса страниц SEF_URL_TEMPLATES Указываются адреса следующих страниц:
    • new - cтраница добавления результата;
    • list - cтраница списка результатов;
    • edit - cтраница редактирования результата;
    • view - cтраница просмотра результата.
    SEF_FOLDER, SEF_URL_TEMPLATES.

    Если режим поддержки ЧПУ выключен, то необходимо настроить параметр ACTION
    Имя переменной действия ACTION Указывается имя переменной действия.
    .
    Управление режимом AJAX
    Включить режим AJAX AJAX_MODE [Y|N] При установленной опции для компонента будет включен режим AJAX.
    Включить прокрутку к началу компонента AJAX_OPTION_JUMP [Y|N] Если пользователь совершит AJAX-переход, то при установленой опции по окончании загрузки произойдет прокрутка к началу компонента.
    Включить подгрузку стилей AJAX_OPTION_STYLE [Y|N] Если параметр принимает значение "Y", то при совершении AJAX-переходов будет происходить подгрузка и обработка списка стилей, вызванных компонентом.
    Включить эмуляцию навигации браузера AJAX_OPTION_HISTORY [Y|N] Когда пользователь выполняет AJAX-переходы, то при включенной опции можно использовать кнопки браузера Назад и Вперед.
    Настройки кеширования
    Тип кеширования CACHE_TYPE Тип кеширования:
    • A - Авто + Управляемое: автоматически обновляет кеш компонентов в течение заданного времени или при изменении данных;
    • Y - Кешировать: для кеширования необходимо определить время кеширования;
    • N - Не кешировать: кеширования нет в любом случае.
    Время кеширования (сек.) CACHE_TIME Время кеширования, указанное в секундах. По умолчанию поле содержит 3600 сек.
    Дополнительные настройки
    Название дополнительного пункта в навигационной цепочке CHAIN_ITEM_TEXT Указывается название дополнительного пункта в навигационной цепочке. Если оставить незаполненным, то в навигационную цепочку пункт не добавляется.
    Ссылка на дополнительном пункте в навигационной цепочке CHAIN_ITEM_LINK Указывается ссылка, которая будет показана на дополнительном пункте меню в навигационной цепочке.


    Пользовательские комментарии

    Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.

    Для этого нужно всего лишь авторизоваться на сайте

    Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

    Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
    © «Битрикс», 2001-2020, «1С-Битрикс», 2020
    Наверх