class MediaThumbnailFormatter

Same name in other branches
  1. 8.9.x core/modules/media/src/Plugin/Field/FieldFormatter/MediaThumbnailFormatter.php \Drupal\media\Plugin\Field\FieldFormatter\MediaThumbnailFormatter
  2. 10 core/modules/media/src/Plugin/Field/FieldFormatter/MediaThumbnailFormatter.php \Drupal\media\Plugin\Field\FieldFormatter\MediaThumbnailFormatter
  3. 11.x core/modules/media/src/Plugin/Field/FieldFormatter/MediaThumbnailFormatter.php \Drupal\media\Plugin\Field\FieldFormatter\MediaThumbnailFormatter

Plugin implementation of the 'media_thumbnail' formatter.

Plugin annotation


@FieldFormatter(
  id = "media_thumbnail",
  label = @Translation("Thumbnail"),
  field_types = {
    "entity_reference"
  }
)

Hierarchy

Expanded class hierarchy of MediaThumbnailFormatter

File

core/modules/media/src/Plugin/Field/FieldFormatter/MediaThumbnailFormatter.php, line 29

Namespace

Drupal\media\Plugin\Field\FieldFormatter
View source
class MediaThumbnailFormatter extends ImageFormatter {
    
    /**
     * The renderer service.
     *
     * @var \Drupal\Core\Render\RendererInterface
     */
    protected $renderer;
    
