www.aleph1.co.uk Git - yaffs-website/blob - web/core/modules/basic_auth/basic_auth.module

   1 <?php
   2
   3 /**
   4  * @file
   5  * Provides an HTTP Basic authentication provider.
   6  */
   7
   8 use Drupal\Core\Routing\RouteMatchInterface;
   9
  10 /**
  11  * Implements hook_help().
  12  */
  13 function basic_auth_help($route_name, RouteMatchInterface $route_match) {
  14   switch ($route_name) {
  15     case 'help.page.basic_auth':
  16       $output = '';
  17       $output .= '<h3>' . t('About') . '</h3>';
  18       $output .= '<p>' . t('The HTTP Basic Authentication module supplies an <a href="http://en.wikipedia.org/wiki/Basic_access_authentication">HTTP Basic authentication</a> provider for web service requests. This authentication provider authenticates requests using the HTTP Basic Authentication username and password, as an alternative to using Drupal\'s standard cookie-based authentication system. It is only useful if your site provides web services configured to use this type of authentication (for instance, the <a href=":rest_help">RESTful Web Services module</a>). For more information, see the <a href=":hba_do">online documentation for the HTTP Basic Authentication module</a>.', [':hba_do' => 'https://www.drupal.org/documentation/modules/basic_auth', ':rest_help' => (\Drupal::moduleHandler()->moduleExists('rest')) ? \Drupal::url('help.page', ['name' => 'rest']) : '#']) . '</p>';
  19       return $output;
  20   }
  21 }