Register

Что такое Register?¶

Register обрабатывает форму регистрации. Это Snippet. Пример вызова: here.

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

Разместите сниппет Register на ресурсе с формой регистрации. Пакет Login поставляет форму по умолчанию lgnRegisterForm. Сниппет требует активации: пользователь получит письмо о регистрации.

Свойства по умолчанию¶

Validators¶

Валидаторы в Login используют тот же синтаксис, что и FormIt Validators.

Custom Validators¶

Можно создать пользовательский валидатор как сниппет. Его имя обязательно укажите в customValidators, иначе он не запустится. Пример: сниппет equalTo и поле:

<label>
  Boxes:<span class="error">[[+error.boxes]]</span>
  <input type="text" name="boxes" id="boxes" value="[[+boxes]]" />
</label>

Вызов Register:

[[!Register?
  &validate=`boxes:equalTo=^123^`
  &customValidators=`equalTo`
]]

Код сниппета:

<?php
if ($scriptProperties['value'] !== $scriptProperties['param']) {
    return 'Value not equal to: '.$scriptProperties['param'];
}
return true;
?>

true означает, что поле прошло проверку. Любое другое значение станет текстом ошибки. Сниппет получает параметры в массиве $scriptProperties:

• key: имя поля.
• value: значение поля.
• param: параметр валидатора, если передан.
• Type: имя валидатора.
• validator: ссылка на экземпляр lgnValidator.

После валидации¶

После успешной валидации Register может:

• добавить пользователя в группы
• отправить письмо активации
• перенаправить на ресурс (например «Registered!»)
• показать сообщение об успехе

Назначение пользователя в группы¶

Укажите список имён или ID групп в свойстве &usergroups. Пример для групп «Marketing» и «Research»:

[[!Register? &usergroups=`Marketing,Research`]]

Можно указать роль после имени группы через двоеточие:

[[!Register? &usergroups=`Marketing:Member,Research:Super User`]]

Отправка письма активации¶

Register по умолчанию требует активации аккаунта перед входом. Сниппет создаёт modUser с active=0. Пользователь получает письмо со ссылкой. После перехода аккаунт получает active=1, и пользователь может войти.

Создайте страницу активации: новый ресурс и сниппет ConfirmRegister.

Задайте чанк для письма. Пример: lgnActivateEmailTpl.

Пример вызова Register с активацией:

[[!Register?
   &activationEmailTpl=`myActivationEmailTpl`
   &activationEmailSubject=`Please activate your account!`
   &activationResourceId=`26`
   &submittedResourceId=`325`
]]

Пользователь получит письмо из чанка myActivationEmailTpl с указанной темой. Ссылка ведёт на ресурс 26 для активации. После отправки письма пользователь попадёт на ресурс 325.

Отключите активацию через `&activation=``. Тогда любой, включая спам-ботов, сможет зарегистрироваться и сразу стать активным.

&activationEmailTpl по умолчанию это имя чанка. Тип меняется через &activationEmailTplType:

• modChunk: имя чанка (по умолчанию).
• file: файл с абсолютным путём. Плейсхолдеры: {core_path}, {base_path}, {assets_path}.
• inline: HTML прямо в значении свойства.

Время жизни письма активации задаётся в activationttl (минуты). По умолчанию 3 часа.

Перенаправление после валидации¶

Укажите ID ресурса в submittedResourceId:

[[!Register? &submittedResourceId=`23`]]

Перенаправление идёт на ресурс 23. К URL добавятся GET-параметры username и email.

Сообщение об успехе¶

Если submittedResourceId не задан, Register выводит сообщение в плейсхолдер [[+error.message]]. Значение берётся из successMsg:

[[!Register? &successMsg=`Thanks for registering!`]]

После отправки валидной формы на странице с [[Register]] появится «Thanks for registering!» в [[+error.message]].

Типичная настройка¶

При регистрации легко запутаться в страницах. В типичной схеме четыре отдельные страницы:

Register: страница с формой регистрации. Перенаправляет на «Thanks for Registering». Содержит форму и вызов Register.

Thanks for Registering: страница после отправки формы. Только текст без сниппетов: «Thank you for Registering - you'll get an email» и т. п.

Confirm Register: страница по ссылке из письма. Пользователь её не видит напрямую. Активирует аккаунт и перенаправляет на Registration Confirmed. Только вызов ConfirmRegister.

Registration Confirmed: страница после Confirm Register. Только текст: «Congratulations, you're now an active user».

См. также¶

1. Login.Login
2. Login.Profile
3. Login.UpdateProfile
4. Login.Register
   1. Register.Example Form 1
5. Login.ConfirmRegister
6. Login.ForgotPassword
7. Login.ResetPassword
8. Login.ChangePassword
9. Login.Tutorials
   1. Login.Basic Setup
   2. Login.Extended User Profiles
   3. Login.Request Membership
   4. Login.User Profiles
   5. Login.Using Custom Fields
   6. Login.Using Pre and Post Hooks