class EntityRouteAlterSubscriber in Drupal 8

Registers the 'type' of route parameter names that match an entity type.

@todo Matching on parameter *name* is not ideal, because it breaks encapsulation: parameter names are local to the controller and route, and controllers and routes can't be expected to know what all possible entity types might exist across all modules in order to pick names that don't conflict. Instead, the 'type' should be determined from introspecting what kind of PHP variable (e.g., a type hinted interface) the controller requires: https://www.drupal.org/node/2041907.

Hierarchy

• class \Drupal\Core\EventSubscriber\EntityRouteAlterSubscriber implements \Symfony\Component\EventDispatcher\EventSubscriberInterface

1 string reference to 'EntityRouteAlterSubscriber'

core.services.yml in core/core.services.yml

core/core.services.yml

1 service uses EntityRouteAlterSubscriber

route_subscriber.entity in core/core.services.yml

Drupal\Core\EventSubscriber\EntityRouteAlterSubscriber

File

core/lib/Drupal/Core/EventSubscriber/EntityRouteAlterSubscriber.php, line 21

Namespace

Drupal\Core\EventSubscriber

class EntityRouteAlterSubscriber implements EventSubscriberInterface {

  /**
   * The entity resolver manager.
   *
   * @var \Drupal\Core\Entity\EntityResolverManager
   */
  protected $resolverManager;

  /**
   * Constructs an EntityRouteAlterSubscriber instance.
   *
   * @param \Drupal\Core\Entity\EntityResolverManager $entity_resolver_manager
   *   The entity resolver manager.
   */
  public function __construct(EntityResolverManager $entity_resolver_manager) {
    $this->resolverManager = $entity_resolver_manager;
  }

  /**
   * Applies parameter converters to route parameters.
   *
   * @param \Drupal\Core\Routing\RouteBuildEvent $event
   *   The event to process.
   */
  public function onRoutingRouteAlterSetType(RouteBuildEvent $event) {
    foreach ($event
      ->getRouteCollection() as $route) {
      $this->resolverManager
        ->setRouteOptions($route);
    }
  }

  /**
   * {@inheritdoc}
   */
  public static function getSubscribedEvents() {
    $events[RoutingEvents::ALTER][] = [
      'onRoutingRouteAlterSetType',
      -150,
    ];
    return $events;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
EntityRouteAlterSubscriber::$resolverManager	protected	property	The entity resolver manager.
EntityRouteAlterSubscriber::getSubscribedEvents	public static	function	Returns an array of event names this subscriber wants to listen to.
EntityRouteAlterSubscriber::onRoutingRouteAlterSetType	public	function	Applies parameter converters to route parameters.
EntityRouteAlterSubscriber::__construct	public	function	Constructs an EntityRouteAlterSubscriber instance.