» » UniForm — модуль универсальных ajax-форм для DataLife Engine

UniForm — модуль универсальных ajax-форм для DataLife Engine

16.03
658
55 847
UniForm — модуль универсальных ajax-форм для DataLife Engine

Не подходит стандартная форма обратной связи? Нужна возможность использовать свои поля? Нужна защита от ботов и лёгкая настройка без использования БД? Тогда этот модуль для Вас!

Преимущества


  • Не использует БД. Для работы модуля не требуется дополнительное соединение с БД и он не хранит данные из форм.
  • Скорость работы. За счёт простоты реализации удалось достичь приемлемой скорости работы.
  • Лёгкость настройки и стилизации. Все настройки модуля, оформление email-сообщения и самой формы вынесены в файлы шаблона, а это значит, что вы можете кастомизировать внешний вид не только формы, но и email-сообщения так, как этого требует дизайн.
  • AJAX вызов и отправка форм. Это даёт максимальную защиту от автоматических заполнений и не обременяет пользователя разгадкой каптчи.


Требования к установке


  • Версия DLE: 10.2 и выше.
  • PHP 5.4 и выше.
  • Прямые руки.


Установка


  • Скачать актуальную версию модуля
  • Распаковать содержимое папки DLE-UniForm-X.X.X (X.X.X - номер актуальной версии модуля) в корень сайта.
  • В браузере запустить установку модуля по адресу: ваш_сайт/dle_module_install.php?module=uniform
  • Следовать инструкциям


Скриншоты форм, поставляемых в комплекте с модулем



Форма обратной связи


Форма обратной связи, с ошибками


Сообщение об успешной отправке сообщения из формы обратной связи


Форма заказа звонка


Форма заказа звонка, в процессе отправки


Email, с заказом звонка


Тестовая форма с примером обработки результатов отправки формы


Настройка


  • Описание и примеры конфигурации вызова модуля можно найти в файлах, с именем config.tpl.
  • Описание и примеры параметров формы можно найти в файле {THEME}/uniform/test/form.tpl.
  • Описание и примеры параметров email-сообщения можно найти в файле {THEME}/uniform/callback/email.tpl.


Параметры, доступные в файле конфигурации (config.tpl):


  • templateFolder — Папка с шаблонами формы формы. Указывается подпапка, в папке uniform текущего шаблона сайта, в которой должны лежать файлы config.tpl, form.tpl и email.tpl. Например шаблон формы обратной связи (feedback) выглядит так:
    {THEME}/uniform/
    └── feedback/ 
        ├── config.tpl - файл конфига
        ├── email.tpl - файл email-сообщения
        └── form.tpl - файл вывода формы

  • nocache — Отключение кеширования модуля.
  • debug — Дебаг. Выводится распечатка конфига, массива данных, переданных через $_POST и массива данных, отправляемых на email.
  • required — Обязательные поля. Указываются имена полей, обязательных для заполнения.
  • hidden — Разрешенные скрытые поля. Такие поля передаются из атрибута data-uf-settings кнопки открытия формы. Например, если к кнопке открытия формы прописать
    data-uf-settings='{"formConfig": "feedback", "fields":{"field1": "value1", "field2": "value2", "field3": "value3"}}'
    и при этом в конфиге будет вот такая запись:
    hidden = field1,field3
    то поле field2 не будет выведено в форму. Это сделано для безопасности работы модуля.
  • sendmail — Отправлять email при заполнения формы?
  • emails — Адреса почты, на которые необходимо отправлять уведомление. Необходимо прописать один или несколько email-адресов, через запятую.
  • selectFields — Поля типа select. Необходимо перечислить через запятую имена всех полей, являющихся селектами.
  • checkboxFields — Поля типа checkbox. Необходимо перечислить через запятую имена всех полей, являющихся чекбоксами.
  • radioFields — Поля типа radio. Необходимо перечислить через запятую имена всех полей, являющихся радиокнопками.
  • sendAsPlain — Отправлять сообщение как простой текст.
  • sendToAuthor — Отправить письмо автору новости, если есть newsId (есть поле с name="newsId") и если автор разрешил получение писем с сайта.
  • sendToSender — Отправлять письмо так же на email, указанный в поле email.
  • allowAttachments — Разрешить прикрепление файлов.
  • maxFileSize — Максимальный размер загружаемого файла (в килобайтах).
  • allowedFileTypes — Разрешенные типы файлов, перечисляем расширения через запятую, без точек и пробелов.


