Сниппет WebLoginPE для MODx предназначен для расширенного управления веб-пользователями. WebLoginPE управляет регистрацией пользователей, активацией, восстановлением паролей, удалением профиля пользователей и т.д.

Документация на английском языке находится в архиве, в папке webloginpe/docs/index.html

Установка

1. Загружаем файлы из скаченного архива в папку /assets/snippets/webloginpe

2. Создаем новый сниппет WebLoginPE (Элементы >> Управление элементами >> Сниппеты) и помещаем в Код сниппета содержимое файла webloginpe.snippet.php. В описании указываем версию 1.3.1. Сохраняем сниппет.

Параметры

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

Формат: en | fa | fr | ru
Значение по умолчанию: en
Примечание: Языковые пакеты хранятся в папке /webloginpe/lang/. Вы можете добавить собственные языковые пакеты.
Пример:
&lang=`ru`
Формат: simple | register | profile | users | manager | taconite
Значение по умолчанию: simple
Примечание:
'simple' может работать с большинством задач, связанных с управлением пользователями (авторизация, выход, регистрация, редактирование профиля, и т.д.)
'register' обрабатывает все функции создания новых пользователей. "profile" позволяет пользователю управлять своим аккаунтом.
'users' отображает список всех зарегистрированных пользователей и предоставляет ссылки для просмотра атрибутов пользователей, а также сообщения пользователя.
'manager' так же, как 'users' отображает список веб-пользователей, но добавляет возможность редактировать или удалять любых пользователи. Этот тип должен быть доступен только для администраторов.
'taconite' обеспечивает работу WebLoginPE в режиме AJAX
Пример:
&type=`users`
Формат: instant | verify
Значение по умолчанию: instant
Примечание: Имеется два возможных варианта. Вариант instant позволяет пользователю самому задать все свои данные и пароль, а вариант verify автоматически генерирует пароль и отправляет его по почте. Последний метод позволяет проверить почтовый адрес и обеспечить защиту от автоматической регистрации роботом.
Пример:
&regType=`verify`
Формат: список полей | пусто
Значение по умолчанию: пусто
Примечание: Определяет список полей, разделенные запятой, которые являются обязательными длязаполнения при регистрации.
Пример:
&regRequired=`email,username,fullname,password,formcode,tos`
Формат: Любое валидное название таблицы MySQL
Значение по умолчанию: web_user_attributes_extended
Примечание: WebLoginPE создает таблицу в базе данных MODx, в которй можно хранить столько атрибутов пользователя, сколько вы хотите. Имя таблицы по умолчанию "web_user_attributes_extended ', но вы можете ее изменить с помощью параметра customTable. Вы можете указать неограниченное количество имен столбцов для этой таблицы с помощью параметра customFields.
Пример:
&customTable=``
Формат: список полей | пусто
Значение по умолчанию: нет
Примечание: Список дополнительных полей с информацией о пользователе.Поля будут созданы в дополнительной таблице автоматически.
Пример:
&customFields=``
Формат: 1 | 0
Значение по умолчанию: 1
Примечание: WebLoginPE создаст таблицы для хранения расширенных атрибутов пользователя, но если вы уже создали свою собственную таблицу (и определили его в customTable), и она не использует префикс таблицы, который вы ввели при установке MODx, вы можете использовать prefixTable = `0` (по умолчанию 1) и WebLoginPE не будет автоматически добавлять префикс MODx.
Пример:
&prefixTable=`0`
Формат: любое правильное название сервиса
Значение по умолчанию: нет
Примечание: Список сервисов, которые следует отключить. Следует использовать, если какие-то сервисы вы использовать не хотите, чтобы не было возможности их использовать умышленно (например, удаление пользователя).
Если вы хотите отключить регистрацию (только администратор может добавлять пользователей): disableServices=`register`
Пример:
&disableServices=`deleteprofile,users`
Формат: 1 | 0
Значение по умолчанию: 1
Примечание: При запуске WebLoginPE, он проверяет наличие дополнительной таблицы атрибутов пользователя и создает её, если она не существует. Устанавливая tableCheck=0 (по умолчанию 1) вы можете пропустить эту проверку и немного поднять скорость. На создание новых полей настройка не распространяется.
Пример:
&tableCheck=`0`
Формат: список групп
Значение по умолчанию: нет
Примечание: Определяет список групп, которые будут назначены пользователю после регистрации.
Пример:
&groups=`Registered Users`
Формат: email
Значение по умолчанию: нет
Примечание: Разделенный запятыми список адресов электронной почты, чтобы получать уведомления о регистрации нового пользователя.
Пример:
&notify=`webmaster@yoursite.com, admin@mysite.url`
Формат: ID документов
Значение по умолчанию: нет
Примечание: Список идентификаторов страниц (ID), на которые пользователь будет перенаправлен после успешной авторизации. Если у пользователя нет доступа к указанной странице, то будет использована следующая в списке. Если параметр не указан - вернуть на текущий документ.
Пример:
&liHomeId=`18,25,33`
Формат: ID документа
Значение по умолчанию: нет
Примечание: Идентификатор страницы (ID) на которую пользователь будет перенаправлен после выхода. При отсутствии парамтра - вернуть на текущий документ.
Пример:
&loHomeId=`18`
Формат: ID документа
Значение по умолчанию: нет
Примечание: Идентификатор страницы, с формой регистрации пользователя.
Пример:
&regHomeId=`18`
Формат: ID документа
Значение по умолчанию: нет
Примечание: Идентификатор страницы, которая отвечает за управление профилем пользователя.
Пример:
&profileHomeId=`18`
Формат: ID документа
Значение по умолчанию: нет
Примечание: Идентификатор страницы, на которую будет перенаправлен пользователь после успешной регистрации. Если параметр не указан, пользователь остается на текущей странице. Можно указать количество секунд задержки перед перенаправлением на другую страницу с помошью параметра regSuccessPause
Пример:
&regSuccessId=`18`
Формат: время в секундах
Значение по умолчанию: 5
Примечание: Временная задержка перед перенаправлением пользователя на документ после успешной регистрации.
Пример:
&regSuccessPause=`10`
Формат: size, width,height
Значение по умолчанию: 105000,100,100
Примечание: WebLoginPE можете загружать и изменять размер изображений для идентификации пользователя, вроде как аватар. Вы можете указать максимально допустимый размер файла изображения (в байтах) и его ширину и высоту (в пикселях). По умолчанию '105000,100,100' (100kb, 100px X 100px).
Пример:
&userImage=`500000,250,250`
Формат: любой валидный формат времени, который соответствует правилам функции PHP - strftime
Значение по умолчанию: '%A %B %d, %Y at %I:%M %p
Примечание:
Пример:
&dateFormat=`%m-%d-%Y`
Формат: true | false
Значение по умолчанию: false
Примечание: Отвечает за подключение библиотеки jQuery для WebloginPE
Пример:
&loadJquery=`true`
Формат: Файл JavaScript
Значение по умолчанию: нет
Примечание: Указание скрипта, который будет использоваться совместно сjQuery.
Пример:
&customJs=`assets/snippets/webloginpe/js/example.js`
Формат: число
Значение по умолчанию: нет
Примечание: Определение количества дней, после которого будут удаляться неактивированные пользовательские записи. Когда пользовтель регистрируется, то в поле cachepwd таблицы`web_users` ставится время регистрации, а после первой авторизации удаляется. Если пользователь указал неверный почтовый адрес или не заходил по другой причине, то его запись можно удалить.
Пример:
&pruneDays=`7`
Формат: LABEL:DOM_ID:FIELDNAME:FIELD_TYPE:Option(value),Option2(value2)
Значение по умолчанию:
Примечание: Параметр, определяющий конфигурацию пользовательских полей в форме. Позволяет задать поля select,selectmultiple, checkbox и radio. При этом выбранное значение запоминается после повторной загрузки формы (в профиле или регистрации, когда обнаружена ошибка).
LABEL - заголовок поля
DOM_ID - идентификатор ID поля в DOM
FIELDNAME - название дополнительного поля в таблице
FIELD_TYPE - тип поля
Option, Option2 - отображаемое значение
value, value2 - значение, отправляемое на сервер
Типы полей:
select
select multible
radio
checkbox
Значение:
список значений правильного формата, разделенный знаком «||».
пусто - нет конфигурации для дополнительных полей
Пример:
&inputHandler=`Favorite Colors:userProfileFavoriteColor:favorite_color:select multiple:Red(red),Blue(blue),Green(green),Black(black),Orange(orange),Yellow(yellow)||Age Group:userDemographic:demographic:radio:Less than 13(1),14 - 18(2),19 - 30(3),31 - 40(4),41-50(5),51-65(6),65 or older(7)||Keep my email private:userProfileEmailPrivate:emailprivate:checkbox:()||Keep my AIM account private:userProfileAIMPrivate:aimprivate:checkbox:()||Keep my MSN account private:userProfileMSNPrivate:msnprivate:checkbox:()`
Формат: List Name:outerTplChunk:userTplChunk:sortField:sortOrder:filter(value),filter2()
Значение по умолчанию: [(site_name)] Members:default:default:username:ASC:
Примечание:
Используется с `user` и `manager` типами. Позволяет отображать на одной странице несколько списков пользователей.
List Name: имя списка (Обязательно), например, "Administrators"
outerTplChunk: имя чанка с шаблоном для вывода списка. Пример: defaultUserOuterTpl.html
userTplChunk: имя чанка с шаблоном для вывода каждого пользователя. Пример: defaultUserTpl.html
sortField: Любой из атрибутов пользователя (в том числе customFields), по которым вы хотите отсортировать список, например: username, fullname, internalKey и т.д.
sortOrder: направление сортировки (ASC по возрастанию | DESC по убыванию)
filter(value): фильтр документов
Для вывода нескольких списков используется разделитель ||
usersList=`All Users:default:default:username:ASC:||usersList=`Female Users:default:default:username:ASC:gender(2)`
В первом списке опущен фильтр, но : все равно необходимо.
Пример:
&usersList=`All Users:default:default:username:ASC:||usersList=`Female Users:default:default:username:ASC:gender(2)`

Шаблоны

Формат: имя чанка шаблона || файл шаблона || тест шаблона
Значение по умолчанию: defaultMessageTpl.html
Примечание: При создании чанка MessageTpl вставьте плэйсхолдер [+wlpe.message.text+] в том месте шаблона, где должно вывестись сообщение
Пример:
&messageTpl=`MessageTpl`
Формат: чанк | файл | строка
Значение по умолчанию: defaultLoginFormTpl.html
Примечание:
Пример:
&loginFormTpl=`LoginFormTpl`
Формат: чанк | файл | строка
Значение по умолчанию: defaultLoginSuccessTpl.html
Примечание:
Пример:
&successTpl=`LoginSuccessTpl`
Формат: чанк | файл | строка
Значение по умолчанию: defaultRegisterInstantFormTpl.html и defaultRegisterVerifyFormTpl.html
Примечание:
Пример:
&registerTpl=`RegisterInstantFormTpl`
Формат: чанк | файл | строка
Значение по умолчанию: defaultLoginFormTpl.html
Примечание:
Пример:
&registerSuccessTpl=`LoginFormTpl`
Формат: чанк | файл | строка
Значение по умолчанию: defaultTosTpl.html
Примечание: Если вы хотите, чтобы пользователи соглашались с вашими правилами: Условия предоставления услуг / Политика конфиденциальности и т.д., используйте в форме регистрации плэйсхолдер [+tos+] и выведите в форме значок checkbox, чтобы пользователь мог его отметить. Не забудьте указать tos в параметре regRequired, чтобы не допускать к регистрации несогласившихся пользователей.
Пример:
&tosChunk=`TosTpl`
Формат: чанк | файл | строка
Значение по умолчанию: defaultProfileTpl.html
Примечание:
Пример:
&profileTpl=`ProfileTpl`
Формат: чанк | файл | строка
Значение по умолчанию: defaultUserOuterTpl.html
Примечание: Представление общей информации о пользователе в общем списке(type=`users`)
Пример:
&userOuterTpl=`UserOuterTpl`
Формат: чанк | файл | строка
Значение по умолчанию: defaultUsersTpl.html
Примечание:
Пример:
&usersTpl=`UsersTpl`
Формат: чанк | файл | строка
Значение по умолчанию: defaultViewProfileTpl.html
Примечание:
Пример:
&viewProfileTpl=`ViewProfileTpl`
Формат: чанк | файл | строка
Значение по умолчанию: defaultProfileDeleteTpl.html
Примечание: Форма подтверждения намеренья удалить пользовательскую запись.
Пример:
&profileDeleteTpl=`ProfileDeleteTpl`
Формат: чанк | файл | строка
Значение по умолчанию: defaultUserOuterTpl.html
Примечание: По умолчанию используется шаблон для userOuterTpl
Пример:
&manageOuterTpl=`ManageOuterTpl`
Формат: чанк | файл | строка
Значение по умолчанию: defaultManageTpl.html
Примечание:
Пример:
&manageTpl=`ManageTpl`
Формат: чанк | файл | строка
Значение по умолчанию: defaultManageProfileTpl.html
Примечание:
Пример:
&manageProfileTpl=`ManageProfileTpl`
Формат: чанк | файл | строка
Значение по умолчанию: defaultManageDeleteTpl.html
Примечание:
Пример:
&manageDeleteTpl=`ManageDeleteTpl`
Формат: чанк | файл | строка
Значение по умолчанию: defaultResetFormTpl.html
Примечание: Форма восстановления пароля. Она должна содержать только поле для указания почтового адреса. После ввода адреса WebloginPE сгенерирует новый пароль, а также ключ для активации и пошлет по электронной почте. Для активации будет сформирована специальная ссылка вида "?service=activate&userid=3&activationkey=kl3tW5rtDi",где 3 - идентификатор пользователя, а kl3tW5rtDi - код активации нового пароля.
Пример:
&resetTpl=`ResetFormTpl`
Формат: чанк | файл | строка
Значение по умолчанию: defaultActivationFormTpl.html
Примечание: Форма активации пользовательской записи, которая вызывается после перехода по ссылке для восстановления пароля. Она может содержать поля для определения нового пароля.
Пример:
&activateTpl=`ActivationFormTpl`
Формат: чанк | файл | строка
Значение по умолчанию: defaultNotifyTpl.html
Примечание: Шаблон почтового сообщения для оповещения о регистрации пользователя. Использует плейсхолдеры, которые определены в конфигурации MODx (Инструментарий -> Конфигурация -> Настройки пользователя -> Регистрационный e-mail).
Пример:
&notifyTpl=`NotifyTpl`
Формат: чанк | файл | строка
Значение по умолчанию: New Web User for Школа MODX.
Примечание:
Пример:
&notifySubject=`Новый веб-пользователь сайта  Школа MODX.`

