You are here

Home » API reference » YouTube Field 8 » YouTubeFormatter.php

class YouTubeFormatter in YouTube Field 8

Plugin implementation of the 'youtube_video' formatter.

Plugin annotation


@FieldFormatter(
  id = "youtube_video",
  label = @Translation("YouTube video"),
  field_types = {
    "youtube"
  }
)

Hierarchy

Expanded class hierarchy of YouTubeFormatter

File

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

Namespace

Drupal\youtube\Plugin\Field\FieldFormatter
View source 
class YouTubeFormatter extends FormatterBase {

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'youtube_size' => '450x315',
      'youtube_width' => '',
      'youtube_height' => '',
      'youtube_autoplay' => '',
      'youtube_mute' => '',
      'youtube_loop' => '',
      'youtube_controls' => '',
      'youtube_autohide' => '',
      'youtube_iv_load_policy' => '',
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $elements = parent::settingsForm($form, $form_state);
    $elements['youtube_size'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('YouTube video size'),
      '#options' => youtube_size_options(),
      '#default_value' => $this
        ->getSetting('youtube_size'),
    ];
    $elements['youtube_width'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Width'),
      '#size' => 10,
      '#default_value' => $this
        ->getSetting('youtube_width'),
      '#states' => [
        'visible' => [
          ':input[name*="youtube_size"]' => [
            'value' => 'custom',
          ],
        ],
      ],
    ];
    $elements['youtube_height'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Height'),
      '#size' => 10,
      '#default_value' => $this
        ->getSetting('youtube_height'),
      '#states' => [
        'visible' => [
          ':input[name*="youtube_size"]' => [
            'value' => 'custom',
          ],
        ],
      ],
    ];
    $elements['youtube_autoplay'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Play video automatically when loaded (autoplay).'),
      '#default_value' => $this
        ->getSetting('youtube_autoplay'),
    ];
    $elements['youtube_mute'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Mute video by default when loaded (mute).'),
      '#default_value' => $this
        ->getSetting('youtube_mute'),
    ];
    $elements['youtube_loop'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Loop the playback of the video (loop).'),
      '#default_value' => $this
        ->getSetting('youtube_loop'),
    ];
    $elements['youtube_controls'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Always hide video controls (controls).'),
      '#default_value' => $this
        ->getSetting('youtube_controls'),
    ];
    $elements['youtube_autohide'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Hide video controls after play begins (autohide).'),
      '#default_value' => $this
        ->getSetting('youtube_autohide'),
    ];
    $elements['youtube_iv_load_policy'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Hide video annotations by default (iv_load_policy).'),
      '#default_value' => $this
        ->getSetting('youtube_iv_load_policy'),
    ];
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];
    $cp = '';
    $youtube_size = $this
      ->getSetting('youtube_size');
    $parameters = [
      $this
        ->getSetting('youtube_autoplay'),
      $this
        ->getSetting('youtube_mute'),
      $this
        ->getSetting('youtube_loop'),
      $this
        ->getSetting('youtube_controls'),
      $this
        ->getSetting('youtube_autohide'),
      $this
        ->getSetting('youtube_iv_load_policy'),
    ];
    foreach ($parameters as $parameter) {
      if ($parameter) {
        $cp = ', custom parameters';
        break;
      }
    }
    $summary[] = $this
      ->t('YouTube video: @youtube_size@cp', [
      '@youtube_size' => $youtube_size,
      '@cp' => $cp,
    ]);
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function prepareView(array $entities_items) {
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $element = [];
    $settings = $this
      ->getSettings();
    foreach ($items as $delta => $item) {
      $element[$delta] = [
        '#theme' => 'youtube_video',
        '#input' => $item->input,
        '#video_id' => $item->video_id,
        '#entity_title' => $items
          ->getEntity()
          ->label(),
        '#settings' => $settings,
      ];
      if ($settings['youtube_size'] == 'responsive') {
        $element[$delta]['#attached']['library'][] = 'youtube/drupal.youtube.responsive';
      }
    }
    return $element;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
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::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 11
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::view public function Builds a renderable array for a fully themed field. Overrides FormatterInterface::view 1
FormatterBase::__construct public function Constructs a FormatterBase object. Overrides PluginBase::__construct 11
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
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 3
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. 1
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.
YouTubeFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
YouTubeFormatter::prepareView public function Allows formatters to load information for field values being displayed. Overrides FormatterBase::prepareView
YouTubeFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
YouTubeFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
YouTubeFormatter::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements