Code Coverage for /Users/ericduran/Sites/drupal/drupal/core/modules/tour/src/TourInterface.php

1	<?php
2
3	/**
4	* @file
5	* Contains \Drupal\tour\TourInterface.
6	*/
7
8	namespace Drupal\tour;
9
10	use Drupal\Core\Config\Entity\ConfigEntityInterface;
11
12	/**
13	* Provides an interface defining a tour entity.
14	*/
15	interface TourInterface extends ConfigEntityInterface {
16
17	/**
18	* The routes that this tour will appear on.
19	*
20	* @return array
21	* Returns array of routes for the tour.
22	*/
23	public function getRoutes();
24
25	/**
26	* Whether the tour matches a given set of route parameters.
27	*
28	* @param string $route_name
29	* The route name the parameters are for.
30	* @param array $route_params
31	* Associative array of raw route params.
32	*
33	* @return bool
34	* TRUE if the tour matches the route parameters.
35	*/
36	public function hasMatchingRoute($route_name, $route_params);
37
38	/**
39	* Returns tip plugin.
40	*
41	* @param string $id
42	* The identifier of the tip.
43	*
44	* @return \Drupal\tour\TipPluginInterface
45	* The tip plugin.
46	*/
47	public function getTip($id);
48
49	/**
50	* Returns the tips for this tour.
51	*
52	* @return array
53	* An array of tip plugins.
54	*/
55	public function getTips();
56
57	/**
58	* Gets the module this tour belongs to.
59	*
60	* @return string
61	* The module this tour belongs to.
62	*/
63	public function getModule();
64
65	/**
66	* Resets the statically cached keyed routes.
67	*/
68	public function resetKeyedRoutes();
69
70	}