Документация для разработчиков
Темная тема

Класс CForm

CForm - класс для работы с веб-формами.

Поля

Поле Тип Описание
ID int Идентификатор веб-формы.
SID varchar(50) Символьный идентификатор веб-формы.
TIMESTAMP_X datetime Время последнего изменения веб-формы.
NAME varchar(255) Заголовок веб-формы.
BUTTON varchar(255) Подпись на кнопки при заполнении веб-формы или редактировании результата.
C_SORT int Индекс сортировки.
IMAGE_ID int ID изображения веб-формы.
DESCRIPTION varchar(2000) Описание веб-формы.
DESCRIPTION_TYPE varchar(4) Тип описания веб-формы ("text" или "html").
MAIL_EVENT_TYPE varchar(50) Идентификатор типа почтового события.
FILTER_RESULT_TEMPLATE varchar(2000) Путь к скрипту, отображающему фильтр по результатам веб-форм в административной части модуля.
TABLE_RESULT_TEMPLATE varchar(2000) Путь к скрипту, отображающему таблицу результатов веб-форм в административной части модуля.
STAT_EVENT1 varchar(255) Идентификатор EVENT1 типа события для модуля "Статистика".
STAT_EVENT2 varchar(255) Идентификатор EVENT2 типа события для модуля "Статистика".
STAT_EVENT3 varchar(255) Дополнительный параметр события для модуля "Статистика".

Методы для работы с веб-формой

Метод Описание С версии
Set Добавляет новую веб-форму, либо обновляет параметры существующей. 4.0.4
SetMailTemplate Создает тип почтового события и почтовые шаблоны для веб-формы.
GetList Возвращает список веб-форм.
GetByID Возвращает параметры веб-формы по ее цифровому идентификатору.
GetBySID Возвращает параметры веб-формы по ее символьному идентификатору. 3.3.10
GetDataByID Возвращает массивы, описывающие вопросы и поля веб-формы.
GetResultAnswerArray Возвращает массивы, описывающие вопросы и поля веб-формы, а также ответы и их значения.
GetPermission Возвращает право пользователя на веб-форму.
Copy Копирует веб-форму. 4.0.4
Reset Удаляет все результаты веб-формы.
Delete Удаляет веб-форму и все ее результаты.
Check Проверяет введенные значения на обязательность, правильность формата даты и правильность типа файла.

Методы, возвращающие HTML код полей фильтра

Метод Описание С версии
GetTextFilter Однострочное текстовое поле для фильтрации текстовых значений.
GetDateFilter Два поля для ввода интервала дат.
GetDropDownFilter Выпадающий список одиночного выбора.
GetNumberFilter Два поля для ввода числового интервала.
GetExistFlagFilter Флаг, используемый для фильтрации по факту существования ответа на вопрос. 4.0.4

Методы, возвращающие HTML код полей для ввода ответов на вопросы веб-формы

Метод Описание С версии
GetTextField Однострочное текстовое поле для ввода текста.
GetTextAreaField Многострочное текстовое поле для ввода текста.
GetPasswordField Однострочное текстовое поле для ввода пароля. 3.3.0
GetDateField Поле для ввода даты.
GetRadioField Переключатель одиночного выбора.
GetCheckBoxField Флаг множественного выбора.
GetDropDownField Выпадающий список одиночного выбора.
GetMultiSelectField Список множественного выбора.
GetFileField Поле для ввода файла.

Методы получения текущего значения поля

Метод Описание С версии
GetTextValue Возвращает текущее значение для однострочного текстового поля.
GetTextAreaValue Возвращает текущее значение для многострочного текстового поля.
GetPasswordValue Возвращает текущее значение для поля ввода пароля. 3.3.0
GetDateValue Возвращает текущее значение для поля ввода даты.
GetRadioValue Возвращает текущее значение для переключателя одиночного выбора.
GetCheckBoxValue Возвращает текущее значение для флага множественного выбора.
GetDropDownValue Возвращает текущее значение для выпадающего списка одиночного выбора.
GetMultiSelectValue Возвращает текущее значение для списка множественного выбора.

Дополнительные методы

Метод Описание С версии
IsAdmin Возвращает "true", если текущий пользователь имеет административные права на модуль Веб-формы, в противном случае - "false". 4.0.4


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

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

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

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

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