Функции сервисов

Simple Register Profile
  • login
  • logout
  • profile
  • saveprofilesimple
  • deleteprofilesimple
  • confirmdeleteprofilesimple
  • registernew
  • register
  • forgot
  • resetpassword
  • activate
  • activated
  • default (показать форму авторизации или приветствующее сообщение, если пользователь авторизован)
  • register
  • cancel
  • login
  • logout
  • default (показать форму регистрации)
  • saveprofile
  • cancel
  • logout
  • deleteprofile
  • confirmdeleteprofile
  • default (показать прифиль пользователя для редактирования)
Manager Users Taconite
  • editprofile
  • saveuserprofile
  • messageuser
  • deleteuser
  • confirmdeleteuser
  • default (показать список всех пользователей)
  • viewprofile
  • messageuser
  • default (показать всех пользователей)
  • login
  • logout
  • register
  • resetpassword
  • activated

Плейсхолдеры

На таких страницах, как форма регистрации и редактирование профиля, для отображения информации об авторизованном пользователе, используются плэйсхолдеры, начинающиеся с "user", а затем идет имя столбца с атрибутами пользователя:

[+user.username+], [+user.fullname+], [+user.email+], [+user.aim+], [+user.website+] и т.д.

На таких страницах, как страница пользователя и просмотр профиля пользователя, где вы хотели бы отображать информацию о других пользователях, используются плэйсхолдеры, начинающиеся с "view":

[+view.username+], [+view.age+], [+view.country+], [+view.gender+], [+view.website+] и т.д.

При использовании параметра inputHandler целые разделы форм выводятся через плэйсхолдеры. В этом случае плэйсхолдеры начинаются с "form". Есть два плэйсхолдера форм, которые создаются по умолчанию:

[+form.country+] and [+form.gender+]

WebLoginPE также создает несколько других полезных плэйсхолдеров, которые вы можете использовать в ваших шаблонах:

[+tos+] чанк с условиями регистрации.
[+user.defaultphoto+] фотография пользователя по умолчанию.
[+request.userid+] идентификатор пользователя для активации формы.
[+request.activationkey+] ключ активации для активации формы.
[+form.captcha+] captcha - защита от спама.

Поделитесь ссылкой

Статистика

Яндекс цитирования
© 2011 - 2016 Школа MODX