function logintoboggan_help in LoginToboggan 8

Same name and namespace in other branches

1. 5 logintoboggan.module \logintoboggan_help()
2. 6 logintoboggan.module \logintoboggan_help()
3. 7 logintoboggan.module \logintoboggan_help()

Implements hook_help().

File

./logintoboggan.module, line 76

LoginToboggan module.

Code

function logintoboggan_help($route_name, RouteMatchInterface $route_match) {
  switch ($route_name) {
    case 'help.page.logintoboggan':
      $output = t("<p>The Login Toboggan module improves the Drupal login system by offering the following features:\n      <ol>\n      <li>Allow users to login using either their username OR their e-mail address.</li>\n      <li>Allow users to login immediately.</li>\n      <li>Provide a login form on Access Denied pages for non-logged-in (anonymous) users.</li>\n      <li>The module provides two login block options: One uses JavaScript to display the form within the block immediately upon clicking 'log in'. The other brings the user to a separate page, but returns the user to their original page upon login.</li>\n      <li>Customize the registration form with two e-mail fields to ensure accuracy.</li>\n      <li>Optionally redirect the user to a specific page when using the 'Immediate login' feature.</li>\n      <li>Optionally redirect the user to a specific page upon validation of their e-mail address.</li>\n      <li>Optionally display a user message indicating a successful login.</li>\n      <li>Optionally combine both the login, registration and password reset forms on one page.</li>\n      <li>Optionally have unvalidated users purged from the system at a pre-defined interval \n      (please read the CAVEATS section of INSTALL.txt for important information on configuring this feature!).</li>\n      </ol>\n      These features may be turned on or off in the Login Toboggan <a href=\":url\">settings</a>.</p>\n      <p>Because this module completely reorients the Drupal login process you will probably want to edit the \n      welcome e-mail on the <a href=\":user_settings\">user settings</a> page. Note when the 'Set password' option \n      is enabled, the [user:validate-url] token becomes a verification url that the user MUST visit in order to \n      get the trusted role). The following is an example welcome e-mail:</p> ===<br>", [
        ':url' => Url::fromRoute('logintobogganform.settings')
          ->toString(),
        ':user_settings' => Url::fromRoute('entity.user.admin_form')
          ->toString(),
      ]);
      $example_help_form = \Drupal::formBuilder()
        ->getForm('\\Drupal\\logintoboggan\\Form\\LogintobogganHelpForm');
      $output .= \Drupal::service('renderer')
        ->render($example_help_form);
      $output .= t("===<p>Note that if you have set the 'Visitors can create accounts but administrator approval is required' \n        option for account approval, and are also using the 'Set password' feature of LoginToboggan, the user will immediately receive the permissions of the authenticated user role. \n        LoginToboggan provides for a trusted role that automatically inherits the authenticated role permissions. \n        You may wish to give that role extra permissions and restricted the authenticated role to the same permissions as the anonymous user role.</p>\n        <p>In order for a site administrator to unblock a user who is awaiting administrator approval, they must either click on the validation link they receive in their notification e-mail, or \n        manually add the trusted role to that user. In either case, the user will receive an account activated e-mail if it's enabled on the user settings page\n         -- it's recommended that you edit the default text of the activation e-mail to match LoginToboggan's workflow as described. </p\n         ><p>If you are using the 'Visitors can create accounts and no administrator approval is required' option, addition of the trusted role will happen automatically \n         when the user validates via e-mail link.</p><p>Also be aware that LoginToboggan only affects registrations initiated by users--any user account created \n         by an administrator will not use any LoginToboggan functionality.</p>");
      return $output;
  }
}