LinkFormatter.php 5.61 KB
Newer Older
1 2 3 4 5 6 7
<?php

/**
 * @file
 * Contains \Drupal\link\Plugin\field\formatter\LinkFormatter.
 */

8
namespace Drupal\link\Plugin\Field\FieldFormatter;
9

10
use Drupal\Component\Utility\String;
11
use Drupal\Core\Field\FieldItemListInterface;
12
use Drupal\Core\Field\FormatterBase;
13
use Drupal\Core\Form\FormStateInterface;
14 15
use Drupal\Core\Url;
use Drupal\link\LinkItemInterface;
16 17 18 19

/**
 * Plugin implementation of the 'link' formatter.
 *
20
 * @FieldFormatter(
21 22 23 24 25 26 27 28 29
 *   id = "link",
 *   label = @Translation("Link"),
 *   field_types = {
 *     "link"
 *   }
 * )
 */
class LinkFormatter extends FormatterBase {

30 31 32 33 34 35 36 37 38 39 40 41 42
  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return array(
      'trim_length' => '80',
      'url_only' => '',
      'url_plain' => '',
      'rel' => '',
      'target' => '',
    ) + parent::defaultSettings();
  }

43 44 45
  /**
   * {@inheritdoc}
   */
46
  public function settingsForm(array $form, FormStateInterface $form_state) {
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118
    $elements = parent::settingsForm($form, $form_state);

    $elements['trim_length'] = array(
      '#type' => 'number',
      '#title' => t('Trim link text length'),
      '#field_suffix' => t('characters'),
      '#default_value' => $this->getSetting('trim_length'),
      '#min' => 1,
      '#description' => t('Leave blank to allow unlimited link text lengths.'),
    );
    $elements['url_only'] = array(
      '#type' => 'checkbox',
      '#title' => t('URL only'),
      '#default_value' => $this->getSetting('url_only'),
      '#access' => $this->getPluginId() == 'link',
    );
    $elements['url_plain'] = array(
      '#type' => 'checkbox',
      '#title' => t('Show URL as plain text'),
      '#default_value' => $this->getSetting('url_plain'),
      '#access' => $this->getPluginId() == 'link',
      '#states' => array(
        'visible' => array(
          ':input[name*="url_only"]' => array('checked' => TRUE),
        ),
      ),
    );
    $elements['rel'] = array(
      '#type' => 'checkbox',
      '#title' => t('Add rel="nofollow" to links'),
      '#return_value' => 'nofollow',
      '#default_value' => $this->getSetting('rel'),
    );
    $elements['target'] = array(
      '#type' => 'checkbox',
      '#title' => t('Open link in new window'),
      '#return_value' => '_blank',
      '#default_value' => $this->getSetting('target'),
    );

    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = array();

    $settings = $this->getSettings();

    if (!empty($settings['trim_length'])) {
      $summary[] = t('Link text trimmed to @limit characters', array('@limit' => $settings['trim_length']));
    }
    else {
      $summary[] = t('Link text not trimmed');
    }
    if ($this->getPluginId() == 'link' && !empty($settings['url_only'])) {
      if (!empty($settings['url_plain'])) {
        $summary[] = t('Show URL only as plain-text');
      }
      else {
        $summary[] = t('Show URL only');
      }
    }
    if (!empty($settings['rel'])) {
      $summary[] = t('Add rel="@rel"', array('@rel' => $settings['rel']));
    }
    if (!empty($settings['target'])) {
      $summary[] = t('Open link in new window');
    }

119
    return $summary;
120 121 122 123 124
  }

  /**
   * {@inheritdoc}
   */
125
  public function viewElements(FieldItemListInterface $items) {
126
    $element = array();
127
    $entity = $items->getEntity();
128 129 130
    $settings = $this->getSettings();

    foreach ($items as $delta => $item) {
131
      // By default use the full URL as the link text.
132 133
      $url = $this->buildUrl($item);
      $link_title = $url->toString();
134

135
      // If the title field value is available, use it for the link text.
136
      if (empty($settings['url_only']) && !empty($item->title)) {
137
        // Unsanitized token replacement here because $options['html'] is FALSE
138
        // by default in l().
139
        $link_title = \Drupal::token()->replace($item->title, array($entity->getEntityTypeId() => $entity), array('sanitize' => FALSE, 'clear' => TRUE));
140 141
      }

142
      // Trim the link text to the desired length.
143 144 145 146 147 148
      if (!empty($settings['trim_length'])) {
        $link_title = truncate_utf8($link_title, $settings['trim_length'], FALSE, TRUE);
      }

      if (!empty($settings['url_only']) && !empty($settings['url_plain'])) {
        $element[$delta] = array(
149
          '#markup' => String::checkPlain($link_title),
150 151 152 153 154 155
        );
      }
      else {
        $element[$delta] = array(
          '#type' => 'link',
          '#title' => $link_title,
156
          '#options' => $url->getOptions(),
157
        );
158 159 160 161 162 163 164
        if ($url->isExternal()) {
          $element[$delta]['#href'] = $url->getPath();
        }
        else {
          $element[$delta]['#route_name'] = $url->getRouteName();
          $element[$delta]['#route_parameters'] = $url->getRouteParameters();
        }
165 166 167 168 169
      }
    }

    return $element;
  }
170 171

  /**
172
   * Builds the \Drupal\Core\Url object for a link field item.
173
   *
174
   * @param \Drupal\link\LinkItemInterface $item
175 176
   *   The link field item being rendered.
   *
177 178
   * @return \Drupal\Core\Url
   *   An Url object.
179
   */
180
  protected function buildUrl(LinkItemInterface $item) {
181
    $settings = $this->getSettings();
182
    $options = $item->options;
183 184 185

    // Add optional 'rel' attribute to link options.
    if (!empty($settings['rel'])) {
186
      $options['attributes']['rel'] = $settings['rel'];
187 188 189
    }
    // Add optional 'target' attribute to link options.
    if (!empty($settings['target'])) {
190 191 192 193 194 195 196 197 198
      $options['attributes']['target'] = $settings['target'];
    }

    if ($item->isExternal()) {
      $url = Url::createFromPath($item->url);
      $url->setOptions($options);
    }
    else {
      $url = new Url($item->route_name, (array) $item->route_parameters, (array) $options);
199 200
    }

201
    return $url;
202 203
  }

204
}