3 namespace Drupal\blazy\Dejavu;
5 use Drupal\Core\Form\FormStateInterface;
8 * Base class for entity reference formatters with field details.
10 abstract class BlazyEntityReferenceBase extends BlazyEntityBase {
17 public static function defaultSettings() {
18 return BlazyDefault::extendedSettings();
24 public function buildElement(array &$build, $entity, $langcode) {
25 $settings = &$build['settings'];
26 $item_id = $settings['item_id'] = empty($settings['item_id']) ? 'box' : $settings['item_id'];
27 $view_mode = $settings['view_mode'] = empty($settings['view_mode']) ? 'full' : $settings['view_mode'];
29 if (!empty($settings['vanilla'])) {
30 return parent::buildElement($build, $entity, $langcode);
33 $delta = isset($settings['delta']) ? $settings['delta'] : 0;
34 $element = ['settings' => $settings];
36 // Built early before stage to allow custom highres video thumbnail later.
37 // Implementor must import: Drupal\blazy\Dejavu\BlazyVideoTrait.
38 if (method_exists($this, 'getMediaItem')) {
39 $this->getMediaItem($element, $entity);
42 // Build the main stage.
43 $this->buildStage($element, $entity, $langcode);
45 // If Image rendered is picked, render image as is.
46 if (!empty($settings['image']) && (!empty($settings['media_switch']) && $settings['media_switch'] == 'rendered')) {
47 $element['content'][] = $this->getFieldRenderable($entity, $settings['image'], $view_mode);
50 // Optional image with responsive image, lazyLoad, and lightbox supports.
51 $element[$item_id] = empty($element['item']) ? [] : $this->formatter->getImage($element);
53 // Captions if so configured.
54 $this->getCaption($element, $entity, $langcode);
56 // Layouts can be builtin, or field, if so configured.
57 if (!empty($settings['layout'])) {
58 $layout = $settings['layout'];
59 if (strpos($layout, 'field_') !== FALSE) {
60 $settings['layout'] = $this->getFieldString($entity, $layout, $langcode);
62 $element['settings']['layout'] = $settings['layout'];
65 // Classes, if so configured.
66 if (!empty($settings['class'])) {
67 $element['settings']['class'] = $this->getFieldString($entity, $settings['class'], $langcode);
70 // Build the main item.
71 $build['items'][$delta] = $element;
73 // Build the thumbnail item.
74 if (!empty($settings['nav'])) {
75 // Thumbnail usages: asNavFor pagers, dot, arrows, photobox thumbnails.
76 $element[$item_id] = empty($settings['thumbnail_style']) ? [] : $this->formatter->getThumbnail($element['settings'], $element['item']);
77 $element['caption'] = empty($settings['thumbnail_caption']) ? [] : $this->getFieldRenderable($entity, $settings['thumbnail_caption'], $view_mode);
79 $build['thumb']['items'][$delta] = $element;
84 * Builds slide captions with possible multi-value fields.
86 public function getCaption(array &$element, $entity, $langcode) {
87 $settings = $element['settings'];
88 $view_mode = $settings['view_mode'];
90 // Title can be plain text, or link field.
91 if (!empty($settings['title'])) {
92 $field_title = $settings['title'];
93 if (isset($entity->{$field_title})) {
94 if ($entity->hasTranslation($langcode)) {
95 // If the entity has translation, fetch the translated value.
96 $title = $entity->getTranslation($langcode)->get($field_title)->getValue();
99 // Entity doesn't have translation, fetch original value.
100 $title = $entity->get($field_title)->getValue();
102 if (!empty($title[0]['value']) && !isset($title[0]['uri'])) {
103 // Prevents HTML-filter-enabled text from having bad markups (h2 > p),
104 // except for a few reasonable tags acceptable within H2 tag.
105 $element['caption']['title']['#markup'] = strip_tags($title[0]['value'], '<a><strong><em><span><small>');
107 elseif (isset($title[0]['uri']) && !empty($title[0]['title'])) {
108 $element['caption']['title'] = $this->getFieldRenderable($entity, $field_title, $view_mode)[0];
113 // Other caption fields, if so configured.
114 if (!empty($settings['caption'])) {
116 foreach ($settings['caption'] as $i => $field_caption) {
117 if (!isset($entity->{$field_caption})) {
120 $caption_items[$i] = $this->getFieldRenderable($entity, $field_caption, $view_mode);
122 if ($caption_items) {
123 $element['caption']['data'] = $caption_items;
127 // Link, if so configured.
128 if (!empty($settings['link'])) {
129 $field_link = $settings['link'];
130 if (isset($entity->{$field_link})) {
131 $links = $this->getFieldRenderable($entity, $field_link, $view_mode);
133 // Only simplify markups for known formatters registered by link.module.
134 if ($links && isset($links['#formatter']) && in_array($links['#formatter'], ['link'])) {
136 foreach ($entity->{$field_link} as $i => $link) {
137 $links[$i] = $link->view($view_mode);
140 $element['caption']['link'] = $links;
144 if (!empty($settings['overlay'])) {
145 $element['caption']['overlay'] = $this->getOverlay($settings, $entity, $langcode);
150 * Builds overlay placed within the caption.
152 public function getOverlay(array $settings, $entity, $langcode) {
153 return $entity->get($settings['overlay'])->view($settings['view_mode']);
157 * Build the main background/stage, image or video.
159 * Main image can be separate image item from video thumbnail for highres.
160 * Fallback to default thumbnail if any, which has no file API.
162 public function buildStage(array &$element, $entity, $langcode) {
163 $settings = &$element['settings'];
164 $stage = empty($settings['source_field']) ? '' : $settings['source_field'];
165 $stage = empty($settings['image']) ? $stage : $settings['image'];
167 // The actual video thumbnail has already been downloaded earlier.
168 // This fetches the highres image if provided and available.
169 // With a mix of image and video, image is not always there.
170 if ($stage && isset($entity->{$stage})) {
171 /** @var \Drupal\file\Plugin\Field\FieldType\FileFieldItemList $file */
172 $file = $entity->get($stage);
173 $value = $file->getValue();
175 // Do not proceed if it is a Media entity video.
176 if (isset($value[0]) && $value[0]) {
177 // If image, even if multi-value, we can only have one stage per slide.
178 if (isset($value[0]['target_id']) && !empty($value[0]['target_id'])) {
179 if (method_exists($file, 'referencedEntities') && isset($file->referencedEntities()[0])) {
180 /** @var \Drupal\image\Plugin\Field\FieldType\ImageItem $item */
181 $element['item'] = $file->get(0);
183 // Collects cache tags to be added for each item in the field.
184 $settings['file_tags'] = $file->referencedEntities()[0]->getCacheTags();
185 $settings['uri'] = $file->referencedEntities()[0]->getFileUri();
188 // If a VEF with a text, or link field.
189 elseif (isset($value[0]['value']) || isset($value[0]['uri'])) {
190 $external_url = $this->getFieldString($entity, $stage, $langcode);
193 $this->buildVideo($settings, $external_url);
194 $element['item'] = $value;
204 public function settingsForm(array $form, FormStateInterface $form_state) {
205 $element = parent::settingsForm($form, $form_state);
207 if (isset($element['layout'])) {
208 $layout_description = $element['layout']['#description'];
209 $element['layout']['#description'] = $this->t('Create a dedicated List (text - max number 1) field related to the caption placement to have unique layout per slide with the following supported keys: top, right, bottom, left, center, center-top, etc. Be sure its formatter is Key.') . ' ' . $layout_description;
212 if (isset($element['media_switch'])) {
213 $element['media_switch']['#options']['rendered'] = $this->t('Image rendered by its formatter');
214 $element['media_switch']['#description'] .= ' ' . $this->t('Be sure the enabled fields here are not hidden/disabled at its view mode.');
217 if (isset($element['caption'])) {
218 $element['caption']['#description'] = $this->t('Check fields to be treated as captions, even if not caption texts.');
221 if (isset($element['image']['#description'])) {
222 $element['image']['#description'] .= ' ' . $this->t('For video, this allows separate highres image, be sure the same field used for Image to have a mix of videos and images. Leave empty to fallback to the video provider thumbnails. The formatter/renderer is managed by <strong>@namespace</strong> formatter. Meaning original formatter ignored. If you want original formatters, check <strong>Vanilla</strong> option. Alternatively choose <strong>Media switcher > Image rendered </strong>, other image-related settings here will be ignored. <strong>Supported fields</strong>: Image, Video Embed Field.', ['@namespace' => $this->getPluginId()]);
225 if (isset($element['overlay']['#description'])) {
226 $element['overlay']['#description'] .= ' ' . $this->t('The formatter/renderer is managed by the child formatter. <strong>Supported fields</strong>: Image, Video Embed Field, Media Entity.');
235 public function getScopedFormElements() {
236 $admin = $this->admin();
237 $target_type = $this->getFieldSetting('target_type');
238 $views_ui = $this->getFieldSetting('handler') == 'default';
239 $bundles = $views_ui ? [] : $this->getFieldSetting('handler_settings')['target_bundles'];
240 $strings = ['text', 'string', 'list_string'];
241 $strings = $admin->getFieldOptions($bundles, $strings, $target_type);
242 $texts = ['text', 'text_long', 'string', 'string_long', 'link'];
243 $texts = $admin->getFieldOptions($bundles, $texts, $target_type);
244 $links = ['text', 'string', 'link'];
247 'background' => TRUE,
248 'box_captions' => TRUE,
249 'breakpoints' => BlazyDefault::getConstantBreakpoints(),
250 'captions' => $admin->getFieldOptions($bundles, [], $target_type),
251 'classes' => $strings,
252 'fieldable_form' => TRUE,
253 'images' => $admin->getFieldOptions($bundles, ['image'], $target_type),
254 'image_style_form' => TRUE,
255 'layouts' => $strings,
256 'links' => $admin->getFieldOptions($bundles, $links, $target_type),
257 'media_switch_form' => TRUE,
258 'multimedia' => TRUE,
259 'thumb_captions' => $texts,
260 'thumb_positions' => TRUE,
264 ] + parent::getScopedFormElements();