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

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

16.03

722

255 425

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

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

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

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


<div>
  Направление:<br>
  <select class='calculon' id='f6'>
            <option value="0">Выбрать</option>
            <option value="170">Бердянск (170 грн.)</option>
            <option value="200">Приморск (200 грн.)</option>
            <option value="160">Кирилловка (160 грн.)</option>
            <option value="200">Геническ (200 грн.)</option>
            <option value="210">Генгорка (210 грн.)</option>
            <option value="220">Счастливцево (220 грн.)</option>
            <option value="230">Стрелковое (230 грн.)</option>
            <option value="250">Железный Порт (250 грн.)</option>
            <option value="250">Лазурное (250 грн.)</option>
            <option value="250">Скадовск (250 грн.)</option>
  </select>
</div>

<div>
  кол-во мест туда:<br>
  <select class='calculon' id='f7'>

            <option value="1">1</option>
            <option value="2">2</option>
            <option value="3">3</option>
            <option value="4">4</option>
            <option value="5">5</option>
            <option value="6">6</option>
            <option value="7">7</option>
            <option value="8">8</option>

  </select>
</div>


<div>
  кол-во мест обратно:<br>
  <select class='calculon' id='f8'>
            <option value="0">0</option>
            <option value="1">1</option>
            <option value="2">2</option>
            <option value="3">3</option>
            <option value="4">4</option>
            <option value="5">5</option>
            <option value="6">6</option>
            <option value="7">7</option>


  </select>
</div>



Итого к оплате:<div id='calculon'>0</div>

<script type="text/javascript">
if(!Number.prototype.toFixed){
  Number.prototype.toFixed=function(e){
  var y=Math.round(this*Math.pow(10,e))/Math.pow(10,e);
  var i=e-y.toString().length+y.toString().indexOf('.')+1;
  if(e>0){
  if(y.toString().indexOf('.')<0)return y+'.'+Math.pow(10,e).toString().substring(1);
  else if(i>0)return y+Math.pow(10,i).toString().substring(1);
  else return y;
  }
  else return y;
  }
}
var formula1 = '[f7]*[f6]+[f8]*[f6]';

count(formula1);

//Сам скрипт
function count(f){form=f;calculon();}
var elems = document.getElementsByTagName('*');
for(var i=0;i<elems.length;i++){if(/(^|b)calculon($|b)/.test(elems[i].className)){
  if(elems[i].addEventListener){elems[i].addEventListener('click',calculon,false);}else
  if(elems[i].attachEvent){elems[i].attachEvent('onclick',calculon)}
  }}
function calculon(){
  result=false;
  var els = form.match(/[.+?]/g);
  for(var i=0;i<els.length;i++){
  val=0;
  var obj = document.getElementById(els[i].match(/w+/));
  if(obj.tagName=='SELECT'){
  for(var z=0;z<obj.options.length;z++){
  if(!obj.disabled&&obj.options[z].value&&obj.options[z].selected){val=val+parseFloat(obj.options[z].value)}
  }
  }else{
  if(!obj.disabled&&obj.value&&obj.selected||obj.checked){val=val+parseFloat(obj.value)}
  }
  result = result ? result.replace(els[i],val) : form.replace(els[i],val);
  }
  document.getElementById('calculon').innerHTML=eval(result).toFixed(2);
  }
</script>

вопрос - как собственно заставить работать скрипт в форме? и передавать значение итого к оплате в письмо...

ПафНутиЙ 1 июля 2015 08:21

#69

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

igoryk 1 июля 2015 10:50

#70

ПафНутиЙ,

А как заставить работать сам скрипт??

ПафНутиЙ 1 июля 2015 10:52

#71

Я бы его переписал.

igoryk 1 июля 2015 18:08

#72

ПафНутиЙ,
к сожалению я в скриптах - полный ноль ...

ПафНутиЙ 1 июля 2015 21:13

#73

подобный скрипт можно написать под заказ.

igoryk 1 июля 2015 21:25

#74

ПафНутиЙ,
ага и любой сайт тоже можно под заказ... :) а тут есть готовое решение, нужно только его интегрировать.

ПафНутиЙ 2 июля 2015 22:34

#75

Ну так у вас два пути к решению проблемы:
1. Сделать самому.
2. Попросить кого-то другого (как правило платно), это и есть под заказ.

igoryk 3 июля 2015 00:41

#76

ПафНутиЙ,
вот и пытаюсь разобраться сам, форму сделал, застрял именно на подключении скрипта (не могу понять где его прописать, чтобы он отрабатывался во всплывающем окне формы...)

ПафНутиЙ 3 июля 2015 07:57

#77

Пропишите в js-файл, запускайте после загрузки формы.

AllMySelf777 5 июля 2015 13:14

#78

Спасибо за модуль, русифицировал .php файлы, header("Content-type: text/html; charset=windows-1251"); и все ОК. Все очень грамотно, легко настраивается.

Руслан 5 июля 2015 22:55

#79

Можно ли как-то сделать что бы на разные мейлы шли разные шаблоны сообщений?

Руслан 5 июля 2015 23:53

#80

Я в конец файла sendmail.php дописал функцию отправки смс с текстом, выглядит вот так:

$body=file_get_contents("http://sms.ru/sms/send?api_id=f652dcf668a4&to=380960000000&text=".urlencode(iconv("windows-1251","utf-8","Привет!")));

Можно ли как то сюда передать значение одного или нескольких полей формы, например, телефон?

ПафНутиЙ 6 июля 2015 06:08

#81

Да, вместо "Привет!" впишите нужную переменную, по идее должно заработать.
Разные шаблоны на разные email в планах.

Руслан 6 июля 2015 13:32

#82

Вписал вот так: "Привет! {field1}" но не работает, может нужно в каком-то другом виде её вписать? Помогите пожалуйста, очень нужно!

Руслан 6 июля 2015 20:01

#83

Присылает просто Привет! {field1}

ПафНутиЙ 6 июля 2015 20:17

#84

$arSendMail['field1']

Руслан 6 июля 2015 20:38

#85

Теперь форма не отправляется, крутится загрузка, вот так вписал: Привет! $arSendMail['field1'] верно?

ПафНутиЙ 7 июля 2015 08:32

#86

посмотрите какая ошибка в консоли.

Руслан 7 июля 2015 12:32

#87

Uncaught Error: Syntax error, unrecognized expression: Parse error: syntax error, unexpected T_ENCAPSED_AND_WHITESPACE, expecting T_STRING or T_VARIABLE or T_NUM_STRING in /home/r/russhe/demo1.ruslan-shevchuk.com/public_html/engine/modules/uniform/sendmail.php on line 98

На это строке как раз вот это:

$body=file_get_contents("http://sms.ru/sms/send?api_id=ae30be81-8ac1-1204-cd68-f6&to=380960000000&text=".urlencode(iconv("windows-1251","utf-8","Привет! $arSendMail['field1']")));

GRESIUS 9 июля 2015 15:45

#88

Присылает на мыло:
[field1]{field1}[/field1] : тестовый текст поле 1
[field2]{field2}[/field2] : тестовый текст поле 2
[field3]{field3}[/field3] : тестовый текст поле 3
[field4]{field4}[/field4] : тестовый текст поле 4

как поправить?

Руслан 10 июля 2015 20:48

#89

У меня выдает error возможно такое из-за кириллического домена?

zoma 12 июля 2015 09:25

#90

сделал все по инстукции перехожу по ссылке http://webkomplekt.ru/engine/ajax/uniform/uniform.php

пишет ERROR

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

Информация

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

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