class SpecialAttributesRouteSubscriber in Drupal 9

Provides a route subscriber which checks for invalid pattern variables.

Hierarchy

• class \Drupal\Core\Routing\RouteSubscriberBase implements \Symfony\Component\EventDispatcher\EventSubscriberInterface
  • class \Drupal\Core\EventSubscriber\SpecialAttributesRouteSubscriber

1 file declares its use of SpecialAttributesRouteSubscriber

SpecialAttributesRouteSubscriberTest.php in core/tests/Drupal/Tests/Core/EventSubscriber/SpecialAttributesRouteSubscriberTest.php

1 string reference to 'SpecialAttributesRouteSubscriber'

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

core/core.services.yml

1 service uses SpecialAttributesRouteSubscriber

route_special_attributes_subscriber in core/core.services.yml

Drupal\Core\EventSubscriber\SpecialAttributesRouteSubscriber

File

core/lib/Drupal/Core/EventSubscriber/SpecialAttributesRouteSubscriber.php, line 13

Namespace

Drupal\Core\EventSubscriber

class SpecialAttributesRouteSubscriber extends RouteSubscriberBase {

  /**
   * {@inheritdoc}
   */
  protected function alterRoutes(RouteCollection $collection) {
    $special_variables = [
      'system_path',
      '_legacy',
      '_raw_variables',
      RouteObjectInterface::ROUTE_OBJECT,
      RouteObjectInterface::ROUTE_NAME,
      '_content',
      '_controller',
      '_form',
    ];
    foreach ($collection
      ->all() as $name => $route) {
      if ($not_allowed_variables = array_intersect($route
        ->compile()
        ->getVariables(), $special_variables)) {
        $reserved = implode(', ', $not_allowed_variables);
        trigger_error(sprintf('Route %s uses reserved variable names: %s', $name, $reserved), E_USER_WARNING);
      }
    }
  }

  /**
   * Delegates the route altering to self::alterRoutes().
   *
   * @param \Drupal\Core\Routing\RouteBuildEvent $event
   *   The route build event.
   */
  public function onAlterRoutes(RouteBuildEvent $event) {
    $collection = $event
      ->getRouteCollection();
    $this
      ->alterRoutes($collection);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
RouteSubscriberBase::getSubscribedEvents	public static	function		7
SpecialAttributesRouteSubscriber::alterRoutes	protected	function	Alters existing routes for a specific collection. Overrides RouteSubscriberBase::alterRoutes
SpecialAttributesRouteSubscriber::onAlterRoutes	public	function	Delegates the route altering to self::alterRoutes(). Overrides RouteSubscriberBase::onAlterRoutes