Теги шаблонов


Список тегов, поддерживаемых в шаблоне form.tpl.
Вместо X следует прописывать имя инпута, селекта, чекбокса или радиокнопки. Имена не должны дублироваться.
  • {* текст *} — Служебный комментарий. Текст, заключенный в такие теги, не будет выведен в браузер.
  • [error]текст[/error] — выводит текст, если форма содержит ошибки заполнения.
  • [success]текст[/success] — выводит текст, если форма удачно отправлена.
  • [form]текст[/form] — выводит текст, если форма только что открыта, или отправлена с ошибками.
  • [debug]{debug}[/debug] — выводит дебаг.
  • [uf_token_error]текст[/uf_token_error] — выводит текст, если происходит попытка межсайтовой подделки запроса (CSRF Attack) или если конфиг формы изменился во время заполнения формы.
  • [uf_email_error]текст[/uf_email_error] — выводит текст, если поле имеет имя email, является обязательным и не проходит валидацию (наличие символа @ и точки).
  • [uf_default_value]текст[/uf_default_value] — выводит текст, если форма открыта впервые.
  • {uf_filed_X} — выводит данные, переданные в форму из текстовых полей в случаи ошибочного заполнения.
  • [uf_field_X="Y"]текст[/uf_field_X] — Выводит текст, если в текстовое поле X передано значение Y.
  • [uf_error_X]текст[/uf_error_X] — выводит текст, если текстовое поле содержит ошибку.
  • [uf_select_X="Y"]текст[/uf_select_X] — Выводит текст, если в селекте X отмечен пункт со значением Y.
  • [uf_select_X_Y]selected[/uf_select_X_Y] — Выводит текст, если в селекте X отмечен пункт со значением Y. Является вариацией предыдущего тега.
  • [uf_checkbox_X="Y"]текст[/uf_checkbox_X] — Выводит текст, если отмечен чекбокс с именем X, содержащий значение Y.
  • [uf_checkbox_X_Y]checked[/uf_checkbox_X_Y] — Выводит текст, если отмечен чекбокс с именем X, содержащий значение Y. Является вариацией предыдущего тега.
  • [uf_radio_X="Y"]текст[/uf_radio_X] — Выводит текст, если отмечена радиокнопка с именем X, содержащая значение Y.
  • [uf_radio_X_Y]checked[/uf_radio_X_Y] — Выводит текст, если отмечена радиокнопка с именем X, содержащая значение Y. Является вариацией предыдущего тега.


