annotate core/modules/tour/src/TourViewBuilder.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 4c8ae668cc8c
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 namespace Drupal\tour;
Chris@0 4
Chris@0 5 use Drupal\Core\Entity\EntityViewBuilder;
Chris@0 6 use Drupal\Component\Utility\Html;
Chris@0 7
Chris@0 8 /**
Chris@0 9 * Provides a Tour view builder.
Chris@0 10 */
Chris@0 11 class TourViewBuilder extends EntityViewBuilder {
Chris@0 12
Chris@0 13 /**
Chris@0 14 * {@inheritdoc}
Chris@0 15 */
Chris@0 16 public function viewMultiple(array $entities = [], $view_mode = 'full', $langcode = NULL) {
Chris@0 17 /** @var \Drupal\tour\TourInterface[] $entities */
Chris@0 18 $build = [];
Chris@0 19 foreach ($entities as $entity_id => $entity) {
Chris@0 20 $tips = $entity->getTips();
Chris@0 21 $count = count($tips);
Chris@0 22 $list_items = [];
Chris@0 23 foreach ($tips as $index => $tip) {
Chris@0 24 if ($output = $tip->getOutput()) {
Chris@0 25 $attributes = [
Chris@0 26 'class' => [
Chris@0 27 'tip-module-' . Html::cleanCssIdentifier($entity->getModule()),
Chris@0 28 'tip-type-' . Html::cleanCssIdentifier($tip->getPluginId()),
Chris@0 29 'tip-' . Html::cleanCssIdentifier($tip->id()),
Chris@0 30 ],
Chris@0 31 ];
Chris@0 32 $list_items[] = [
Chris@0 33 'output' => $output,
Chris@0 34 'counter' => [
Chris@0 35 '#type' => 'container',
Chris@0 36 '#attributes' => [
Chris@0 37 'class' => [
Chris@0 38 'tour-progress',
Chris@0 39 ],
Chris@0 40 ],
Chris@0 41 '#children' => t('@tour_item of @total', ['@tour_item' => $index + 1, '@total' => $count]),
Chris@0 42 ],
Chris@0 43 '#wrapper_attributes' => $tip->getAttributes() + $attributes,
Chris@0 44 ];
Chris@0 45 }
Chris@0 46 }
Chris@0 47 // If there is at least one tour item, build the tour.
Chris@0 48 if ($list_items) {
Chris@0 49 end($list_items);
Chris@0 50 $key = key($list_items);
Chris@0 51 $list_items[$key]['#wrapper_attributes']['data-text'] = t('End tour');
Chris@0 52 $build[$entity_id] = [
Chris@0 53 '#theme' => 'item_list',
Chris@0 54 '#items' => $list_items,
Chris@0 55 '#list_type' => 'ol',
Chris@0 56 '#attributes' => [
Chris@0 57 'id' => 'tour',
Chris@0 58 'class' => [
Chris@0 59 'hidden',
Chris@0 60 ],
Chris@0 61 ],
Chris@0 62 '#cache' => [
Chris@0 63 'tags' => $entity->getCacheTags(),
Chris@0 64 ],
Chris@0 65 ];
Chris@0 66 }
Chris@0 67 }
Chris@0 68 // If at least one tour was built, attach the tour library.
Chris@0 69 if ($build) {
Chris@0 70 $build['#attached']['library'][] = 'tour/tour';
Chris@0 71 }
Chris@0 72 return $build;
Chris@0 73 }
Chris@0 74
Chris@0 75 }