function TourViewBuilder::viewMultiple

Overrides EntityViewBuilder::viewMultiple

File

core/modules/tour/src/TourViewBuilder.php, line 17

Class

TourViewBuilder

Provides a Tour view builder.

Namespace

Code

public function viewMultiple(array $entities = [], $view_mode = 'full', $langcode = NULL) {
    
    /** @var \Drupal\tour\TourInterface[] $entities */
    $tour = [];
    $cache_tags = [];
    $total_tips = 0;
    foreach ($entities as $entity_id => $entity) {
        $tour[$entity_id] = $entity->getTips();
        $total_tips += count($tour[$entity_id]);
        $cache_tags = Cache::mergeTags($cache_tags, $entity->getCacheTags());
    }
    $items = [];
    foreach ($tour as $tour_id => $tips) {
        $tourEntity = $entities[$tour_id];
        foreach ($tips as $index => $tip) {
            $classes = [
                'tip-module-' . Html::getClass($tourEntity->getModule()),
                'tip-type-' . Html::getClass($tip->getPluginId()),
                'tip-' . Html::getClass($tip->id()),
            ];
            $selector = $tip->getSelector();
            $location = $tip->getLocation();
            // If $location is null, it's possible that a value is available
            // by directly accessing the `location` property. This can occur if
            // a tour with the deprecated `location` property was installed and
            // tour_post_update_joyride_selectors_to_selector_property() has not run
            // with it installed.
            // @see tour_post_update_joyride_selectors_to_selector_property()
            if (!$location && ($location = $tip->get('location'))) {
                // If the `location` property still has a value, this means the tip
                // is configured for Joyride. The position value must be appended with
                // '-start' to provide the same experience as Joyride.
                $location = $location . '-start';
            }
            // @todo remove conditional in https://drupal.org/node/3195193, as all
            //   instances will already be instances of TourTipPluginInterface.
            if ($tip instanceof TourTipPluginInterface) {
                $body_render_array = $tip->getBody();
                $body = (string) \Drupal::service('renderer')->renderPlain($body_render_array);
                $output = [
                    'body' => $body,
                    'title' => $tip->getLabel(),
                ];
                $selector = $tip->getSelector();
            }
            else {
                // This condition is met if the tip does not implement
                // TourTipPluginInterface. This means the tour tip must be constructed
                // with the deprecated getOutput() method. The resulting tour tip
                // should be largely identical, with the following exceptions:
                // - If the tour tip `attributes` property included anything other
                //   than `data-class` or `data-id`, these additional attributes
                //   will not be available in the resulting tour tip. Note that such
                //   uses are uncommon.
                // - Although the tour tip content is identical, the markup structure
                //   will be different due to being rendered by Shepherd instead of
                //   Joyride. Themes extending Stable or Stable 9 will not experience
                //   these changes as a script is provided that reconstructs each tip
                //   to match Joyride's markup structure.
                $attributes = (array) $tip->get('attributes');
                if (array_diff([
                    'data-class',
                    'data-id',
                ], array_keys($attributes + [
                    'data-class',
                    'data-id',
                ]))) {
                    trigger_error('The tour tips only support data-class and data-id attributes and they will have to be upgraded manually. See https://www.drupal.org/node/3204093', E_USER_WARNING);
                }
                $tour_render_array = $tip->getOutput();
                if (!empty($tour_render_array)) {
                    // The output render array intentionally omits title. The deprecated
                    // getOutput() returns a render array with the title and main
                    // content.
                    $output = [
                        'body' => (string) \Drupal::service('renderer')->renderPlain($tour_render_array),
                    ];
                    // Add a class so JavaScript in Stable themes can identify deprecated
                    // tip plugins. The logic used to make markup backwards compatible
                    // with Joyride is different depending on the type of
                    // plugin used.
                    $classes[] = 'tip-uses-get-output';
                }
            }
            if ($output) {
                $items[] = [
                    'id' => $tip->id(),
                    'selector' => $selector,
                    'module' => $tourEntity->getModule(),
                    'type' => $tip->getPluginId(),
                    'counter' => $this->t('@tour_item of @total', [
                        '@tour_item' => $index + 1,
                        '@total' => $total_tips,
                    ]),
                    'attachTo' => [
                        'element' => $selector,
                        'on' => $location ?? 'bottom-start',
                    ],
                    // Shepherd expects classes to be provided as a string.
'classes' => implode(' ', $classes),
                ] + $output;
            }
        }
    }
    // If there is at least one tour item, build the tour.
    if ($items) {
        end($items);
        $key = key($items);
        $items[$key]['cancelText'] = t('End tour');
    }
    $build = [
        '#cache' => [
            'tags' => $cache_tags,
        ],
    ];
    // If at least one tour was built, attach tips and the tour library.
    if ($items) {
        $build['#attached']['drupalSettings']['tourShepherdConfig'] = [
            'defaultStepOptions' => [
                'classes' => 'drupal-tour',
                'cancelIcon' => [
                    'enabled' => TRUE,
                    'label' => $this->t('Close'),
                ],
                'modalOverlayOpeningPadding' => 3,
                'scrollTo' => [
                    'behavior' => 'smooth',
                    'block' => 'center',
                ],
                'popperOptions' => [
                    'modifiers' => [
                        // Prevent overlap with the element being highlighted.
[
                            'name' => 'offset',
                            'options' => [
                                'offset' => [
                                    -10,
                                    20,
                                ],
                            ],
                        ],
                        // Pad the arrows so they don't hit the edge of rounded corners.
[
                            'name' => 'arrow',
                            'options' => [
                                'padding' => 12,
                            ],
                        ],
                        // Disable Shepherd's focusAfterRender modifier, which results in
                        // the tour item container being focused on any scroll or resize
                        // event.
[
                            'name' => 'focusAfterRender',
                            'enabled' => FALSE,
                        ],
                    ],
                ],
            ],
            'useModalOverlay' => TRUE,
        ];
        // This property is used for storing the tour items. It may change without
        // notice and should not be extended or modified in contrib.
        // see: https://www.drupal.org/project/drupal/issues/3214593
        $build['#attached']['drupalSettings']['_tour_internal'] = $items;
        $build['#attached']['library'][] = 'tour/tour';
    }
    return $build;
}