LinkFormatter.php 8.09 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\Component\Utility\Unicode;
12
use Drupal\Core\Field\FieldDefinitionInterface;
13
use Drupal\Core\Field\FieldItemListInterface;
14
use Drupal\Core\Field\FormatterBase;
15
use Drupal\Core\Form\FormStateInterface;
16 17
use Drupal\Core\Path\PathValidatorInterface;
use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
18 19
use Drupal\Core\Url;
use Drupal\link\LinkItemInterface;
20
use Symfony\Component\DependencyInjection\ContainerInterface;
21
use Symfony\Component\HttpFoundation\Request;
22 23 24 25

/**
 * Plugin implementation of the 'link' formatter.
 *
26
 * @FieldFormatter(
27 28 29 30 31 32 33
 *   id = "link",
 *   label = @Translation("Link"),
 *   field_types = {
 *     "link"
 *   }
 * )
 */
34 35 36 37 38 39 40 41 42 43 44 45 46 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
class LinkFormatter extends FormatterBase implements ContainerFactoryPluginInterface {

  /**
   * The path validator service.
   *
   * @var \Drupal\Core\Path\PathValidatorInterface
   */
  protected $pathValidator;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static(
      $plugin_id,
      $plugin_definition,
      $configuration['field_definition'],
      $configuration['settings'],
      $configuration['label'],
      $configuration['view_mode'],
      $configuration['third_party_settings'],
      $container->get('path.validator')
    );
  }

  /**
   * Constructs a new LinkFormatter.
   *
   * @param string $plugin_id
   *   The plugin_id for the formatter.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
   *   The definition of the field to which the formatter is associated.
   * @param array $settings
   *   The formatter settings.
   * @param string $label
   *   The formatter label display setting.
   * @param string $view_mode
   *   The view mode.
   * @param array $third_party_settings
   *   Third party settings.
   * @param \Drupal\Core\Path\PathValidatorInterface $path_validator
   *   The path validator service.
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, PathValidatorInterface $path_validator) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings);
    $this->pathValidator = $path_validator;
  }
83

84 85 86 87 88 89 90 91 92 93 94 95 96
  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return array(
      'trim_length' => '80',
      'url_only' => '',
      'url_plain' => '',
      'rel' => '',
      'target' => '',
    ) + parent::defaultSettings();
  }

97 98 99
  /**
   * {@inheritdoc}
   */
100
  public function settingsForm(array $form, FormStateInterface $form_state) {
101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172
    $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');
    }

173
    return $summary;
174 175 176 177 178
  }

  /**
   * {@inheritdoc}
   */
179
  public function viewElements(FieldItemListInterface $items) {
180
    $element = array();
181
    $entity = $items->getEntity();
182 183 184
    $settings = $this->getSettings();

    foreach ($items as $delta => $item) {
185
      // By default use the full URL as the link text.
186 187
      $url = $this->buildUrl($item);
      $link_title = $url->toString();
188

189
      // If the title field value is available, use it for the link text.
190
      if (empty($settings['url_only']) && !empty($item->title)) {
191
        // Unsanitized token replacement here because $options['html'] is FALSE
192
        // by default in _l().
193
        $link_title = \Drupal::token()->replace($item->title, array($entity->getEntityTypeId() => $entity), array('sanitize' => FALSE, 'clear' => TRUE));
194 195
      }

196
      // Trim the link text to the desired length.
197
      if (!empty($settings['trim_length'])) {
198
        $link_title = Unicode::truncate($link_title, $settings['trim_length'], FALSE, TRUE);
199 200 201 202
      }

      if (!empty($settings['url_only']) && !empty($settings['url_plain'])) {
        $element[$delta] = array(
203
          '#markup' => String::checkPlain($link_title),
204
        );
205 206 207 208 209

        if (!empty($item->_attributes)) {
          // Piggyback on the metadata attributes, which will be placed in the
          // field template wrapper, and set the URL value in a content
          // attribute.
210
          $item->_attributes += array('content' => $item->uri);
211
        }
212 213 214 215 216
      }
      else {
        $element[$delta] = array(
          '#type' => 'link',
          '#title' => $link_title,
217
          '#options' => $url->getOptions(),
218
        );
219
        $element[$delta]['#url'] = $url;
220 221 222 223 224 225 226 227

        if (!empty($item->_attributes)) {
          $element[$delta]['#options'] += array ('attributes' => array());
          $element[$delta]['#options']['attributes'] += $item->_attributes;
          // Unset field item attributes since they have been included in the
          // formatter output and should not be rendered in the field template.
          unset($item->_attributes);
        }
228 229 230 231 232
      }
    }

    return $element;
  }
233 234

  /**
235
   * Builds the \Drupal\Core\Url object for a link field item.
236
   *
237
   * @param \Drupal\link\LinkItemInterface $item
238 239
   *   The link field item being rendered.
   *
240 241
   * @return \Drupal\Core\Url
   *   An Url object.
242
   */
243
  protected function buildUrl(LinkItemInterface $item) {
244 245 246 247
    // @todo Consider updating the usage of the path validator with whatever
    // gets added in https://www.drupal.org/node/2405551.
    $url = $this->pathValidator->getUrlIfValidWithoutAccessCheck($item->uri) ?: Url::fromRoute('<none>');

248
    $settings = $this->getSettings();
249
    $options = $item->options;
250 251 252

    // Add optional 'rel' attribute to link options.
    if (!empty($settings['rel'])) {
253
      $options['attributes']['rel'] = $settings['rel'];
254 255 256
    }
    // Add optional 'target' attribute to link options.
    if (!empty($settings['target'])) {
257 258
      $options['attributes']['target'] = $settings['target'];
    }
259
    $url->setOptions($options);
260

261
    return $url;
262 263
  }

264
}