Drupal 8.0.0 beta 12. More info: https://www.drupal.org/node/2514176
This commit is contained in:
commit
9921556621
13277 changed files with 1459781 additions and 0 deletions
70
core/modules/tour/src/TourInterface.php
Normal file
70
core/modules/tour/src/TourInterface.php
Normal file
|
|
@ -0,0 +1,70 @@
|
|||
<?php
|
||||
|
||||
/**
|
||||
* @file
|
||||
* Contains \Drupal\tour\TourInterface.
|
||||
*/
|
||||
|
||||
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();
|
||||
|
||||
/**
|
||||
* 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 the route parameters.
|
||||
*/
|
||||
public function hasMatchingRoute($route_name, $route_params);
|
||||
|
||||
/**
|
||||
* Returns tip plugin.
|
||||
*
|
||||
* @param string $id
|
||||
* The identifier of the tip.
|
||||
*
|
||||
* @return \Drupal\tour\TipPluginInterface
|
||||
* The tip plugin.
|
||||
*/
|
||||
public function getTip($id);
|
||||
|
||||
/**
|
||||
* Returns the tips for this tour.
|
||||
*
|
||||
* @return array
|
||||
* An array of tip plugins.
|
||||
*/
|
||||
public function getTips();
|
||||
|
||||
/**
|
||||
* Gets the module this tour belongs to.
|
||||
*
|
||||
* @return string
|
||||
* The module this tour belongs to.
|
||||
*/
|
||||
public function getModule();
|
||||
|
||||
/**
|
||||
* Resets the statically cached keyed routes.
|
||||
*/
|
||||
public function resetKeyedRoutes();
|
||||
|
||||
}
|
||||
Reference in a new issue