summaryrefslogtreecommitdiffstats
path: root/core/modules/media/src/Plugin/Field/FieldFormatter/MediaThumbnailFormatter.php
diff options
context:
space:
mode:
Diffstat (limited to 'core/modules/media/src/Plugin/Field/FieldFormatter/MediaThumbnailFormatter.php')
-rw-r--r--core/modules/media/src/Plugin/Field/FieldFormatter/MediaThumbnailFormatter.php201
1 files changed, 201 insertions, 0 deletions
diff --git a/core/modules/media/src/Plugin/Field/FieldFormatter/MediaThumbnailFormatter.php b/core/modules/media/src/Plugin/Field/FieldFormatter/MediaThumbnailFormatter.php
new file mode 100644
index 0000000..8ef7792
--- /dev/null
+++ b/core/modules/media/src/Plugin/Field/FieldFormatter/MediaThumbnailFormatter.php
@@ -0,0 +1,201 @@
+<?php
+
+namespace Drupal\media\Plugin\Field\FieldFormatter;
+
+use Drupal\Core\Entity\EntityInterface;
+use Drupal\Core\Field\FieldItemListInterface;
+use Drupal\Core\Form\FormStateInterface;
+use Drupal\Core\Session\AccountInterface;
+use Drupal\image\ImageStyleStorageInterface;
+use Drupal\image\Plugin\Field\FieldFormatter\ImageFormatter;
+use Drupal\Core\Field\Plugin\Field\FieldType\EntityReferenceItem;
+use Drupal\Core\Render\RendererInterface;
+use Drupal\media\MediaInterface;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+use Drupal\Core\Field\FieldDefinitionInterface;
+
+/**
+ * Plugin implementation of the 'media_thumbnail' formatter.
+ *
+ * @FieldFormatter(
+ * id = "media_thumbnail",
+ * label = @Translation("Thumbnail"),
+ * field_types = {
+ * "entity_reference"
+ * }
+ * )
+ */
+class MediaThumbnailFormatter extends ImageFormatter {
+
+ /**
+ * The renderer service.
+ *
+ * @var \Drupal\Core\Render\RendererInterface
+ */
+ protected $renderer;
+
+ /**
+ * Constructs an 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 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\Render\RendererInterface $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, RendererInterface $renderer) {
+ parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings, $current_user, $image_style_storage);
+ $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('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 entity'),
+ ];
+ $element['image_link']['#options'] = $link_types;
+
+ return $element;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function settingsSummary() {
+ $summary = parent::settingsSummary();
+
+ $link_types = [
+ 'content' => $this->t('Linked to content'),
+ 'media' => $this->t('Linked to media item'),
+ ];
+ // Display this setting only if image is linked.
+ $image_link_setting = $this->getSetting('image_link');
+ if (isset($link_types[$image_link_setting])) {
+ $summary[] = $link_types[$image_link_setting];
+ }
+
+ 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' => [],
+ '#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');
+ }
+
+ /**
+ * 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;
+ }
+
+}