class TourViewBuilder

Same name in other branches
  1. 9 core/modules/tour/src/TourViewBuilder.php \Drupal\tour\TourViewBuilder
  2. 10 core/modules/tour/src/TourViewBuilder.php \Drupal\tour\TourViewBuilder
  3. 11.x core/modules/tour/src/TourViewBuilder.php \Drupal\tour\TourViewBuilder

Provides a Tour view builder.

Hierarchy

Expanded class hierarchy of TourViewBuilder

File

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

Namespace

Drupal\tour
View source 
class TourViewBuilder extends EntityViewBuilder {
    
    /**
     * {@inheritdoc}
     */
    public function viewMultiple(array $entities = [], $view_mode = 'full', $langcode = NULL) {
        
        /** @var \Drupal\tour\TourInterface[] $entities */
        $build = [];
        foreach ($entities as $entity_id => $entity) {
            $tips = $entity->getTips();
            $count = count($tips);
            $list_items = [];
            foreach ($tips as $index => $tip) {
                if ($output = $tip->getOutput()) {
                    $attributes = [
                        'class' => [
                            'tip-module-' . Html::cleanCssIdentifier($entity->getModule()),
                            'tip-type-' . Html::cleanCssIdentifier($tip->getPluginId()),
                            'tip-' . Html::cleanCssIdentifier($tip->id()),
                        ],
                    ];
                    $list_items[] = [
                        'output' => $output,
                        'counter' => [
                            '#type' => 'container',
                            '#attributes' => [
                                'class' => [
                                    'tour-progress',
                                ],
                            ],
                            '#children' => t('@tour_item of @total', [
                                '@tour_item' => $index + 1,
                                '@total' => $count,
                            ]),
                        ],
                        '#wrapper_attributes' => $tip->getAttributes() + $attributes,
                    ];
                }
            }
            // If there is at least one tour item, build the tour.
            if ($list_items) {
                end($list_items);
                $key = key($list_items);
                $list_items[$key]['#wrapper_attributes']['data-text'] = t('End tour');
                $build[$entity_id] = [
                    '#theme' => 'item_list',
                    '#items' => $list_items,
                    '#list_type' => 'ol',
                    '#attributes' => [
                        'id' => 'tour',
                        'class' => [
                            'hidden',
                        ],
                    ],
                    '#cache' => [
                        'tags' => $entity->getCacheTags(),
                    ],
                ];
            }
        }
        // If at least one tour was built, attach the tour library.
        if ($build) {
            $build['#attached']['library'][] = 'tour/tour';
        }
        return $build;
    }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
DeprecatedServicePropertyTrait::__get public function Allows to access deprecated/removed properties.
EntityHandlerBase::$moduleHandler protected property The module handler to invoke hooks on. 2
EntityHandlerBase::moduleHandler protected function Gets the module handler. 2
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::$deprecatedProperties protected property
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 6
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. 2
StringTranslationTrait::$stringTranslation protected property The string translation service.
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.
TrustedCallbackInterface::TRIGGER_WARNING constant Untrusted callbacks trigger E_USER_WARNING errors.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.