VS-engine

CMF ModX Login Modx Revo - процесс аутентификации пользователя

Login - сниппет авторизации для MODx Revolution

Что такое Login в Modx Revolution?

Данный компонент загружает обычную форму входа с паролем / выхода и обеспечивает процесс аутентификации пользователя.

Использование

Пример использования Login:

[ [!Login] ]

Можно задать определенный / специфический шаблон, но при этом нужно убедиться, что вызываются также  и параметры  &tpl типа:

[ [!Login? &tplType=`modChunk` &loginTpl=`myLoginChunk`] ]

Для использования дополнительных возможностей ознакомьтесь со свойствами сниппета.

Свойства

Login обладает несколькими свойствами, позволяющими настраивать его работу.

 

Имя

Описание

Значение по умолчанию

1

actionKey

Переменная Запрос (REQUEST),  отображающая, какое действие запрашивается. По умолчанию 'service'. Удобно использовать, если на сайте уже используется переменная REQUEST со  значением 'service' и ее нужно изменить.

service

2

loginKey

Параметр для  обеспечения входа / логина на сайт. По умолчанию  'login'. Данный параметр сообщает Login начать работу, только если значениемactionKeyявляется 'login'. Например, если значение actionKey 'service' , а loginKey задан как 'login', то процесс входа начнется при обнаружении условия '&service=login'

login

3

logoutKey

Параметр для  обеспечения выхода с сайта. По умолчанию  'logout'. Данный параметр сообщает Login начать работу, только если значениемactionKeyявляется 'logout'. Например, если значение actionKey 'service' , а loginKey задан как 'logout', то процесс выхода начнется при обнаружении условия '&service=logout'

logout

4

rememberMeKey

Опционально. Имя  поля переключателя Напомнить (Remember Me) для обеспечения возможности входа на сайт. По умолчанию "rememberme".

rememberme

5

tplType

Тип шаблона, обеспечивающий работу  loginTpl or logoutTpl. Возможные значения описаны в разделах ниже.

inline

6

loginTpl

Шаблон формы входа. Тип определяется значением, заданным в свойствах tplType.

lgnLoginTpl

7

logoutTpl

Шаблон формы выхода. Тип определяется значением, заданным в свойствах. tplType 

lgnLogoutTpl

8

errTpl

Шаблон сообщения об ошибке. Тип определяется значением, заданным в свойствах errTplType .

lgnErrTpl

9

errTplType

Тип шаблона, обеспечивающий работу errTpl.

modChunk

10

loginResourceId

Ресурс, перенаправляющий пользователей при успешном входе. 0 перенаправляет в персональный раздел. will redirect to self. Не заполняйте при использовании страницы без авторизации по умолчанию.

0

11

loginResourceParams

Параметры объекта JSON , присоединяемые к ссылке-редиректу при входе в аккаунт. Пример: {"test":123} преобразуется в url.html?test=123

 

12

logoutResourceId

ID ресурса, на который перенаправляется пользователь после успешного выхода из аккаунта. 0 перенаправляет на себя.

0

13

logoutResourceParams

Параметры объекта JSON , присоединяемые к ссылке-редиректу при выходе из аккаунта. Пример: {"test":123} преобразуется в url.html?test=123

 

14

loginMsg

Необязательное сообщение-ярлык при акте входа. Если не заполнена, будет использоваться назначенная по умолчанию строчка из словаря Login.

 

15

logoutMsg

Необязательное сообщение-ярлык при акте выхода. Если не заполнена, будет использоваться назначенная по умолчанию строчка из словаря Logout.

 

16

redirectToPrior

После успешного входа пользователь перенаправится на реферральную страницу (HTTP_REFERER), если значение устнаовлено как true / истина.

0

17

contexts

(Экспериментальный параметр) Контекстный список (разделитель - запятая) для входа. По умолчанию для использования текущего контекста  не требуется задавать какие-либо параметры.

 

18

preHooks

Список 'hooks' (или сниппетов), исполняемых перед тем, как пользователь зарегистрируется, но после валидации. В качестве 'hook' можно задать  'recaptcha'

 

19

postHooks

Список 'hooks' (или сниппетов), исполняемых после того, как пользователь зарегистрируется.

 

20

toPlaceholder

Если задан, будет направлять выходные данные сниппета-логина в плейсхолдер с данным именем вместо непосредственного вывода возвращаемого контента.

 

21

redirectToOnFailedAuth

(Для версии 1.6.4-pl & +) Перенаправляет на отдельную страницу при неверном входе.

 

Опции tplType

tplType и errTplType свойства обладают списком различных опций и позволяют их выбрать. Такими опциями могут быть:

  • modChunk -  Обеспечиваемый шаблон должен быть назван именем чанка.
  • file – Должен быть абсолютный путь к файлу шаблона.
  • inline – Контент шаблона будет непосредственно в его свойствах.
  • embedded – Шаблон уже встроен в страницу, просто задайте свойства ошибки как плейсхолдер.

Использование reCaptcha

Сначала убедитесь, что Системные установки `recaptcha.public_key` и `recaptcha.private_key` установлены в соответствии с вашими reCaptcha API ключами. Затем все, что нужно сделать для их добавления- это добавить  "recaptcha" preHook в ваш вызов сниппета.:

[ [!Login? &preHooks=`recaptcha`] ]

Убедитесь, что плейсхолдер является вашим loginTpl чанком. Это сделает reCaptcha необходимым при входе пользователя с паролем.

Logout

Как выполняется выход пользователя (log out)?  Просто вызываете страницу, содержащую ваш сниппет Loginи передаете определенный 'logout' как сервис / service через URL. В нижеприведенном примере сниппет Login snippet находится на странице 21:

< a href="
[ [~21? &service=logout] ]
" title="Logout">Logout< /a >
(which automatically appends '&service=logout' to your URL)