    /**
     * Constructs a MediaThumbnailFormatter object.
     *
     * @param string $plugin_id
     *   The plugin_id for the formatter.
     * @param mixed $plugin_definition
     *   The plugin implementation definition.
     * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
     *   The definition of the field to which the formatter is associated.
     * @param array $settings
     *   The formatter settings.
     * @param string $label
     *   The formatter label display setting.
     * @param string $view_mode
     *   The view mode.
     * @param array $third_party_settings
     *   Any third party settings.
     * @param \Drupal\Core\Session\AccountInterface $current_user
     *   The current user.
     * @param \Drupal\image\ImageStyleStorageInterface $image_style_storage
     *   The image style entity storage handler.
     * @param \Drupal\Core\File\FileUrlGeneratorInterface|null $file_url_generator
     *   The file URL generator.
     * @param \Drupal\Core\Render\RendererInterface|null $renderer
     *   The renderer service.
     */
    public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, AccountInterface $current_user, ImageStyleStorageInterface $image_style_storage, $file_url_generator = NULL, $renderer = NULL) {
        if (!$file_url_generator instanceof FileUrlGeneratorInterface) {
            $file_url_generator = \Drupal::service('file_url_generator');
            @trigger_error('Calling ' . __METHOD__ . '() without the $file_url_generator argument is deprecated in drupal:9.5.0 and $file_url_generator argument will be required in drupal:10.0.0. See https://www.drupal.org/node/3255887', E_USER_DEPRECATED);
        }
        if (!$renderer instanceof RendererInterface) {
            $renderer = \Drupal::service('renderer');
            @trigger_error('Calling ' . __METHOD__ . '() without the $renderer argument is deprecated in drupal:9.5.0 and $renderer argument will be required in drupal:10.0.0. See https://www.drupal.org/node/3255887', E_USER_DEPRECATED);
        }
        parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings, $current_user, $image_style_storage, $file_url_generator);
        $this->renderer = $renderer;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
        return new static($plugin_id, $plugin_definition, $configuration['field_definition'], $configuration['settings'], $configuration['label'], $configuration['view_mode'], $configuration['third_party_settings'], $container->get('current_user'), $container->get('entity_type.manager')
            ->getStorage('image_style'), $container->get('file_url_generator'), $container->get('renderer'));
    }
    
    /**
     * {@inheritdoc}
     *
     * This has to be overridden 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}
     */
    public function settingsForm(array $form, FormStateInterface $form_state) {
        $element = parent::settingsForm($form, $form_state);
        $link_types = [
            'content' => $this->t('Content'),
            'media' => $this->t('Media item'),
        ];
        $element['image_link']['#options'] = $link_types;
        return $element;
    }
    
    /**
     * {@inheritdoc}
     */
    public function settingsSummary() {
        $summary = parent::settingsSummary();
        // The parent class adds summary text if the image_link setting is
        // 'content'. Here we only have to add summary text if the setting
        // is 'media'.
        if ($this->getSetting('image_link') === 'media') {
            $summary[] = $this->t('Linked to media item');
        }
        return $summary;
    }
    
    /**
     * {@inheritdoc}
     */
    public function viewElements(FieldItemListInterface $items, $langcode) {
        $elements = [];
        $media_items = $this->getEntitiesToView($items, $langcode);
        // Early opt-out if the field is empty.
        if (empty($media_items)) {
            return $elements;
        }
        $image_style_setting = $this->getSetting('image_style');
        
        /** @var \Drupal\media\MediaInterface[] $media_items */
        foreach ($media_items as $delta => $media) {
            $elements[$delta] = [
                '#theme' => 'image_formatter',
                '#item' => $media->get('thumbnail')
                    ->first(),
                '#item_attributes' => [
                    'loading' => $this->getSetting('image_loading')['attribute'],
                ],
                '#image_style' => $this->getSetting('image_style'),
                '#url' => $this->getMediaThumbnailUrl($media, $items->getEntity()),
            ];
            // Add cacheability of each item in the field.
            $this->renderer
                ->addCacheableDependency($elements[$delta], $media);
        }
        // Add cacheability of the image style setting.
        if ($this->getSetting('image_link') && ($image_style = $this->imageStyleStorage
            ->load($image_style_setting))) {
            $this->renderer
                ->addCacheableDependency($elements, $image_style);
        }
        return $elements;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function isApplicable(FieldDefinitionInterface $field_definition) {
        // This formatter is only available for entity types that reference
        // media items.
        return $field_definition->getFieldStorageDefinition()
            ->getSetting('target_type') == 'media';
    }
    
    /**
     * {@inheritdoc}
     */
    protected function checkAccess(EntityInterface $entity) {
        return $entity->access('view', NULL, TRUE)
            ->andIf(parent::checkAccess($entity));
    }
    
    /**
     * Get the URL for the media thumbnail.
     *
     * @param \Drupal\media\MediaInterface $media
     *   The media item.
     * @param \Drupal\Core\Entity\EntityInterface $entity
     *   The entity that the field belongs to.
     *
     * @return \Drupal\Core\Url|null
     *   The URL object for the media item or null if we don't want to add
     *   a link.
     */
    protected function getMediaThumbnailUrl(MediaInterface $media, EntityInterface $entity) {
        $url = NULL;
        $image_link_setting = $this->getSetting('image_link');
        // Check if the formatter involves a link.
        if ($image_link_setting == 'content') {
            if (!$entity->isNew()) {
                $url = $entity->toUrl();
            }
        }
        elseif ($image_link_setting === 'media') {
            $url = $media->toUrl();
        }
        return $url;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
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
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::$fileUrlGenerator protected property The file URL generator.
ImageFormatter::$imageStyleStorage protected property The image style entity storage.
ImageFormatter::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides PluginSettingsBase::calculateDependencies
ImageFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
ImageFormatter::onDependencyRemoval public function Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsBase::onDependencyRemoval
ImageFormatterBase::getEntitiesToView protected function Returns the referenced entities for display. Overrides EntityReferenceFormatterBase::getEntitiesToView
MediaThumbnailFormatter::$renderer protected property The renderer service.
MediaThumbnailFormatter::checkAccess protected function Checks access to the given entity. Overrides FileFormatterBase::checkAccess
MediaThumbnailFormatter::create public static function Creates an instance of the plugin. Overrides ImageFormatter::create
MediaThumbnailFormatter::getMediaThumbnailUrl protected function Get the URL for the media thumbnail.
MediaThumbnailFormatter::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides FormatterBase::isApplicable
MediaThumbnailFormatter::needsEntityLoad protected function This has to be overridden 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
MediaThumbnailFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides ImageFormatter::settingsForm
MediaThumbnailFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides ImageFormatter::settingsSummary
MediaThumbnailFormatter::viewElements public function Builds a renderable array for a field value. Overrides ImageFormatter::viewElements
MediaThumbnailFormatter::__construct public function Constructs a MediaThumbnailFormatter object. Overrides ImageFormatter::__construct
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
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

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.