ПафНутиЙ-Блог » Модули » UniForm — модуль универсальных ajax-форм для DataLife Engine

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

16.03

722

211 044

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

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

Не использует БД. Для работы модуля не требуется дополнительное соединение с БД и он не хранит данные из форм.
Скорость работы. За счёт простоты реализации удалось достичь приемлемой скорости работы.
Лёгкость настройки и стилизации. Все настройки модуля, оформление 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-хостинг). Если в папке спам ничего нет — проверьте логи почтового сервера (узнать о расположении логов можно у хостера). Самый простой способ избежать конфузов при отправке почты - подключить почту для домена.

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

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

Добрый день.
Отличная форма, но у меня не все работает(
Например, указано 2 мыла, а письмо идет только на первый.
Также на все обязательные поля выводится одна и та же ошибка, вместо назначенных под каждое поле.

ПафНутиЙ 3 октября 2016 19:25

#5657

Добрый вечер!
Напишите тиккет, приложите код шаблонов, конфиги, адрес сайта, где воспроизводится ошибка.

Asiuslik 11 октября 2016 11:08

#5663

Здравствуйте! Есть ли возможность вывода в form.tpl тайтла или картинки из новости?

ПафНутиЙ 11 октября 2016 20:37

#5666

Да, используйте js

trouble 12 октября 2016 18:36

#5673

Версия DLE-UniForm 1.3.0 при запуске "dle_module_install.php" выводит сообщение что: "Файл с конфигурацией установки модуля не найден, возмжно установочные файлы модуля не скопированы.". Все файлы скопированы, два раза пробовал и пути правильные.

ПафНутиЙ 12 октября 2016 23:17

#5674

запустите /dle_module_install.php?module=uniform

BlackDragon 14 октября 2016 05:29

#5675

Здравствуйте, где можно посмотреть детальную инструкцию по установке модуля версии 1.3?

И еще маленький вопрос, есть ли в модуле возможность сохранения в админке сайта всех отправляемых писем с с сайта?

Как сделать условие, при выборе радиокнопки менялся бы получатель (email) сообщения

недождался сам доработал...
если кому надо:
в /engine/modules/uniform/uniform.php
добавляем

			if ($post['eradio'] && $cfg['sendToAuthor']) {

				switch($_POST['eradio']) {
					case "1":
						$cfg['emails'] .= ', mail1@mail.ru';
					break;
					case "2":
						$cfg['emails'] .= ', mail2@mail.ru';
					break;
					case "3":
						$cfg['emails'] .= ', mail3@mail.ru';
					break;
					case "4":
						$cfg['emails'] .= ', mail4@mail.ru';
					break;
				}
			}

в вашем шаблоне form.tpl
заводим так:


			<div class="uf-field">
				<div class="uf-label">
					Адресат обращения
				</div>
				<div class="uf-field-input">
					<label><input type="radio" name="eradio" value="1" [uf_eradio_1]checked[/uf_eradio_general]> почта1</label> <br>
<label><input type="radio" name="eradio" value="2" [uf_eradio_2]checked[/uf_eradio_gruz]> Почта2</label> <br>
<label><input type="radio" name="eradio" value="3" [uf_eradio_3]checked[/uf_eradio_service]> почта3</label> <br>			<label><input type="radio" name="eradio" value="4" [uf_eradio_4]checked[/uf_eradio_kadr]> почта4</label>
				</div>
			</div>

dark_forces 14 октября 2016 06:14

#5678

BlackDragon,
/dle_module_install.php?module=uniform
там инструкция

ПафНутиЙ 14 октября 2016 20:08

#5681

Здравствуйте, где можно посмотреть детальную инструкцию по установке модуля версии 1.3?

/dle_module_install.php?module=uniform

И еще маленький вопрос, есть ли в модуле возможность сохранения в админке сайта всех отправляемых писем с с сайта?

Нет, о вы можете это реализовать самостоятельно.

BlackDragon 15 октября 2016 01:56

#5682

Не подскажете как для конверсии адвердс правильно прописать код самой конверсии в вызове кнопки по типу заказать обратный звонок? Вот от гугл инструкция - https://support.google.com/adwords/answer/6331304

Asiuslik 16 октября 2016 15:23

#5684

Выбрал шаблон attachments, картинки прикрепляются но в письме пишет "Не прикрепленных файлов нет"

Нужно что-то до настраивать?

souz21 17 октября 2016 17:02

#5685

У вас кажется в 1.3 косяк есть в css. Когда уменьшаешь размер формы в 15-ой строке с 500 до 300px например, крестик Закрыть, может оказаться где угодно. Я вчера целый час свою html форму настраивал и не мог понять что происходит с кнопкой закрыть...Залил css из версии 1.2, все стало нормально.

ПафНутиЙ 17 октября 2016 21:13

#5686

Так и должно быть, ведь все картинки прикрепились.
Проверьте почтовые вложения, проверьте не банит ли вложения этого типа почтовик, проверьте логи почтового сервера, действительно ли отправлено письмо с файлами.

ПафНутиЙ 17 октября 2016 21:17

#5687

Ок, поправим.

Asiuslik 17 октября 2016 23:08

#5688

ПафНутиЙ,
Метод Отправки PHPmail, вся текстовая инфа с формы отправляется. Файлы пишет отправлены но по факту в письмах вложений нет. Пользуюсь почтой гуггл и яндекс. Где именно мне смотреть логи почтового сервера?

Yamakasi 18 октября 2016 01:54

#5689

Asiuslik,
наверное отвечу за Павла.
нужно смотреть на сервере, то есть где стоит сайт, ну если хостинг, то в панели - есть такое как "Отслеживание доставки", если не можете разобраться в панели хостинга, то обратитесь в техподдержку...

ПафНутиЙ 18 октября 2016 08:10

#5690

Попробуйте использовать SMTP (более эффективно и быстрее работает), по логам почтового сервера лучше обратиться к хостеру т.к. на разных хостингах разные возможности.

Asiuslik 21 октября 2016 18:19

#5692

ПафНутиЙ,
с SMTP вообще отправка не происходит. версия DLE 10.6 .

Вы можете скинуть скриншот ваших настроек в dle? , может по примеру пойму причину.

ПафНутиЙ 21 октября 2016 18:45

#5693

Настройки по умолчанию, ничего не менялось, dle актуальной версии.

Asiuslik 21 октября 2016 21:43

#5694

ПафНутиЙ,
Проделал теже действия и на самой новой лицензии, сможете глянуть? ну или скинуть скрин с вашими настройками

Asiuslik 26 октября 2016 13:26

#5696

Asiuslik,
Получилось настроить SMTP, проблема была в хостинге.

Текстовая информация доходит а файлы нет

Asiuslik 26 октября 2016 15:25

#5697

ПафНутиЙ,

У вас вот так стоит:

Content-Type: "image/png"; name="change_skin.png"
Content-Transfer-Encoding: base64
Content-Disposition: attachment

Или иначе? Может в этом проблема неприкрепления файлов?

John Doe 26 октября 2016 17:04

#5699

Здравствуйте Павел.

Есть ли возможность использовать данный модуль для отправки сообщения из профиля пользователя.
Пробовал через custom author - работает, но если у пользователя нет новостей?

Поле email только значение {uf_field_email} или указанное в config.tpl - emails? Или каким-то образом можно вставить меняющийся адрес?

Спасибо.

serj100 27 октября 2016 14:58

#5702

Здравствуйте Павел,спасибо Вам большое за плагин, не ловко Вас спрашивать.
Искал ответ но не нашел . Ошибка вот такая:

Все настроил по инструкции, но модуль не хочет работать

websot 28 октября 2016 11:13

#5703

Дорогой Павел, будет работать ли Ваш модуль на DLE версии 11.1?

BlackDragon 28 октября 2016 11:26

#5704

можете подсказать какую ссылку прописать для гугл конверсий в коде ссылки по вызову формы? Обычная кнопка <span class="uf-btn" data-uf-open="/engine/ajax/uniform/uniform.php" data-uf-settings='{"formConfig": "callback"}' style="font-size:14px;">Заказать обратный звонок</span>

Вот гугл инструкция:
Отслеживание кликов по кнопке. В приведенном ниже коде замените строку http://example.com/your-link на URL ссылки, а строку Download now! – на текст кнопки.
<button onclick="goog_report_conversion ('http://example.com/your-link')" href="http://example.com/your-link">Download now!</button>

Какую ссылку нужно прописать вместо onclick="goog_report_conversion ('http://example.com/your-link')" href="http://example.com/your-link" ? Заранее спасибо!

ПафНутиЙ 29 октября 2016 08:15

#5706

Залейте файлы на хостинг, проверьте там, возможно на loclhost у вас чего то не хватает или не залили файлы туда, куда нужно.

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

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

Информация

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