tour-2.0.x-dev/src/TourInterface.php

<?php

namespace Drupal\tour;

use Drupal\Core\Config\Entity\ConfigEntityInterface;

/**
 * Provides an interface defining a tour entity.
 */
interface TourInterface extends ConfigEntityInterface {

  /**
   * The routes that this tour will appear on.
   *
   * @return array
   *   Returns array of routes for the tour.
   */
  public function getRoutes(): array;

  /**
   * Whether the tour matches a given set of route parameters.
   *
   * @param string $route_name
   *   The route name the parameters are for.
   * @param array $route_params
   *   Associative array of raw route params.
   *
   * @return bool
   *   TRUE if the tour matches any route and their route parameters.
   */
  public function hasMatchingRoute(string $route_name, array $route_params): bool;

  /**
   * Returns the module of the tour.
   *
   * @return string
   *   The string of module(s). Empty string if NULL.
   */
  public function getModule(): string;

  /**
   * Returns tip plugin.
   *
   * @param string $id
   *   The identifier of the tip.
   *
   * @return \Drupal\tour\TipPluginInterface
   *   The tip plugin.
   */
  public function getTip(string $id): TipPluginInterface;

  /**
   * Returns the tips for this tour.
   *
   * @return array
   *   An array of tip plugins.
   */
  public function getTips(): array;

}