change_login.rdoc

doc/change_login.rdoc
Last Update: 2023-10-09 15:48:54 -0700

Documentation for Change Login Feature

The change login feature implements a form that a user can use to change their login.

Auth Value Methods

change_login_additional_form_tags

HTML fragment containing additional form tags to use on the change login form.

change_login_button

The text to use for the change login button.

change_login_error_flash

The flash error to show for an unsuccessful login change.

change_login_notice_flash

The flash notice to show after a successful login change.

change_login_page_title

The page title to use on the change login form.

change_login_redirect

Where to redirect after a sucessful login change.

change_login_requires_password?

Whether a password is required when changing logins.

change_login_route

The route to the change login action. Defaults to change-login.

same_as_current_login_message

The error message to display if using the same value as the current login when changing the login.

Auth Methods

after_change_login

Run arbitrary code after successful login change.

before_change_login

Run arbitrary code before changing a login.

before_change_login_route

Run arbitrary code before handling a change login route.

change_login(login)

Change the users login to the given login, or return nil/false if the login cannot be changed to the given login.

change_login_response

Return a response after a successful login change. By default, redirects to change_login_redirect.

change_login_view

The HTML to use for the change login form.