www.aleph1.co.uk Git - yaffs-website/blob - web/modules/contrib/slick/src/Plugin/Field/FieldFormatter/SlickFileFormatterBase.php

   1 <?php
   2
   3 namespace Drupal\slick\Plugin\Field\FieldFormatter;
   4
   5 use Drupal\Core\Field\FieldItemListInterface;
   6 use Drupal\Core\Field\FieldDefinitionInterface;
   7 use Drupal\Component\Utility\Xss;
   8 use Drupal\blazy\BlazyFormatterManager;
   9 use Drupal\blazy\Plugin\Field\FieldFormatter\BlazyFileFormatterBase;
  10 use Drupal\slick\SlickFormatterInterface;
  11 use Drupal\slick\SlickManagerInterface;
  12 use Drupal\slick\SlickDefault;
  13 use Symfony\Component\DependencyInjection\ContainerInterface;
  14
  15 /**
  16  * Base class for slick image and file ER formatters.
  17  */
  18 abstract class SlickFileFormatterBase extends BlazyFileFormatterBase {
  19
  20   /**
  21    * Constructs a SlickImageFormatter instance.
  22    */
  23   public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, BlazyFormatterManager $blazy_manager, SlickFormatterInterface $formatter, SlickManagerInterface $manager) {
  24     parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings, $blazy_manager);
  25     $this->formatter = $formatter;
  26     $this->manager   = $manager;
  27   }
  28
  29   /**
  30    * {@inheritdoc}
  31    */
  32   public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
  33     return new static(
  34       $plugin_id,
  35       $plugin_definition,
  36       $configuration['field_definition'],
  37       $configuration['settings'],
  38       $configuration['label'],
  39       $configuration['view_mode'],
  40       $configuration['third_party_settings'],
  41       $container->get('blazy.formatter.manager'),
  42       $container->get('slick.formatter'),
  43       $container->get('slick.manager')
  44     );
  45   }
  46
  47   /**
  48    * {@inheritdoc}
  49    */
  50   public static function defaultSettings() {
  51     return SlickDefault::imageSettings();
  52   }
  53
  54   /**
  55    * {@inheritdoc}
  56    */
  57   public function viewElements(FieldItemListInterface $items, $langcode) {
  58     $files = $this->getEntitiesToView($items, $langcode);
  59
  60     // Early opt-out if the field is empty.
  61     if (empty($files)) {
  62       return [];
  63     }
  64
  65     // Collects specific settings to this formatter.
  66     $build = ['settings' => $this->buildSettings()];
  67
  68     $this->formatter->buildSettings($build, $items);
  69
  70     // Build the elements.
  71     $this->buildElements($build, $files);
  72
  73     // Supports Blazy multi-breakpoint images if provided.
  74     $this->formatter->isBlazy($build['settings'], $build['items'][0]);
  75
  76     return $this->manager()->build($build);
  77   }
  78
  79   /**
  80    * Build the slick carousel elements.
  81    */
  82   public function buildElements(array &$build, $files) {
  83     $settings   = &$build['settings'];
  84     $item_id    = $settings['item_id'];
  85     $tn_caption = empty($settings['thumbnail_caption']) ? NULL : $settings['thumbnail_caption'];
  86     $media      = method_exists($this, 'getMediaItem');
  87
  88     foreach ($files as $delta => $file) {
  89       $settings['delta'] = $delta;
  90       $settings['type']  = 'image';
  91
  92       /** @var Drupal\image\Plugin\Field\FieldType\ImageItem $item */
  93       $item = $file->_referringItem;
  94
  95       $settings['file_tags'] = $file->getCacheTags();
  96       $settings['uri']       = $file->getFileUri();
  97
  98       $element = ['item' => $item, 'settings' => $settings];
  99
 100       // If imported Drupal\blazy\Dejavu\BlazyVideoTrait.
 101       if ($media) {
 102         if (!empty($this->getImageItem($item))) {
 103           $element['item'] = $this->getImageItem($item)['item'];
 104           $element['settings'] = array_merge($settings, $this->getImageItem($item)['settings']);
 105         }
 106
 107         $this->getMediaItem($element, $file);
 108       }
 109
 110       // Image with responsive image, lazyLoad, and lightbox supports.
 111       $element[$item_id] = $this->formatter->getImage($element);
 112
 113       if (!empty($settings['caption'])) {
 114         foreach ($settings['caption'] as $caption) {
 115           $element['caption'][$caption] = empty($element['item']->{$caption}) ? [] : ['#markup' => Xss::filterAdmin($element['item']->{$caption})];
 116         }
 117       }
 118
 119       // Build individual slick item.
 120       $build['items'][$delta] = $element;
 121
 122       // Build individual slick thumbnail.
 123       if (!empty($settings['nav'])) {
 124         $thumb = ['settings' => $settings];
 125
 126         // Thumbnail usages: asNavFor pagers, dot, arrows, photobox thumbnails.
 127         $thumb[$item_id]  = empty($settings['thumbnail_style']) ? [] : $this->formatter->getThumbnail($settings);
 128         $thumb['caption'] = empty($element['item']->{$tn_caption}) ? [] : ['#markup' => Xss::filterAdmin($element['item']->{$tn_caption})];
 129
 130         $build['thumb']['items'][$delta] = $thumb;
 131         unset($thumb);
 132       }
 133
 134       unset($element);
 135     }
 136   }
 137
 138   /**
 139    * {@inheritdoc}
 140    */
 141   public function getScopedFormElements() {
 142     return [
 143       'namespace'       => 'slick',
 144       'nav'             => TRUE,
 145       'thumb_captions'  => ['title' => $this->t('Title'), 'alt' => $this->t('Alt')],
 146       'thumb_positions' => TRUE,
 147     ] + parent::getScopedFormElements();
 148   }
 149
 150 }