class TourViewBuilder
Same name in other branches
- 9 core/modules/tour/src/TourViewBuilder.php \Drupal\tour\TourViewBuilder
- 8.9.x core/modules/tour/src/TourViewBuilder.php \Drupal\tour\TourViewBuilder
- 10 core/modules/tour/src/TourViewBuilder.php \Drupal\tour\TourViewBuilder
Provides a Tour view builder.
Note: Does not invoke any alter hooks. In other view builders, the view alter hooks are run later in the process
Hierarchy
- class \Drupal\Core\Entity\EntityHandlerBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait
- class \Drupal\Core\Entity\EntityViewBuilder extends \Drupal\Core\Entity\EntityHandlerBase implements \Drupal\Core\Entity\EntityHandlerInterface, \Drupal\Core\Entity\EntityViewBuilderInterface, \Drupal\Core\Security\TrustedCallbackInterface
- class \Drupal\tour\TourViewBuilder extends \Drupal\Core\Entity\EntityViewBuilder
- class \Drupal\Core\Entity\EntityViewBuilder extends \Drupal\Core\Entity\EntityHandlerBase implements \Drupal\Core\Entity\EntityHandlerInterface, \Drupal\Core\Entity\EntityViewBuilderInterface, \Drupal\Core\Security\TrustedCallbackInterface
Expanded class hierarchy of TourViewBuilder
File
-
core/
modules/ tour/ src/ TourViewBuilder.php, line 15
Namespace
Drupal\tourView source
class TourViewBuilder extends EntityViewBuilder {
/**
* {@inheritdoc}
*/
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();
$body_render_array = $tip->getBody();
$body = (string) \Drupal::service('renderer')->renderInIsolation($body_render_array);
$output = [
'body' => $body,
'title' => $tip->getLabel(),
];
$selector = $tip->getSelector();
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) {
$key = array_key_last($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;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
DependencySerializationTrait::$_entityStorages | protected | property | |||
DependencySerializationTrait::$_serviceIds | protected | property | |||
DependencySerializationTrait::__sleep | public | function | 1 | ||
DependencySerializationTrait::__wakeup | public | function | 2 | ||
EntityHandlerBase::$moduleHandler | protected | property | The module handler to invoke hooks on. | 5 | |
EntityHandlerBase::moduleHandler | protected | function | Gets the module handler. | 5 | |
EntityHandlerBase::setModuleHandler | public | function | Sets the module handler for this handler. | ||
EntityViewBuilder::$cacheBin | protected | property | The cache bin used to store the render cache. | ||
EntityViewBuilder::$entityDisplayRepository | protected | property | The entity display repository. | ||
EntityViewBuilder::$entityRepository | protected | property | The entity repository service. | ||
EntityViewBuilder::$entityType | protected | property | Information about the entity type. | ||
EntityViewBuilder::$entityTypeId | protected | property | The type of entities for which this view builder is instantiated. | ||
EntityViewBuilder::$languageManager | protected | property | The language manager. | ||
EntityViewBuilder::$singleFieldDisplays | protected | property | The EntityViewDisplay objects created for individual field rendering. | ||
EntityViewBuilder::$themeRegistry | protected | property | The theme registry. | ||
EntityViewBuilder::addContextualLinks | protected | function | Add contextual links. | ||
EntityViewBuilder::alterBuild | protected | function | Specific per-entity building. | 1 | |
EntityViewBuilder::build | public | function | Builds an entity's view; augments entity defaults. | ||
EntityViewBuilder::buildComponents | public | function | Builds the component fields and properties of a set of entities. | Overrides EntityViewBuilderInterface::buildComponents | 5 |
EntityViewBuilder::buildMultiple | public | function | Builds multiple entities' views; augments entity defaults. | ||
EntityViewBuilder::createInstance | public static | function | Instantiates a new instance of this entity handler. | Overrides EntityHandlerInterface::createInstance | 2 |
EntityViewBuilder::getBuildDefaults | protected | function | Provides entity-specific defaults to the build process. | 4 | |
EntityViewBuilder::getCacheTags | public | function | The cache tag associated with this entity view builder. | Overrides EntityViewBuilderInterface::getCacheTags | |
EntityViewBuilder::getSingleFieldDisplay | protected | function | Gets an EntityViewDisplay for rendering an individual field. | ||
EntityViewBuilder::isViewModeCacheable | protected | function | Determines whether the view mode is cacheable. | ||
EntityViewBuilder::resetCache | public | function | Resets the entity render cache. | Overrides EntityViewBuilderInterface::resetCache | |
EntityViewBuilder::trustedCallbacks | public static | function | Lists the trusted callbacks provided by the implementing class. | Overrides TrustedCallbackInterface::trustedCallbacks | 2 |
EntityViewBuilder::view | public | function | Builds the render array for the provided entity. | Overrides EntityViewBuilderInterface::view | 4 |
EntityViewBuilder::viewField | public | function | Builds a renderable array for the value of a single field in an entity. | Overrides EntityViewBuilderInterface::viewField | |
EntityViewBuilder::viewFieldItem | public | function | Builds a renderable array for a single field item. | Overrides EntityViewBuilderInterface::viewFieldItem | |
EntityViewBuilder::__construct | public | function | Constructs a new EntityViewBuilder. | 1 | |
StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | 3 | |
StringTranslationTrait::formatPlural | protected | function | Formats a string containing a count of items. | ||
StringTranslationTrait::getNumberOfPlurals | protected | function | Returns the number of plurals supported by a given language. | ||
StringTranslationTrait::getStringTranslation | protected | function | Gets the string translation service. | ||
StringTranslationTrait::setStringTranslation | public | function | Sets the string translation service to use. | 2 | |
StringTranslationTrait::t | protected | function | Translates a string to the current language or to a given language. | ||
TourViewBuilder::viewMultiple | public | function | Builds the render array for the provided entities. | Overrides EntityViewBuilder::viewMultiple | |
TrustedCallbackInterface::THROW_EXCEPTION | constant | Untrusted callbacks throw exceptions. | |||
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION | constant | Untrusted callbacks trigger silenced E_USER_DEPRECATION errors. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.