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

   1 <?php
   2
   3 namespace Drupal\blazy\Plugin\Field\FieldFormatter;
   4
   5 use Drupal\Core\Field\FieldItemListInterface;
   6 use Drupal\Core\Template\Attribute;
   7 use Drupal\Component\Utility\Xss;
   8 use Drupal\blazy\BlazyGrid;
   9
  10 /**
  11  * A Trait common for blazy image and file ER formatters.
  12  */
  13 trait BlazyFormatterTrait {
  14
  15   /**
  16    * {@inheritdoc}
  17    */
  18   public function viewElements(FieldItemListInterface $items, $langcode) {
  19     $build = [];
  20     $files = $this->getEntitiesToView($items, $langcode);
  21
  22     // Early opt-out if the field is empty.
  23     if (empty($files)) {
  24       return $build;
  25     }
  26
  27     // Collects specific settings to this formatter.
  28     $settings              = $this->buildSettings();
  29     $settings['blazy']     = TRUE;
  30     $settings['namespace'] = $settings['item_id'] = $settings['lazy'] = 'blazy';
  31     $settings['_grid']     = !empty($settings['style']) && !empty($settings['grid']);
  32
  33     // Build the settings.
  34     $build = ['settings' => $settings];
  35
  36     // Modifies settings.
  37     $this->blazyManager->buildSettings($build, $items);
  38
  39     // Build the elements.
  40     $this->buildElements($build, $files);
  41
  42     // Updates settings.
  43     $settings = $build['settings'];
  44     unset($build['settings']);
  45
  46     // Supports Blazy multi-breakpoint images if provided.
  47     $this->blazyManager->isBlazy($settings, $build[0]['#build']);
  48
  49     // Build grid if provided.
  50     if (empty($settings['_grid'])) {
  51       $build['#blazy'] = $settings;
  52     }
  53     else {
  54       $build = BlazyGrid::build($build, $settings);
  55     }
  56
  57     $build['#attached'] = $this->blazyManager->attach($settings);
  58     return $build;
  59   }
  60
  61   /**
  62    * Build the Blazy elements.
  63    */
  64   public function buildElements(array &$build, $files) {
  65     $settings = $build['settings'];
  66     $item_id  = $settings['item_id'];
  67     $is_media = method_exists($this, 'getMediaItem');
  68
  69     if (!empty($settings['caption'])) {
  70       $settings['caption_attributes']['class'][] = $item_id . '__caption';
  71     }
  72
  73     foreach ($files as $delta => $file) {
  74       /* @var Drupal\image\Plugin\Field\FieldType\ImageItem $item */
  75       $item = $file->_referringItem;
  76
  77       $settings['delta']     = $delta;
  78       $settings['file_tags'] = $file->getCacheTags();
  79       $settings['type']      = 'image';
  80       $settings['uri']       = $file->getFileUri();
  81
  82       $box['item']     = $item;
  83       $box['settings'] = $settings;
  84
  85       // If imported Drupal\blazy\Dejavu\BlazyVideoTrait.
  86       if ($is_media) {
  87         /** @var Drupal\Core\Field\Plugin\Field\FieldType\EntityReferenceItem $item */
  88         // EntityReferenceItem provides $item->entity Drupal\file\Entity\File.
  89         if (!empty($this->getImageItem($item, $delta))) {
  90           $box['item'] = $this->getImageItem($item)['item'];
  91           $box['settings'] = array_merge($settings, $this->getImageItem($item)['settings']);
  92         }
  93
  94         $this->getMediaItem($box, $file);
  95       }
  96
  97       // Build caption if so configured.
  98       if (!empty($settings['caption'])) {
  99         foreach ($settings['caption'] as $caption) {
 100           $box['captions'][$caption]['content'] = empty($box['item']->{$caption}) ? [] : ['#markup' => Xss::filterAdmin($box['item']->{$caption})];
 101           $box['captions'][$caption]['tag'] = $caption == 'title' ? 'h2' : 'div';
 102           if (!isset($box['captions'][$caption]['attributes'])) {
 103             $class = $caption == 'alt' ? 'description' : $caption;
 104             $box['captions'][$caption]['attributes'] = new Attribute();
 105             $box['captions'][$caption]['attributes']->addClass($item_id . '__' . $class);
 106           }
 107         }
 108       }
 109
 110       // Image with grid, responsive image, lazyLoad, and lightbox supports.
 111       $build[$delta] = $this->blazyManager->getImage($box);
 112       unset($box);
 113     }
 114   }
 115
 116 }