Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\tour\Entity;
Chris@0: 
Chris@0: use Drupal\Core\Config\Entity\ConfigEntityBase;
Chris@0: use Drupal\tour\TipsPluginCollection;
Chris@0: use Drupal\tour\TourInterface;
Chris@0: 
Chris@0: /**
Chris@0:  * Defines the configured tour entity.
Chris@0:  *
Chris@0:  * @ConfigEntityType(
Chris@0:  *   id = "tour",
Chris@0:  *   label = @Translation("Tour"),
Chris@17:  *   label_collection = @Translation("Tours"),
Chris@17:  *   label_singular = @Translation("tour"),
Chris@17:  *   label_plural = @Translation("tours"),
Chris@17:  *   label_count = @PluralTranslation(
Chris@17:  *     singular = "@count tour",
Chris@17:  *     plural = "@count tours",
Chris@17:  *   ),
Chris@0:  *   handlers = {
Chris@0:  *     "view_builder" = "Drupal\tour\TourViewBuilder",
Chris@0:  *     "access" = "Drupal\tour\TourAccessControlHandler",
Chris@0:  *   },
Chris@0:  *   admin_permission = "administer site configuration",
Chris@0:  *   entity_keys = {
Chris@0:  *     "id" = "id",
Chris@0:  *     "label" = "label"
Chris@0:  *   },
Chris@0:  *   config_export = {
Chris@0:  *     "id",
Chris@0:  *     "label",
Chris@0:  *     "module",
Chris@0:  *     "routes",
Chris@0:  *     "tips",
Chris@0:  *   },
Chris@0:  *   lookup_keys = {
Chris@0:  *     "routes.*.route_name"
Chris@0:  *   }
Chris@0:  * )
Chris@0:  */
Chris@0: class Tour extends ConfigEntityBase implements TourInterface {
Chris@0: 
Chris@0:   /**
Chris@0:    * The name (plugin ID) of the tour.
Chris@0:    *
Chris@0:    * @var string
Chris@0:    */
Chris@0:   protected $id;
Chris@0: 
Chris@0:   /**
Chris@0:    * The module which this tour is assigned to.
Chris@0:    *
Chris@0:    * @var string
Chris@0:    */
Chris@0:   protected $module;
Chris@0: 
Chris@0:   /**
Chris@0:    * The label of the tour.
Chris@0:    *
Chris@0:    * @var string
Chris@0:    */
Chris@0:   protected $label;
Chris@0: 
Chris@0:   /**
Chris@0:    * The routes on which this tour should be displayed.
Chris@0:    *
Chris@0:    * @var array
Chris@0:    */
Chris@0:   protected $routes = [];
Chris@0: 
Chris@0:   /**
Chris@0:    * The routes on which this tour should be displayed, keyed by route id.
Chris@0:    *
Chris@0:    * @var array
Chris@0:    */
Chris@0:   protected $keyedRoutes;
Chris@0: 
Chris@0:   /**
Chris@0:    * Holds the collection of tips that are attached to this tour.
Chris@0:    *
Chris@0:    * @var \Drupal\tour\TipsPluginCollection
Chris@0:    */
Chris@0:   protected $tipsCollection;
Chris@0: 
Chris@0:   /**
Chris@0:    * The array of plugin config, only used for export and to populate the $tipsCollection.
Chris@0:    *
Chris@0:    * @var array
Chris@0:    */
Chris@0:   protected $tips = [];
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function __construct(array $values, $entity_type) {
Chris@0:     parent::__construct($values, $entity_type);
Chris@0: 
Chris@0:     $this->tipsCollection = new TipsPluginCollection(\Drupal::service('plugin.manager.tour.tip'), $this->tips);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getRoutes() {
Chris@0:     return $this->routes;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getTip($id) {
Chris@0:     return $this->tipsCollection->get($id);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getTips() {
Chris@0:     $tips = [];
Chris@0:     foreach ($this->tips as $id => $tip) {
Chris@0:       $tips[] = $this->getTip($id);
Chris@0:     }
Chris@0:     uasort($tips, function ($a, $b) {
Chris@0:       if ($a->getWeight() == $b->getWeight()) {
Chris@0:         return 0;
Chris@0:       }
Chris@0:       return ($a->getWeight() < $b->getWeight()) ? -1 : 1;
Chris@0:     });
Chris@0: 
Chris@0:     \Drupal::moduleHandler()->alter('tour_tips', $tips, $this);
Chris@0:     return array_values($tips);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getModule() {
Chris@0:     return $this->module;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function hasMatchingRoute($route_name, $route_params) {
Chris@0:     if (!isset($this->keyedRoutes)) {
Chris@0:       $this->keyedRoutes = [];
Chris@0:       foreach ($this->getRoutes() as $route) {
Chris@0:         $this->keyedRoutes[$route['route_name']] = isset($route['route_params']) ? $route['route_params'] : [];
Chris@0:       }
Chris@0:     }
Chris@0:     if (!isset($this->keyedRoutes[$route_name])) {
Chris@0:       // We don't know about this route.
Chris@0:       return FALSE;
Chris@0:     }
Chris@0:     if (empty($this->keyedRoutes[$route_name])) {
Chris@0:       // We don't need to worry about route params, the route name is enough.
Chris@0:       return TRUE;
Chris@0:     }
Chris@0:     foreach ($this->keyedRoutes[$route_name] as $key => $value) {
Chris@0:       // If a required param is missing or doesn't match, return FALSE.
Chris@0:       if (empty($route_params[$key]) || $route_params[$key] !== $value) {
Chris@0:         return FALSE;
Chris@0:       }
Chris@0:     }
Chris@0:     return TRUE;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function resetKeyedRoutes() {
Chris@0:     unset($this->keyedRoutes);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function calculateDependencies() {
Chris@0:     parent::calculateDependencies();
Chris@0: 
Chris@0:     foreach ($this->tipsCollection as $instance) {
Chris@0:       $definition = $instance->getPluginDefinition();
Chris@0:       $this->addDependency('module', $definition['provider']);
Chris@0:     }
Chris@0: 
Chris@0:     $this->addDependency('module', $this->module);
Chris@0:     return $this;
Chris@0:   }
Chris@0: 
Chris@0: }