You are here

Home » API reference » Accelerated Mobile Pages (AMP) 8.3 » AmpMediaImageFormatter.php

class AmpMediaImageFormatter in Accelerated Mobile Pages (AMP) 8.3

Plugin for amp media image formatter.

Plugin annotation


@FieldFormatter(
  id = "amp_media",
  label = @Translation("Amp Media Image"),
  description = @Translation("Display media as an AMP Image file."),
  field_types = {
    "entity_reference",
  }
)

Hierarchy

Expanded class hierarchy of AmpMediaImageFormatter

See also

\Drupal\amp\Plugin\Field\FieldFormatter\AmpImageFormatter

\Drupal\media\Plugin\Field\FieldFormatter\MediaThumbnailFormatter

File

src/Plugin/Field/FieldFormatter/AmpMediaImageFormatter.php, line 27

Namespace

Drupal\amp\Plugin\Field\FieldFormatter
View source 
class AmpMediaImageFormatter extends AmpImageFormatter {

  /**
   * {@inheritdoc}
   *
   * This has to be overriden because FileFormatterBase expects $item to be
   * of type \Drupal\file\Plugin\Field\FieldType\FileItem and calls
   * isDisplayed() which is not in FieldItemInterface.
   */
  protected function needsEntityLoad(EntityReferenceItem $item) {
    return !$item
      ->hasNewEntity();
  }

  /**
   * {@inheritdoc}
   */
  protected function getEntitiesToView(EntityReferenceFieldItemListInterface $items, $langcode) {
    $media = parent::getEntitiesToView($items, $langcode);
    $entities = [];
    foreach ($media as $media_item) {
      $entity = $media_item->thumbnail->entity;
      $entity->_referringItem = $media_item->thumbnail;
      $entities[] = $entity;
    }
    return $entities;
  }

  /**
   * {@inheritdoc}
   */
  public static function isApplicable(FieldDefinitionInterface $field_definition) {
    $settings = $field_definition
      ->getSettings();

    // This is an entity_reference that does not target media, this formatter
    // does not apply.
    if ($settings['target_type'] != 'media') {
      return FALSE;
    }

    // This field targets all media bundles, which might include images, this
    // formatter applies.
    if (empty($settings['handler_settings']) || empty($settings['handler_settings']['target_bundles'])) {
      return TRUE;
    }
    else {
      foreach ($settings['handler_settings']['target_bundles'] as $bundle) {
        $media_type = MediaType::load($bundle);

        // This field specifically targets bundles of the Image media type, this
        // formatter applies
        if ($media_type && $media_type
          ->getSource() instanceof Image) {
          return TRUE;
        }
      }
    }

    // None of the above is true, this field targets non-image media, this
    // formatter does not apply.
    return FALSE;
  }

}

Members

Namesort descending 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.
AmpImageFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides ImageFormatter::defaultSettings
AmpImageFormatter::getLayouts private function AMP layouts
AmpImageFormatter::getLibraries private function AMP libraries
AmpImageFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides ImageFormatter::settingsForm
AmpImageFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides ImageFormatter::settingsSummary
AmpImageFormatter::viewElements public function Builds a renderable array for a field value. Overrides ImageFormatter::viewElements
AmpMediaImageFormatter::getEntitiesToView protected function Returns the referenced entities for display. Overrides ImageFormatterBase::getEntitiesToView
AmpMediaImageFormatter::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides FormatterBase::isApplicable
AmpMediaImageFormatter::needsEntityLoad protected function This has to be overriden because FileFormatterBase expects $item to be of type \Drupal\file\Plugin\Field\FieldType\FileItem and calls isDisplayed() which is not in FieldItemInterface. Overrides FileFormatterBase::needsEntityLoad
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::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
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.
ImageFormatter::$currentUser protected property The current user.
ImageFormatter::$imageStyleStorage protected property The image style entity storage.
ImageFormatter::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides PluginSettingsBase::calculateDependencies
ImageFormatter::create public static function Creates an instance of the plugin. Overrides FormatterBase::create 1
ImageFormatter::onDependencyRemoval public function Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsBase::onDependencyRemoval
ImageFormatter::__construct public function Constructs an ImageFormatter object. Overrides FormatterBase::__construct 1
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::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::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.