Список тегов, поддерживаемых в шаблоне email.tpl.
Вместо X следует прописывать имя инпута, селекта, чекбокса или радиокнопки. Имена не должны дублироваться.
  • {* текст *} — Служебный комментарий. Текст, заключенный в такие теги, не будет выведен в сообщении.
  • [header]текст[/header] — Тема письма.
  • {all_mail_fields} — выводит все поля, переданные из формы в удобном, для последующей вставке в шаблон, виде.
  • [uf_field_X]текст[/uf_field_X] — выводит текст, если текстовое пол X заполнено.
  • {X} — выводит данные, переданные в форму из текстового поля X.
  • [not_X]текст[/not_X] — Выводит текст, если в текстовое поле X пустое.
  • [uf_field_X="Y"]текст[/uf_field_X] — Выводит текст, если в текстовое поле X передано значение Y.
  • [uf_select_X="Y"]текст[/uf_select_X] — Выводит текст, если в селекте X отмечен пункт со значением Y.
  • [uf_checkbox_X="Y"]текст[/uf_checkbox_X] — Выводит текст, если отмечен чекбокс с именем X, содержащий значение Y.
  • [uf_radio_X="Y"]текст[/uf_radio_X] — Выводит текст, если отмечена радиокнопка с именем X, содержащая значение Y.
  • {send_date} — выводит дату отправки сообщения из формы, отформатированную в соответсвии с настройками DLE.
  • {current_page} — выводит URL страницы, с которой было отправлено сообщение.
  • [news_id]{news_id}[/news_id] — ID новости (если есть поле с name="newsId").
  • [news_autor]{news_autor}[/news_autor] — Логин автора новости (если есть поле с name="newsId").
  • [news_title]{news_title}[/news_title] — Заголовок новости (если есть поле с name="newsId").
  • [news_email]{news_email}[/news_email] — Email автора новости (если есть поле с name="newsId").
  • {site_home_title} — Выводит название сайта из настроек DLE.
  • {site_http_home_url} — Выводит адрес сайта из настроек DLE.
  • {site_short_title} — Выводит краткое название сайта из настроек DLE.
  • [user_name]{user_name}[/user_name] — Выводит логин пользователя, отправившего сообщение.
  • [user_fullname]{user_fullname}[/user_fullname] — Выводит полное имя пользователя, отправившего сообщение.
  • [user_email]{user_email}[/user_email] — Выводит email пользователя, отправившего сообщение.
  • [user_foto]{user_foto}[/user_foto] — Выводит ссылку на аватар пользователя, отправившего сообщение.
  • [user_land]{user_land}[/user_land] — Выводит то, что пользователь, отправивший сообщение, написал в поле "Место жительства".
  • [to_sender] текст [/to_sender] — Выводит текст для отправителя, если указан параметр sendToSender
  • [not_to_sender] текст [/not_to_sender] — Выводит текст для получателей письма, отличных от отправителя, если указан параметр sendToSender


Добавлено в v1.2



Улучшения и исправления

  • Теперь если в форме есть заполненное поле с `name="header"`, такое поле будет автоматически подставлено в тему письма.
  • Исправлена ошибка на DLE 10.5+ с невозможностью указать email отправителя из формы.
  • Исправлена ошибка с экранированием кавычек в письме.
  • Если пользователь авторизован, то тег {uf_field_email} при открытии формы автоматически заменится на его email.
  • Убран тег {send_date=D.m.Y} т.к. он оказался нерабочим.
  • Исправлено некорректное поведение тега {send_date}.
  • Добавлен новый параметр конфигурации sendAsPlain — Отправлять сообщение как простой текст. Теперь можно отправлять письма как простые текстовые сообщения, без обработки html.
  • Добавлен новый параметр конфигурации sendToAuthor — Отправить письмо автору новости, если есть поле с name="newsId" и если автор разрешил получение писем с сайта.
  • Реализована возможность отправлять в письме данные из новости. Для этого необходимо передать в форму поле newsId. Пример шаблона в папке newsauthor.
  • Реализована возможность отправки сообщения на email автора новости. Для этого необходимо передать в форму поле newsId и в конфиге прописать sendToAuthor = y. Пример шаблона в папке newsauthor.


Новые теги для email-сообщений

  • [news_id]{news_id}[/news_id] — ID новости (если есть поле с name="newsId").
  • [news_autor]{news_autor}[/news_autor] — Логин автора новости (если есть поле с name="newsId").
  • [news_title]{news_title}[/news_title] — Заголовок новости (если есть поле с name="newsId").
  • [news_email]{news_email}[/news_email] — Email автора новости (если есть поле с name="newsId").
  • {site_home_title} — Выводит название сайта из настроек DLE.
  • {site_http_home_url} — Выводит адрес сайта из настроек DLE.
  • {site_short_title} — Выводит краткое название сайта из настроек DLE.
  • [user_name]{user_name}[/user_name] — Выводит логин пользователя, отправившего сообщение.
  • [user_fullname]{user_fullname}[/user_fullname] — Выводит полное имя пользователя, отправившего сообщение.
  • [user_email]{user_email}[/user_email] — Выводит email пользователя, отправившего сообщение.
  • [user_foto]{user_foto}[/user_foto] — Выводит ссылку на аватар пользователя, отправившего сообщение.
  • [user_land]{user_land}[/user_land] — Выводит то, что пользователь, отправивший сообщение, написал в поле "Место жительства".



Добавлено в v1.3


  • Новый, удобный установщик модуля.
  • Добавлена возможность пикреплять файлы к сообщению в форме. Для этого необходимо в конфиге указать параметр allowAttachments, а так же параметры maxFileSize (максимальный размер прикрепляемого файла) и allowedFileTypes (доступные типы файлов) при необходимости. Готовый шаблон для прикрепления файлов к сообщению — attachments.
  • Добавлен новый параметр конфигурации sendToSender. Если этот параметр задан, то письмо будет отправлено на email-адрес, указанный в поле email. Так же проверяется валидность этого адреса.
  • В шаблон email-сообщения добавлены новые теги, обрабатываемые в сообщении и в поле заголовке письма, когда активирован параметр sendToSender.
    [to_sender] текст для отправителя [/to_sender]
    [not_to_sender] текст для других получателей [/not_to_sender]
  • Добавлены почти все поля из профиля пользователя в шаблон email.
  • Добавлен вывод допполей из профиля пользователя в шаблон email.
  • Ко всем тегам в шаблонах email-сообщения добавлены противоположные теги [not_X], выводящие текст между ними, когда соответствующий тег {X} пуст.
  • Исправлена ошибка, когда пользователю разрешено менять шаблон сайта, а шаблон формы берётся из шаблона, установленного по умолчанию в системе.
  • Улучшения и оптимизация кода.
  • Теперь минимально-допустимая версия php - 5.4.



Добавлено в v1.4


  • Обновлён установщик
  • Добавлен новый параметр parseSendMail, добавляющий возможность производить манипуляции над данными перед отправкой email. В параметр передаётся путь к php файлу, без расширения, отностительно папки engine/modules. Например можно добавить в шаблон email-сообщения новые теги [footer]{footer}[/footer]. Для этого в конфиге прописываем parseSendMail = addFooter, создаём файл engine/modules/addFooter.php со следующим содержимым:
    <?php
    if ($arSendMail['select1'] === 'val1') {
    	$mailTpl->set('[footer]', '');
    	$mailTpl->set('[/footer]', '');
    	$mailTpl->set('{footer}', $arSendMail['select1']);
    } else {
    	$mailTpl->set_block("'[footer](.*?)[/footer]'si", '');
    }





Для вывода формы непосредственно на странице достаточно прописать в нужном месте шаблона (начиная с версии 1.1):
<div data-uf-inline="/engine/ajax/uniform/uniform.php" data-uf-settings='{"formConfig": "inline"}'>
	<div class="uf-inline-loading"></div>
</div>


Для Отправки сообщения автору новости необходимо прописать в шаблон краткой или полной новости (начиная с версии 1.2):
<span class="uf-btn" data-uf-open="/engine/ajax/uniform/uniform.php" data-uf-settings='{"formConfig": "newsauthor", "fields": {"newsId": "{news-id}"}}'>Связь с автором новости</span>



Скачать модуль UniForm

Ответы на частые вопросы



[Q]: Почему ничего не работает?
[A]: C вероятностью в 80% у вас дважды подключена бибилиотека jQuery (20% - проверьте шаги по инструкции).

[Q]: Сделано всё по инструкции, но модальное окно не открывается.
[A]: У вас дважды подключена библиотека jQuery. Имейте ввиду, что в DLE уже есть jquery и подключать её отдельно не нужно.

[Q]: Библиотека jQyery подключена 1 раз (я проверил все скринты на странице в браузере, а не в файле шаблона), но окно всё равно не открывается.
[A]: Вполне вероятно, что вы перенесли js в конец страницы, а скрипты модуля подключаете в начало. Перенесите скрипты модуля в конец страницы.

[Q]: Не приходит письмо.
[A]: Проверьте конфиг модуля (поле emails должно быть раскомментировано). Если всё ок — проверьте папку спам (недопочты типа mail.ru, rambler и прочие noname почтовые службы очень часто при неправильной настройке сервера отправляют письма в спам, особенно, если у вас shared-хостинг). Если в папке спам ничего нет — проверьте логи почтового сервера (узнать о расположении логов можно у хостера). Самый простой способ избежать конфузов при отправке почты - подключить почту для домена.




Жду ваших отзывов!

Похожие материалы

Комментарии

Yamakasi
Yamakasi 8 августа 2015 01:40
письма приходят, разобрался, хотя всё перепробовал не приходило, потом совместными усилиями с техподдержкой хостинга, так сказать он видел уходят или нет, вообщем пашет с задержкой, вот насчёт урл передаёт в письме мне, а вот указал:
<b>Дата отправки:</b> {send_date}

в email.tpl - увы дата не приходит(
Yamakasi
Yamakasi 23 августа 2015 10:22
так и не была ответа sad
но дата не работает, я как понял я делаю всё верно, но дату не выводит увы(
ПафНутиЙ
ПафНутиЙ 23 августа 2015 10:50
Напишите тиккет на гитхаб, приложите код шаблонов, попробую воспроизвести ошибку.
over
over 24 августа 2015 12:48
Павел, спасибо за хак, очень понадобился, реальная спасло, делаю для себя форму заявки, все сделал по инструкции, но в консоле браузера выходит:

index.php:43 complete

как мне на это реагировать ?
ПафНутиЙ
ПафНутиЙ 25 августа 2015 00:52
Цитата: over
как мне на это реагировать ?

Просто не обращайте внимания, либо удалите из js
console.log('complete')
vaselcaseras
vaselcaseras 26 августа 2015 09:42
модуль конфликтует со стандартными jquery, которые уже есть на сайте:
<script type="text/javascript" src="http://code.jquery.com/jquery-latest.min.js"></script>
<script type="text/javascript" src="/templates/t/jquery.js"></script>

как быть в этом случае?
Димка_87
Димка_87 1 сентября 2015 12:34
Добрый день, подскажите пожалуйста как сделать данные формы не в модальном окне, а на странице сайта? Заранее спасибо
ПафНутиЙ
ПафНутиЙ 1 сентября 2015 12:36
Достаточно дочитать пост до конца.
Димка_87
Димка_87 8 сентября 2015 13:56
при выводе формы не посредственно на странице не работает валидатор + сама форма тоже

Димка_87,
при выводе кнопки для попапа все работает норм, как наладить работу непосредственно на странице?

при редактировании шаблона формы в feedback летят все остальные.... подключаю правильно

допустим

<span class="uf-btn" data-uf-open="/engine/ajax/uniform/uniform.php" data-uf-settings='{"formConfig": "callback"}'>Обратная связь</span>

но шаблон берется из feedback хз почему
ПафНутиЙ
ПафНутиЙ 8 сентября 2015 16:36
присылайте FTP, адрес сайта, доступ к админке. как будет время, постараюсь посмотреть что вы сделали не правильно.
Димка_87
Димка_87 8 сентября 2015 17:35
ПафНутиЙ,
отправил в личку, огромное спасибо за помощь
dyv
dyv 8 сентября 2015 19:44
Спасибо за отличный модуль!
НО возникли проблемы с radio
1 - не могу установить их обязательными.
2 - при проверке на обязательность какие поля указывать в конфиге ? radio1 или radio[] или...?
3 - проверка когда идет на пользовательской стороне текст об ошибке заключен в теги указанные в шаблоне
4 - значение выбранного варианта по емайл приходит вопросамм (?????).кодировка utf-8/ Остальные поля input textarea приходят в верной кодировке

С уважением
Евгений

PS нет версии с возможностью отправки файлов? если нет то какова будет стоимость добавить эту возможность на моем сайте?
ПафНутиЙ
ПафНутиЙ 8 сентября 2015 21:38
У вас на странице js-ошибки отсюда и не работает форма.
К тому же её отправку перехватывает другой скрипт, судя по всему это стандартный скрипт DLE от стандартной формы обратной связи.
Попробуйте разместить форму на другой странице.
ПафНутиЙ
ПафНутиЙ 8 сентября 2015 21:54
Присылайте FTP, адрес сайта. Как будет время, постараюсь посмотреть что не так.

Файлы в планах, но когда - сказать не смогу.
Стоимость доработки - от 1800р, но так же не могу сказать когда смогу сделать.
dyv
dyv 9 сентября 2015 05:59
ПафНутиЙ,
Спасибо за ответ. Сайт пока закрыт - наполняется и дорабатывается. Как открою вышлю все данные.
Насчет отправки файлов: нужно достаточно срочно, так что попробую сам допилить если Вы не против. Если не справлюсь тогда обращусь.
Димка_87
Димка_87 9 сентября 2015 14:11
ПафНутиЙ,
js не трогал, подключены только стандартные и ваши если не ошибаюсь. можно ли как то удалить из стандартного жс кусок кода от формы или как то в целом выключить стандартную? она не нужна при наличии данного модуля
ПафНутиЙ
ПафНутиЙ 9 сентября 2015 16:05
Лучше поместите модуль на другую страницу. Тогда не придётся ковырять двиг.
OnlySteam
OnlySteam 10 сентября 2015 14:43
Это пожалуй лучшая вещь у меня на сайте. Спасибо
OnlySteam
OnlySteam 10 сентября 2015 14:57
Заказать звонок
templateFolder = callback
// nocache = y
// debug = y
required = phone
selectFields = calltime
sendmail = y
emails = h737ph@yandex.ru,

На почту приходят 2 письма сразу. Как можно исправить?
dyv
dyv 11 сентября 2015 07:23
Доброго времени суток.
У меня на сайте два языка, соответственно два шаблона. В англ верcии перевел form.tpl, но все равно отображается русская версия. Очистка кеша не помогла (движок и браузер).
Не подскажите как вылечить ?

OnlySteam,
Попробуйте убрать запятую со строки с адресом
ПафНутиЙ
ПафНутиЙ 11 сентября 2015 09:04
Цитата: dyv
В англ верcии перевел form.tpl, но все равно отображается русская версия.

Используйте другой шаблон формы.
ПафНутиЙ
ПафНутиЙ 11 сентября 2015 09:05
Не представляю.
dyv
dyv 11 сентября 2015 09:12
пробовал - сделал копии шаблона и переименовал

на выходе при использовании inline выводит error_config

при обычной форме просто пустая затененная страница(
ПафНутиЙ
ПафНутиЙ 11 сентября 2015 09:20
error_config выводится при ошбках конфига. Вы делаете что-то не так.
vadims
vadims 11 сентября 2015 15:00
Павел, подскажите как сделать чтобы Ваш модуль работал с DLE настройками.
У меня проблема с phpmail и почта шлется через SMTP от Яндекса, который отлично справляется с этим.
Может если нельзя зделать чтобы работал с настройками движка, то может можно просто как то поправить чтобы можно было настройки SMTP прописать?
ПафНутиЙ
ПафНутиЙ 11 сентября 2015 19:44
Модуль учитывает настройки DLE.
Romka
Romka 15 сентября 2015 10:37
Прописал почту в файлике конфиг, раскомментировал. Но сообщение не приходит на указанную мной почту.
В чём может быть причина. Движок 10.2.

Может надо права 777 выставлять ещё?

Просто не могу понять в чём может быть проблема.
ПафНутиЙ
ПафНутиЙ 15 сентября 2015 13:33
посмотрите логи, включите отладку, проверьте спам.
DimaTiunov
DimaTiunov 15 сентября 2015 15:59
ПафНутиЙ,
Слушай, а можно по удачному завершению всей формы сделать выполнение скрипта? Простой импут будет работать?
Romka
Romka 15 сентября 2015 17:04
Спасибо, сбросил кеш, помогло.

Такой вопрос, а как сделать, чтобы форма работала не по нажатию а была активной (как у вас на сайте в самом низу).

Спасибо.

Добавить комментарий

Комментировать могут только зарегистрированные пользователи

Информация

Посетители, находящиеся в группе Гости, не могут оставлять комментарии к данной публикации.