[Evo] Документация eForm
Обязательные параметры
&formid | Необходим если на странице используется более одной формы. Шаблон вашей формы должен иметь скрытое поле с тем же идентификатором: <input type="hidden" name="formid" value="formName" /> или (начиная с eForm 1.4.x) вы можете установить идентификатор прямо в теге формы: <form id="formName"...>; |
&tpl | Название чанка (не число) или id документа (число) для используемого шаблона. Вы можете также использовать сниппет как источник шаблона. При этом никакие параметры не передаются. Для регулярных полей формы вам не нужно включать переменные, так как они автоматически включаются eForm, исключая случаи когда вы сами задаете значения. Доступны специальные переменные: , , и . Каждая форма должна содержать переменную . |
&report | Название чанка (не число) или идентификатор документа (число) для шаблона отчета. Должна содержать каждая форма. |
Дополнительные параметры (самые популярные из них)
&to | Адрес Email на который будет послана информация. Можно использовать несколько адресов разделяя их запятой (,). Если не указано, то будет использован системный адрес. |
&from | Устанавливает адрес отправителя письма. |
&fromname | Устанавливает имя отправителя письма. |
&replyto | Электронный адрес или поле содержащее адрес, который будет использован в письме для ответа. |
&sendirect |
Включает возможность использовать поле формы для определения адреса, по которому будет послано письмо.
|
&ccsender |
Послать копию данных формы пользователю. По умолчанию установлено в 0. eForm ищет адрес пользователя в поле с названием email.
|
&subject | Тема сообщения, которая может включать [.поля формы.]. Например: Спасибо за ваш заказ [.firstname.] [.lastname.] |
&noemail |
Защищает eForm от посылки писем.
|
&mailselector |
Устанавливает поле формы, которое будет использоваться при выборе единственного адреса из списка адресов разделенных запятой (,) для использования в параметре &to. Значения поля будет определять номер используемого почтового адреса. Номер 1 соответствует первому адресу и N - последнему. Пример: &to =`sales@me.com,support@me.com,billing@me.com` &mailselector=`topic` В форме используется поле topic в виде выпадающего списка. Когда пользователь выбирает значение, то тем самым он определяет один адрес, по которому будут посланы данные формы. |
&mobile | Адрес почты мобильного устройства. Используется для отсылки короткого сообщения. |
&mobiletext | Сообщение для отправки на мобильное устройство. Может содержать [.поля формы.]. Например: Заказ для [.firstname.]. |
&thankyou | Название чанка (не число) или идентификатор документа (число) для используемого шаблона сообщения выводимого пользователю после отправки данных формы. Теги как у &tpl |
&gotoid | Идентификатор документа на который будет совершен переход после отправки данных формы. Смотрите также &thankyou. |
&category | Название или идентификатор категории используемый для категоризации eForm. Если категория не найдена, то она автоматически будет создана. Это используется в теме сообщение. |
&allowhtml |
Включает использовании пользователями HTML в сообщении.
|
&language | Устанавливает используемый язык сообщений и проверки. Название языков совпадает с MODx. |
&vericode | Включает код проверки. Шаблон должен содержать поле для проверки и переменную [+vericode+]. |
&submitLimit по умолчанию - 0 (выключено) | Устанавливает лимит времени (в минутах) между отправками данных формы. После первой успешной отправки данных запрещает отправку других данных на определенное время. При использовании совместно с &protectSubmit этот параметр имеет приоритет, позволяя повторную отправку данных независимо от установки &protectSubmit (будет сброшена сессионная переменная). Как и &protectSubmit этот параметр использует сессионную переменную основанную на &formid. |
&protectSubmit по умолчанию - 1 (включено) |
Защита формы от повторной отправки с теми же данными. Отправка данных формы автоматически отключается после первой успешной попытки пока ключ формы является одним и тем же. Для этого используется переменной сеанса с md5 хэшем в качестве ключа. Какие поля используются для сравнения задается в параметре &protectSubmit. Возможные значения:
Список полей - список используемых полей через запятую. Чтобы гарантировать, что используются соответствующие поля для разных форм переменная сессии основана на &formid ({formid}_hash). |
&requiredClass |
Название класса. Добавляет класс в определенные поля формы при проверке. Существующие классы будут сохранены. Если вы уже определили класс для полей или меток (label) и получили неожиданные результаты, то проверьте порядок определения классов. &requiredClass устанавливается в начало любых классов, которые уже установлены. |
&invalidClass |
Название класса. Добавляет класс к неправильно заполненным полям формы, которые выявились при проверке. Существующие классы будут сохранены. |
Функции событий
Функции событий eForm теперь включены в параметры.
&eFormOnBeforeMailSent
Определяет название функции. Эта функция будет запущена после того как форма будет проверена и перед отчетом и сообщением для пользователя, а также отправкой любых сообщений. Смотрите пример использования.
&eFormOnMailSent
Определяет название функции. Эта функция будет запущена после обработки всех шаблонов и любое сообщение будет послано.
&eformOnBeforeFormParse
Определяет название функции. Эта функция будет запущена после загрузки шаблонов и определения идентификатора формы. Функции передаются следующие параметры: &$templates - массив всех шаблонов с индексами 'tpl', 'report','thankyou' и 'autotext'. Последние три будут иметь значение только после отправки формы.
&eFormOnBeforeFormMerge
Определяет название функции. Эта функция будет запущена только при показе форм и до определения всех переменных шаблона. Функции передаются следующие параметры: &$fields - массив полей и значений переменных.
&eFormOnValidate
Определяет название функции. Эта функция будет запущена после проверки данных формы. Это можно использовать для определения собственного алгоритма обработки. Функции передаются следующие параметры:
- &$fields - массив полей и значений переменных
- &$vMsg - числовой массив ошибок проверки данных формы
- &$rMsg - числовой массив пропущенных обязательных полей
Переменные шаблона
- [+validationmessage+] - Можно разместить в любом метсе документа. Теперь все html окружение включается в значение $_lang['ef_validation_message'] в языковом файле eForm.
- [+vericode+] и [+verimageurl+] - необходимы если вы собираетесь использовать в форме капчу.
- [+postdate+] - эта переменная будет использована в отчете и сообщении для пользователя после отправки данных формы и установит текущую дату и время.
- [+debug+] - начиная с версии 1.4.1, автоматически устанавливается, если включен режим отладки, в форме и сообщении для пользователя после отправки. Не помещается автоматически в шаблон отчета. Необходимо избегать отправку технической информации через сервер. Если вы хотите протестировать отправку писем, то можете включить эту переменную самостоятельно.