You are here

Home » API reference » Link iframe formatter 2.x » LinkIframeFormatter.php

class LinkIframeFormatter in Link iframe formatter 2.x

Same name and namespace in other branches
  1. 8 src/Plugin/Field/FieldFormatter/LinkIframeFormatter.php \Drupal\link_iframe_formatter\Plugin\Field\FieldFormatter\LinkIframeFormatter

Plugin implementation of the 'link_iframe_formatter' formatter.

Plugin annotation


@FieldFormatter(
  id = "link_iframe_formatter",
  label = @Translation("Iframe Formatter"),
  field_types = {
    "link"
  }
)

Hierarchy

Expanded class hierarchy of LinkIframeFormatter

File

src/Plugin/Field/FieldFormatter/LinkIframeFormatter.php, line 20

Namespace

Drupal\link_iframe_formatter\Plugin\Field\FieldFormatter
View source 
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;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
FormatterBase::$fieldDefinition protected property The field definition.
FormatterBase::$label protected property The label display setting.
FormatterBase::$settings protected property The formatter settings. Overrides PluginSettingsBase::$settings
FormatterBase::$viewMode protected property The view mode.
FormatterBase::getFieldSetting protected function Returns the value of a field setting.
FormatterBase::getFieldSettings protected function Returns the array of field settings.
FormatterBase::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides FormatterInterface::isApplicable 14
FormatterBase::prepareView public function Allows formatters to load information for field values being displayed. Overrides FormatterInterface::prepareView 2
FormatterBase::view public function Builds a renderable array for a fully themed field. Overrides FormatterInterface::view 1
LinkFormatter::$pathValidator protected property The path validator service.
LinkFormatter::buildUrl protected function Builds the \Drupal\Core\Url object for a link field item.
LinkFormatter::create public static function Creates an instance of the plugin. Overrides FormatterBase::create
LinkFormatter::__construct public function Constructs a new LinkFormatter. Overrides FormatterBase::__construct
LinkIframeFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides LinkFormatter::defaultSettings
LinkIframeFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides LinkFormatter::settingsForm
LinkIframeFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides LinkFormatter::settingsSummary
LinkIframeFormatter::viewElements public function Builds a renderable array for a field value. Overrides LinkFormatter::viewElements
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 2
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginSettingsBase::$defaultSettingsMerged protected property Whether default settings have been merged into the current $settings.
PluginSettingsBase::$thirdPartySettings protected property The plugin settings injected by third party modules.
PluginSettingsBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 6
PluginSettingsBase::getSetting public function Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings public function Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults protected function Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval public function Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface::onDependencyRemoval 3
PluginSettingsBase::setSetting public function Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings public function Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.