public function ExtlinkAdminSettingsForm::buildForm in External Links 8

Form constructor.

Parameters

array $form: An associative array containing the structure of the form.

\Drupal\Core\Form\FormStateInterface $form_state: The current state of the form.

Return value

array The form structure.

Overrides ConfigFormBase::buildForm

File

src/Form/ExtlinkAdminSettingsForm.php, line 50

Class

ExtlinkAdminSettingsForm

Displays the extlink settings form.

Namespace

Drupal\extlink\Form

Code

public function buildForm(array $form, FormStateInterface $form_state) {
  $config = $this
    ->config('extlink.settings');
  $renderer = $this->renderer;
  $form['extlink_exclude_admin_routes'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Disable on admin routes.'),
    '#default_value' => $config
      ->get('extlink_exclude_admin_routes'),
    '#description' => $this
      ->t('Whether the extlink module should be disabled on admin routes.'),
  ];
  $form['extlink_use_external_js_file'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Load exclusions and inclusions externally.'),
    '#default_value' => $config
      ->get('extlink_use_external_js_file'),
    '#description' => $this
      ->t('Whether the extlink JS settings should be added to the page via an external settings file. In the case of a large number of patterns, this will reduce the amount of markup added to each page.'),
  ];
  $form['extlink_class'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Place an icon next to external links.'),
    '#return_value' => 'ext',
    '#default_value' => $config
      ->get('extlink_class'),
    '#description' => $this
      ->t('Places an <span class="ext"> </span>&nbsp; icon next to external links.'),
  ];
  $form['extlink_mailto_class'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Place an icon next to mailto links.'),
    '#return_value' => 'mailto',
    '#default_value' => $config
      ->get('extlink_mailto_class'),
    '#description' => $this
      ->t('Places an <span class="mailto"> </span>&nbsp; icon next to mailto links.'),
  ];
  $form['extlink_img_class'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Place an icon next to image links.'),
    '#default_value' => $config
      ->get('extlink_img_class', FALSE),
    '#description' => $this
      ->t('If checked, images wrapped in an anchor tag will be treated as external links.'),
  ];
  $form['extlink_use_font_awesome'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Use Font Awesome icons instead of images.'),
    '#default_value' => $config
      ->get('extlink_use_font_awesome', FALSE),
    '#description' => $this
      ->t('Add Font Awesome classes to the link as well as an i tag rather than images.'),
  ];
  $form['extlink_font_awesome_classes'] = [
    '#type' => 'details',
    '#title' => $this
      ->t('Font Awesome icon classes'),
    '#tree' => TRUE,
    '#states' => [
      'visible' => [
        ':input[name="extlink_use_font_awesome"]' => [
          'checked' => TRUE,
        ],
      ],
    ],
  ];
  $form['extlink_font_awesome_classes']['links'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Font Awesome External Links Classes'),
    '#default_value' => $config
      ->get('extlink_font_awesome_classes.links') ?: 'fa fa-external-link',
    '#states' => [
      'visible' => [
        ':input[name="extlink_class"]' => [
          'checked' => TRUE,
        ],
      ],
    ],
  ];
  $form['extlink_font_awesome_classes']['mailto'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Font Awesome mailto Links Classes'),
    '#default_value' => $config
      ->get('extlink_font_awesome_classes.mailto') ?: 'fa fa-envelope-o',
    '#states' => [
      'visible' => [
        ':input[name="extlink_mailto_class"]' => [
          'checked' => TRUE,
        ],
      ],
    ],
  ];
  $form['extlink_icon_placement'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Add icon in front of any processed link.'),
    '#return_value' => 'prepend',
    '#default_value' => $config
      ->get('extlink_icon_placement', 'append'),
    '#description' => $this
      ->t('If checked, the icon will be placed in front of any external link, otherwise it will be placed behind it.'),
  ];
  $form['extlink_subdomains'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Exclude links with the same primary domain.'),
    '#default_value' => $config
      ->get('extlink_subdomains'),
    '#description' => $this
      ->t("For example, a link from 'www.example.com' to the subdomain of 'my.example.com' would be excluded."),
  ];
  $form['extlink_target'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Open external links in a new window or tab.'),
    '#default_value' => $config
      ->get('extlink_target'),
    '#description' => $this
      ->t('A link will open in a new window or tab (depending on which web browser is used and how it is configured).'),
  ];
  $form['extlink_target_no_override'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Do not alter links with a default target value'),
    '#default_value' => $config
      ->get('extlink_target_no_override'),
    '#description' => $this
      ->t("A link that specifies target='_self' will not be changed to target='_blank'."),
    '#states' => [
      'visible' => [
        ':input[name="extlink_target"]' => [
          'checked' => TRUE,
        ],
      ],
    ],
  ];
  $form['extlink_noreferrer'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Tag external links as "noreferrer".'),
    '#default_value' => $config
      ->get('extlink_noreferrer'),
  ];
  $form['extlink_nofollow'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Tag external links as "no follow".'),
    '#default_value' => $config
      ->get('extlink_nofollow'),
  ];
  $form['extlink_follow_no_override'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Do not override rel="follow", if set'),
    '#default_value' => $config
      ->get('extlink_follow_no_override'),
    '#states' => [
      'visible' => [
        ':input[name="extlink_nofollow"]' => [
          'checked' => TRUE,
        ],
      ],
    ],
  ];
  $form['extlink_alert'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Display a pop-up warning when any external link is clicked.'),
    '#default_value' => $config
      ->get('extlink_alert'),
  ];
  $form['extlink_alert_text'] = [
    '#type' => 'textarea',
    '#title' => $this
      ->t('Text to display in the pop-up warning box.'),
    '#rows' => 3,
    '#default_value' => $config
      ->get('extlink_alert_text'),
    '#description' => $this
      ->t('Text to display in the pop-up external link warning box.'),
    '#wysiwyg' => FALSE,
    '#states' => [
      // Only show this field when user opts to display a pop-up warning.
      'visible' => [
        ':input[name="extlink_alert"]' => [
          'checked' => TRUE,
        ],
      ],
    ],
  ];
  $form['whitelisted_domains'] = [
    '#type' => 'textarea',
    '#title' => $this
      ->t('Whitelisted domains.'),
    '#maxlength' => NULL,
    '#default_value' => implode(PHP_EOL, (array) $config
      ->get('whitelisted_domains')),
    '#description' => $this
      ->t('Enter a line-separated list of whitelisted domains (ie "example.com").'),
  ];
  $patterns = [
    '#theme' => 'item_list',
    '#items' => [
      [
        '#markup' => '<code>(example\\.com)</code> ' . $this
          ->t('Matches example.com.'),
      ],
      [
        '#markup' => '<code>(example\\.com)|(example\\.net)</code> ' . $this
          ->t('Multiple patterns can be strung together by using a pipe. Matches example.com OR example.net.'),
      ],
      [
        '#markup' => '<code>(links/goto/[0-9]+/[0-9]+)</code> ' . $this
          ->t('Matches links that go through the <a target="Links-module" href="http://drupal.org/project/links">Links module</a> redirect.'),
      ],
    ],
  ];
  $wildcards = [
    '#theme' => 'item_list',
    '#items' => [
      [
        '#markup' => '<code>.</code> ' . $this
          ->t('Matches any character.'),
      ],
      [
        '#markup' => '<code>?</code> ' . $this
          ->t('The previous character or set is optional.'),
      ],
      [
        '#markup' => '<code>\\d</code> ' . $this
          ->t('Matches any digit (0-9).'),
      ],
      [
        '#markup' => '<code>[a-z]</code> ' . $this
          ->t('Brackets may be used to match a custom set of characters. This matches any alphabetic letter.'),
      ],
    ],
  ];
  $form['patterns'] = [
    '#type' => 'details',
    '#title' => $this
      ->t('Pattern matching.'),
    '#description' => '<p>' . $this
      ->t('External links uses patterns (regular expressions) to match the "href" property of links.') . '</p>' . $this
      ->t('Here are some common patterns.') . $renderer
      ->render($patterns) . $this
      ->t('Common special characters:') . $renderer
      ->render($wildcards) . '<p>' . $this
      ->t('All special characters (<code>@characters</code>) must also be escaped with backslashes. Patterns are not case-sensitive. Any <a target="pattern supported by JavaScript" href="http://www.javascriptkit.com/javatutors/redev2.shtml">pattern supported by JavaScript</a> may be used.', [
      '@characters' => '^ $ . ? ( ) | * +',
    ]) . '</p>',
    '#open' => FALSE,
  ];
  $form['patterns']['extlink_exclude'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Exclude links matching the pattern.'),
    '#maxlength' => NULL,
    '#default_value' => $config
      ->get('extlink_exclude'),
    '#description' => $this
      ->t('Enter a regular expression for links that you wish to exclude from being considered external.'),
  ];
  $form['patterns']['extlink_include'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Include links matching the pattern.'),
    '#maxlength' => NULL,
    '#default_value' => $config
      ->get('extlink_include'),
    '#description' => $this
      ->t('Enter a regular expression for internal links that you wish to be considered external.'),
  ];
  $form['css_matching'] = [
    '#tree' => FALSE,
    '#type' => 'fieldset',
    '#title' => $this
      ->t('CSS Matching.'),
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
    '#description' => '<p>' . $this
      ->t('Use CSS selectors to exclude entirely or only look inside explicitly specified classes and IDs for external links.  These will be passed straight to jQuery for matching.') . '</p>',
  ];
  $form['css_matching']['extlink_css_exclude'] = [
    '#type' => 'textarea',
    '#title' => $this
      ->t('Exclude links inside these CSS selectors.'),
    '#maxlength' => NULL,
    '#default_value' => $config
      ->get('extlink_css_exclude', ''),
    '#description' => $this
      ->t('Enter a comma-separated list of CSS selectors (ie "#block-block-2 .content, ul.menu").'),
  ];
  $form['css_matching']['extlink_css_explicit'] = [
    '#type' => 'textarea',
    '#title' => $this
      ->t('Only look for links inside these CSS selectors.'),
    '#maxlength' => NULL,
    '#default_value' => $config
      ->get('extlink_css_explicit', ''),
    '#description' => $this
      ->t('Enter a comma-separated list of CSS selectors (ie "#block-block-2 .content, ul.menu").'),
  ];
  return parent::buildForm($form, $form_state);
}