TourListBuilder.php in Tour UI 8

Namespace

Drupal\tour_ui

File

src/TourListBuilder.php

<?php

namespace Drupal\tour_ui;

use Drupal\Core\Entity\EntityListBuilder;
use Drupal\Core\Entity\EntityInterface;
use Drupal\Component\Utility\Html;

/**
 * Provides a listing of tours.
 */
class TourListBuilder extends EntityListBuilder {

  /**
   * {@inheritdoc}
   */
  public function buildHeader() {
    $row['id'] = t('Id');
    $row['label'] = t('Label');
    $row['routes'] = t('routes');
    $row['tips'] = t('Number of tips');
    $row['operations'] = t('Operations');
    return $row;
  }

  /**
   * {@inheritdoc}
   */
  public function buildRow(EntityInterface $entity) {
    $row['title'] = [
      'data' => $entity
        ->label(),
      'class' => [
        'menu-label',
      ],
    ];
    $row = parent::buildRow($entity);
    $data['id'] = Html::escape($entity
      ->id());
    $data['label'] = Html::escape($entity
      ->label());

    // Include the routes this tour is used on.
    $routes_name = [];
    if ($routes = $entity
      ->getRoutes()) {
      foreach ($routes as $route) {
        $params_out = '';
        if (isset($route['route_params'])) {
          $params = $route['route_params'];
          $formatted_params = array_reduce(array_keys($params), function ($carry, $key) use ($params) {
            return $carry . ' ' . $key . ':' . htmlspecialchars($params[$key]);
          }, '');
          $params_out = ' with params: ' . trim($formatted_params);
        }
        $routes_name[] = $route['route_name'] . $params_out;
      }
    }
    $data['routes'] = [
      'data' => [
        '#type' => 'inline_template',
        '#template' => '<div class="tour-routes">{{ routes|safe_join("<br />") }}</div>',
        '#context' => [
          'routes' => $routes_name,
        ],
      ],
    ];

    // Count the number of tips.
    $data['tips'] = count($entity
      ->getTips());
    $data['operations'] = $row['operations'];

    // Wrap the whole row so that the entity ID is used as a class.
    return [
      'data' => $data,
      'class' => [
        $entity
          ->id(),
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getOperations(EntityInterface $entity) {
    $operations = parent::getOperations($entity);
    $operations['edit'] = [
      'title' => t('Edit'),
      'url' => $entity
        ->toUrl('edit-form'),
      'weight' => 1,
    ];
    $operations['delete'] = [
      'title' => t('Delete'),
      'url' => $entity
        ->toUrl('delete-form'),
      'weight' => 2,
    ];
    return $operations;
  }

  /**
   * {@inheritdoc}
   */
  public function render() {
    $build = parent::render();
    $build['#empty'] = $this
      ->t('No tours available. <a href="@link">Add tour</a>.', [
      '@link' => 'tour_ui.tour.add',
    ]);
    return $build;
  }

}

Classes

Name	Description
TourListBuilder	Provides a listing of tours.