LinkIframeFormatter.php in Link iframe formatter 2.x

Namespace

Drupal\link_iframe_formatter\Plugin\Field\FieldFormatter

File

src/Plugin/Field/FieldFormatter/LinkIframeFormatter.php

<?php

namespace Drupal\link_iframe_formatter\Plugin\Field\FieldFormatter;

use Drupal\Core\Field\FieldItemListInterface;
use Drupal\Core\Form\FormStateInterface;
use Drupal\link\Plugin\Field\FieldFormatter\LinkFormatter;

/**
 * Plugin implementation of the 'link_iframe_formatter' formatter.
 *
 * @FieldFormatter(
 *   id = "link_iframe_formatter",
 *   label = @Translation("Iframe Formatter"),
 *   field_types = {
 *     "link"
 *   }
 * )
 */
class LinkIframeFormatter extends LinkFormatter {

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'width' => 640,
      'height' => 480,
      'class' => '',
      'original' => FALSE,
      'disable_scrolling' => FALSE,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $elements['width'] = [
      '#title' => $this
        ->t('Width'),
      '#type' => 'textfield',
      '#default_value' => $this
        ->getSetting('width'),
      '#required' => TRUE,
    ];
    $elements['height'] = [
      '#title' => $this
        ->t('Height'),
      '#type' => 'textfield',
      '#default_value' => $this
        ->getSetting('height'),
      '#required' => TRUE,
    ];
    $elements['disable_scrolling'] = [
      '#title' => t('Disable Scrolling'),
      '#type' => 'checkbox',
      '#default_value' => $this
        ->getSetting('disable_scrolling'),
    ];
    $elements['class'] = [
      '#title' => $this
        ->t('Class'),
      '#type' => 'textfield',
      '#default_value' => $this
        ->getSetting('class'),
      '#required' => FALSE,
    ];
    $elements['original'] = [
      '#title' => $this
        ->t('Show original link'),
      '#type' => 'radios',
      '#options' => [
        TRUE => $this
          ->t('On'),
        FALSE => $this
          ->t('Off'),
      ],
      '#default_value' => $this
        ->getSetting('original'),
      '#required' => FALSE,
    ];
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];
    $summary[] = $this
      ->t('Width: @width, Height: @height, Scrolling: @scrolling, Class: @class, Original link is @original', [
      '@width' => $this
        ->getSetting('width'),
      '@height' => $this
        ->getSetting('height'),
      '@scrolling' => $this
        ->getSetting('disable_scrolling') ? 'no' : 'yes',
      '@class' => $this
        ->getSetting('class') == "" ? 'None' : $this
        ->getSetting('class'),
      '@original' => $this
        ->getSetting('original') ? t('On') : t('Off'),
    ]);
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $element = [];
    $settings = $this
      ->getSettings();
    foreach ($items as $delta => $item) {

      // By default use the full URL as the link text.
      $url = $this
        ->buildUrl($item);
      $element[$delta] = [
        '#theme' => 'link_iframe_formatter',
        '#url' => $url,
        '#width' => $settings['width'],
        '#height' => $settings['height'],
        '#scrolling' => $settings['disable_scrolling'] ? 'no' : 'yes',
        '#class' => $settings['class'],
        '#original' => $settings['original'],
        '#path' => $url,
      ];
    }
    return $element;
  }

}

Classes

Name	Description
LinkIframeFormatter	Plugin implementation of the 'link_iframe_formatter' formatter.