class AmpVideoFormatter in Accelerated Mobile Pages (AMP) 8.3

Same name and namespace in other branches

8 src/Plugin/Field/FieldFormatter/AmpVideoFormatter.php \Drupal\amp\Plugin\Field\FieldFormatter\AmpVideoFormatter
8.2 src/Plugin/Field/FieldFormatter/AmpVideoFormatter.php \Drupal\amp\Plugin\Field\FieldFormatter\AmpVideoFormatter

Plugin implementation of the 'amp_video' formatter.

Plugin annotation


@FieldFormatter(
  id = "amp_video",
  label = @Translation("AMP Video"),
  description = @Translation("Display a video file as amp-video."),
  field_types = {
    "file"
  }
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
    class \Drupal\Core\Field\FormatterBase implements FormatterInterface, ContainerFactoryPluginInterface
    class \Drupal\Core\Field\Plugin\Field\FieldFormatter\EntityReferenceFormatterBase
    class \Drupal\file\Plugin\Field\FieldFormatter\FileFormatterBase
    class \Drupal\file\Plugin\Field\FieldFormatter\DescriptionAwareFileFormatterBase
    class \Drupal\file\Plugin\Field\FieldFormatter\GenericFileFormatter
    class \Drupal\amp\Plugin\Field\FieldFormatter\AmpVideoFormatter uses AmpFormTrait

Expanded class hierarchy of AmpVideoFormatter

File

src/Plugin/Field/FieldFormatter/AmpVideoFormatter.php, line 22

Namespace

Drupal\amp\Plugin\Field\FieldFormatter

View source

class AmpVideoFormatter extends GenericFileFormatter {
  use AmpFormTrait;

  /**
   * AMP layouts.
   *
   * Expected by AmpFormTrait.
   *
   * @return array
   *   Array of layout options allowed by this component.
   */
  private function getLayouts() {
    $options = $this
      ->allLayouts();
    unset($options['container']);
    return $options;
  }

  /**
   * AMP libraries.
   *
   * Expected by AmpFormTrait.
   *
   * @return array
   *   The names of the AMP libraries used by this formatter.
   */
  private function getLibraries() {
    return [
      'amp/amp.video',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'height' => 175,
      'width' => 350,
      'layout' => 'responsive',
      'autoplay' => FALSE,
      'controls' => FALSE,
      'loop' => FALSE,
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $form = parent::settingsForm($form, $form_state);
    $form['layout'] = $this
      ->layoutElement();
    $form['width'] = $this
      ->widthElement();
    $form['height'] = $this
      ->heightElement();
    $form['autoplay'] = $this
      ->autoplayElement();
    $form['controls'] = $this
      ->controlsElement();
    $form['loop'] = $this
      ->loopElement();
    $form['#prefix'] = '<div class="description">' . $this
      ->libraryDescription() . '</div>';
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = parent::settingsSummary();
    $summary = $this
      ->addToSummary($summary);
    return [
      implode('; ', $summary),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = [];
    $layout = $this
      ->getSetting('layout');
    $width = $this
      ->validWidth($this
      ->getSetting('width'), $this
      ->getSetting('layout'));
    $height = $this
      ->validHeight($this
      ->getSetting('height'), $this
      ->getSetting('layout'));
    foreach ($this
      ->getEntitiesToView($items, $langcode) as $delta => $file) {
      $elements[$delta]['#theme'] = 'amp_video';
      $elements[$delta]['#attributes']['width'] = $width;
      $elements[$delta]['#attributes']['height'] = $height;
      $elements[$delta]['#attributes']['layout'] = $layout;
      $elements[$delta]['#attributes']['controls'] = $this
        ->getSetting('controls');
      $elements[$delta]['#attributes']['loop'] = $this
        ->getSetting('loop');
      $elements[$delta]['#attributes']['src'] = $file
        ->createFileUrl();
      $elements[$delta]['#cache'] = [
        'tags' => $file
          ->getCacheTags(),
      ];
    }
    $elements['#attached']['library'] = $this
      ->getLibraries();
    return $elements;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AmpFormTrait::addToSummary	public	function	Update the summary.
AmpFormTrait::allLayouts	public	function	AMP Layouts.
AmpFormTrait::allSettings	public	function	All settings.
AmpFormTrait::autoplayElement	public	function	The autoplay form element.
AmpFormTrait::controlsElement	public	function	The controls form element.
AmpFormTrait::heightElement	public	function	The height form element.
AmpFormTrait::heightError	public	function	See if selected height is invalid based on the selected layout.
AmpFormTrait::layoutElement	public	function	The layout form element.
AmpFormTrait::layoutSelector	public	function	The #states layout selector.
AmpFormTrait::libraryDescription	public	function	LibraryDescription.
AmpFormTrait::loopElement	public	function	The loop form element.
AmpFormTrait::validAutoplay	public	function	The autoplay setting, taking into account user permissions.
AmpFormTrait::validHeight	public	function	Limit the height based on the layout.
AmpFormTrait::validWidth	public	function	Limit the width based on the layout.
AmpFormTrait::widthElement	public	function	The width form element.
AmpFormTrait::widthError	public	function	See if selected width is invalid based on the selected layout.
AmpVideoFormatter::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides DescriptionAwareFileFormatterBase::defaultSettings
AmpVideoFormatter::getLayouts	private	function	AMP layouts.
AmpVideoFormatter::getLibraries	private	function	AMP libraries.
AmpVideoFormatter::settingsForm	public	function	Returns a form to configure settings for the formatter. Overrides DescriptionAwareFileFormatterBase::settingsForm
AmpVideoFormatter::settingsSummary	public	function	Returns a short summary for the current formatter settings. Overrides DescriptionAwareFileFormatterBase::settingsSummary
AmpVideoFormatter::viewElements	public	function	Builds a renderable array for a field value. Overrides GenericFileFormatter::viewElements
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
EntityReferenceFormatterBase::getEntitiesToView	protected	function	Returns the referenced entities for display.	1
EntityReferenceFormatterBase::prepareView	public	function	Loads the entities referenced in that field across all the entities being viewed. Overrides FormatterBase::prepareView
EntityReferenceFormatterBase::view	public	function	Overrides FormatterBase::view
FileFormatterBase::checkAccess	protected	function	Checks access to the given entity. Overrides EntityReferenceFormatterBase::checkAccess
FileFormatterBase::needsEntityLoad	protected	function	Returns whether the entity referenced by an item needs to be loaded. Overrides EntityReferenceFormatterBase::needsEntityLoad	1
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::__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.

You are here

class AmpVideoFormatter in Accelerated Mobile Pages (AMP) 8.3

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation