Code Coverage |
||||||||||
Classes and Traits |
Functions and Methods |
Lines |
||||||||
| Total | |
0.00% |
0 / 1 |
|
11.11% |
1 / 9 |
CRAP | |
37.50% |
12 / 32 |
| Tour | |
0.00% |
0 / 1 |
|
11.11% |
1 / 9 |
152.15 | |
37.50% |
12 / 32 |
| __construct | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 3 |
|||
| getRoutes | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 1 |
|||
| getTip | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 1 |
|||
| getTips | |
0.00% |
0 / 1 |
20 | |
0.00% |
0 / 3 |
|||
| anonymous function | |
0.00% |
0 / 1 |
12 | |
0.00% |
0 / 1 |
|||
| getModule | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 1 |
|||
| hasMatchingRoute | |
100.00% |
1 / 1 |
9 | |
100.00% |
12 / 12 |
|||
| resetKeyedRoutes | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 2 |
|||
| calculateDependencies | |
0.00% |
0 / 1 |
6 | |
0.00% |
0 / 6 |
|||
| <?php | |
| /** | |
| * @file | |
| * Contains \Drupal\tour\Entity\Tour. | |
| */ | |
| namespace Drupal\tour\Entity; | |
| use Drupal\Core\Config\Entity\ConfigEntityBase; | |
| use Drupal\tour\TipsPluginCollection; | |
| use Drupal\tour\TourInterface; | |
| /** | |
| * Defines the configured tour entity. | |
| * | |
| * @ConfigEntityType( | |
| * id = "tour", | |
| * label = @Translation("Tour"), | |
| * handlers = { | |
| * "view_builder" = "Drupal\tour\TourViewBuilder" | |
| * }, | |
| * entity_keys = { | |
| * "id" = "id", | |
| * "label" = "label" | |
| * }, | |
| * config_export = { | |
| * "id", | |
| * "label", | |
| * "module", | |
| * "routes", | |
| * "tips", | |
| * }, | |
| * lookup_keys = { | |
| * "routes.*.route_name" | |
| * } | |
| * ) | |
| */ | |
| class Tour extends ConfigEntityBase implements TourInterface { | |
| /** | |
| * The name (plugin ID) of the tour. | |
| * | |
| * @var string | |
| */ | |
| protected $id; | |
| /** | |
| * The module which this tour is assigned to. | |
| * | |
| * @var string | |
| */ | |
| protected $module; | |
| /** | |
| * The label of the tour. | |
| * | |
| * @var string | |
| */ | |
| protected $label; | |
| /** | |
| * The routes on which this tour should be displayed. | |
| * | |
| * @var array | |
| */ | |
| protected $routes = array(); | |
| /** | |
| * The routes on which this tour should be displayed, keyed by route id. | |
| * | |
| * @var array | |
| */ | |
| protected $keyedRoutes; | |
| /** | |
| * Holds the collection of tips that are attached to this tour. | |
| * | |
| * @var \Drupal\tour\TipsPluginCollection | |
| */ | |
| protected $tipsCollection; | |
| /** | |
| * The array of plugin config, only used for export and to populate the $tipsCollection. | |
| * | |
| * @var array | |
| */ | |
| protected $tips = array(); | |
| /** | |
| * {@inheritdoc} | |
| */ | |
| public function __construct(array $values, $entity_type) { | |
| parent::__construct($values, $entity_type); | |
| $this->tipsCollection = new TipsPluginCollection(\Drupal::service('plugin.manager.tour.tip'), $this->tips); | |
| } | |
| /** | |
| * {@inheritdoc} | |
| */ | |
| public function getRoutes() { | |
| return $this->routes; | |
| } | |
| /** | |
| * {@inheritdoc} | |
| */ | |
| public function getTip($id) { | |
| return $this->tipsCollection->get($id); | |
| } | |
| /** | |
| * {@inheritdoc} | |
| */ | |
| public function getTips() { | |
| $tips = array(); | |
| foreach ($this->tips as $id => $tip) { | |
| $tips[] = $this->getTip($id); | |
| } | |
| uasort($tips, function ($a, $b) { | |
| if ($a->getWeight() == $b->getWeight()) { | |
| return 0; | |
| } | |
| return ($a->getWeight() < $b->getWeight()) ? -1 : 1; | |
| }); | |
| \Drupal::moduleHandler()->alter('tour_tips', $tips, $this); | |
| return array_values($tips); | |
| } | |
| /** | |
| * {@inheritdoc} | |
| */ | |
| public function getModule() { | |
| return $this->module; | |
| } | |
| /** | |
| * {@inheritdoc} | |
| */ | |
| public function hasMatchingRoute($route_name, $route_params) { | |
| if (!isset($this->keyedRoutes)) { | |
| $this->keyedRoutes = array(); | |
| foreach ($this->getRoutes() as $route) { | |
| $this->keyedRoutes[$route['route_name']] = isset($route['route_params']) ? $route['route_params'] : array(); | |
| } | |
| } | |
| if (!isset($this->keyedRoutes[$route_name])) { | |
| // We don't know about this route. | |
| return FALSE; | |
| } | |
| if (empty($this->keyedRoutes[$route_name])) { | |
| // We don't need to worry about route params, the route name is enough. | |
| return TRUE; | |
| } | |
| foreach ($this->keyedRoutes[$route_name] as $key => $value) { | |
| // If a required param is missing or doesn't match, return FALSE. | |
| if (empty($route_params[$key]) || $route_params[$key] !== $value) { | |
| return FALSE; | |
| } | |
| } | |
| return TRUE; | |
| } | |
| /** | |
| * {@inheritdoc} | |
| */ | |
| public function resetKeyedRoutes() { | |
| unset($this->keyedRoutes); | |
| } | |
| /** | |
| * {@inheritdoc} | |
| */ | |
| public function calculateDependencies() { | |
| parent::calculateDependencies(); | |
| foreach($this->tipsCollection as $instance) { | |
| $definition = $instance->getPluginDefinition(); | |
| $this->addDependency('module', $definition['provider']); | |
| } | |
| $this->addDependency('module', $this->module); | |
| return $this; | |
| } | |
| } |