3 namespace Drupal\slick\Plugin\Field\FieldFormatter;
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;
16 * Base class for slick image and file ER formatters.
18 abstract class SlickFileFormatterBase extends BlazyFileFormatterBase {
21 * Constructs a SlickImageFormatter instance.
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;
32 public static function create(ContainerInterface $container, array $configuration, $plugin_id, $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')
50 public static function defaultSettings() {
51 return SlickDefault::imageSettings();
57 public function viewElements(FieldItemListInterface $items, $langcode) {
58 $files = $this->getEntitiesToView($items, $langcode);
60 // Early opt-out if the field is empty.
65 // Collects specific settings to this formatter.
66 $build = ['settings' => $this->buildSettings()];
68 $this->formatter->buildSettings($build, $items);
70 // Build the elements.
71 $this->buildElements($build, $files);
73 // Supports Blazy multi-breakpoint images if provided.
74 $this->formatter->isBlazy($build['settings'], $build['items'][0]);
76 return $this->manager()->build($build);
80 * Build the slick carousel elements.
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');
88 foreach ($files as $delta => $file) {
89 $settings['delta'] = $delta;
90 $settings['type'] = 'image';
92 /** @var Drupal\image\Plugin\Field\FieldType\ImageItem $item */
93 $item = $file->_referringItem;
95 $settings['file_tags'] = $file->getCacheTags();
96 $settings['uri'] = $file->getFileUri();
98 $element = ['item' => $item, 'settings' => $settings];
100 // If imported Drupal\blazy\Dejavu\BlazyVideoTrait.
102 if (!empty($this->getImageItem($item))) {
103 $element['item'] = $this->getImageItem($item)['item'];
104 $element['settings'] = array_merge($settings, $this->getImageItem($item)['settings']);
107 $this->getMediaItem($element, $file);
110 // Image with responsive image, lazyLoad, and lightbox supports.
111 $element[$item_id] = $this->formatter->getImage($element);
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})];
119 // Build individual slick item.
120 $build['items'][$delta] = $element;
122 // Build individual slick thumbnail.
123 if (!empty($settings['nav'])) {
124 $thumb = ['settings' => $settings];
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})];
130 $build['thumb']['items'][$delta] = $thumb;
141 public function getScopedFormElements() {
143 'namespace' => 'slick',
145 'thumb_captions' => ['title' => $this->t('Title'), 'alt' => $this->t('Alt')],
146 'thumb_positions' => TRUE,
147 ] + parent::getScopedFormElements();