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

   1 <?php
   2
   3 /**
   4  * @file
   5  * Defines simple link field types.
   6  */
   7
   8 use Drupal\Core\Routing\RouteMatchInterface;
   9
  10 /**
  11  * Implements hook_help().
  12  */
  13 function link_help($route_name, RouteMatchInterface $route_match) {
  14   switch ($route_name) {
  15     case 'help.page.link':
  16       $output = '';
  17       $output .= '<h3>' . t('About') . '</h3>';
  18       $output .= '<p>' . t('The Link module allows you to create fields that contain internal or external URLs and optional link text. See the <a href=":field">Field module help</a> and the <a href=":field_ui">Field UI help</a> pages for general information on fields and how to create and manage them. For more information, see the <a href=":link_documentation">online documentation for the Link module</a>.', [':field' => \Drupal::url('help.page', ['name' => 'field']), ':field_ui' => (\Drupal::moduleHandler()->moduleExists('field_ui')) ? \Drupal::url('help.page', ['name' => 'field_ui']) : '#', ':link_documentation' => 'https://www.drupal.org/documentation/modules/link']) . '</p>';
  19       $output .= '<h3>' . t('Uses') . '</h3>';
  20       $output .= '<dl>';
  21       $output .= '<dt>' . t('Managing and displaying link fields') . '</dt>';
  22       $output .= '<dd>' . t('The <em>settings</em> and the <em>display</em> of the link field can be configured separately. See the <a href=":field_ui">Field UI help</a> for more information on how to manage fields and their display.', [':field_ui' => (\Drupal::moduleHandler()->moduleExists('field_ui')) ? \Drupal::url('help.page', ['name' => 'field_ui']) : '#']) . '</dd>';
  23       $output .= '<dt>' . t('Setting the allowed link type') . '</dt>';
  24       $output .= '<dd>' . t('In the field settings you can define the allowed link type to be <em>internal links only</em>, <em>external links only</em>, or <em>both internal and external links</em>. <em>Internal links only</em> and <em>both internal and external links</em> options enable an autocomplete widget for internal links, so a user does not have to copy or remember a URL.') . '</dd>';
  25       $output .= '<dt>' . t('Adding link text') . '</dt>';
  26       $output .= '<dd>' . t('In the field settings you can define additional link text to be <em>optional</em> or <em>required</em> in any link field.') . '</dd>';
  27       $output .= '<dt>' . t('Displaying link text') . '</dt>';
  28       $output .= '<dd>' . t('If link text has been submitted for a URL, then by default this link text is displayed as a link to the URL. If you want to display both the link text <em>and</em> the URL, choose the appropriate link format from the drop-down menu in the <em>Manage display</em> page. If you only want to display the URL even if link text has been submitted, choose <em>Link</em> as the format, and then change its <em>Format settings</em> to display <em>URL only</em>.') . '</dd>';
  29       $output .= '<dt>' . t('Adding attributes to links') . '</dt>';
  30       $output .= '<dd>' . t('You can add attributes to links, by changing the <em>Format settings</em> in the <em>Manage display</em> page. Adding <em>rel="nofollow"</em> notifies search engines that links should not be followed.') . '</dd>';
  31       $output .= '<dt>' . t('Validating URLs') . '</dt>';
  32       $output .= '<dd>' . t('All links are validated after a link field is filled in. They can include anchors or query strings.') . '</dd>';
  33       $output .= '</dl>';
  34       return $output;
  35   }
  36 }
  37
  38 /**
  39  * Implements hook_theme().
  40  */
  41 function link_theme() {
  42   return [
  43     'link_formatter_link_separate' => [
  44       'variables' => ['title' => NULL, 'url_title' => NULL, 'url' => NULL],
  45     ],
  46   ];
  47 }
  48
  49 /**
  50  * Prepares variables for separated link field templates.
  51  *
  52  * This template outputs a separate title and link.
  53  *
  54  * Default template: link-formatter-link-separate.html.twig.
  55  *
  56  * @param array $variables
  57  *   An associative array containing:
  58  *   - title: (optional) A descriptive or alternate title for the link, which
  59  *     may be different than the actual link text.
  60  *   - url_title: The anchor text for the link.
  61  *   - url: A \Drupal\Core\Url object.
  62  */
  63 function template_preprocess_link_formatter_link_separate(&$variables) {
  64   $variables['link'] = \Drupal::l($variables['url_title'], $variables['url']);
  65 }