class RouterListener in Zircon Profile 8

Initializes the context from the request and sets request attributes based on a matching route.

This listener works in 2 modes:

• 2.3 compatibility mode where you must call setRequest whenever the Request changes.
• 2.4+ mode where you must pass a RequestStack instance in the constructor.

@author Fabien Potencier <[e-mail]>

Hierarchy

• class \Symfony\Component\HttpKernel\EventListener\RouterListener implements EventSubscriberInterface

1 file declares its use of RouterListener

RouterListenerTest.php in vendor/symfony/http-kernel/Tests/EventListener/RouterListenerTest.php

1 string reference to 'RouterListener'

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

core/core.services.yml

1 service uses RouterListener

router_listener in core/core.services.yml

Symfony\Component\HttpKernel\EventListener\RouterListener

File

vendor/symfony/http-kernel/EventListener/RouterListener.php, line 40

Namespace

Symfony\Component\HttpKernel\EventListener

class RouterListener implements EventSubscriberInterface {
  private $matcher;
  private $context;
  private $logger;
  private $request;
  private $requestStack;

  /**
   * Constructor.
   *
   * RequestStack will become required in 3.0.
   *
   * @param UrlMatcherInterface|RequestMatcherInterface $matcher      The Url or Request matcher
   * @param RequestContext|null                         $context      The RequestContext (can be null when $matcher implements RequestContextAwareInterface)
   * @param LoggerInterface|null                        $logger       The logger
   * @param RequestStack|null                           $requestStack A RequestStack instance
   *
   * @throws \InvalidArgumentException
   */
  public function __construct($matcher, RequestContext $context = null, LoggerInterface $logger = null, RequestStack $requestStack = null) {
    if (!$matcher instanceof UrlMatcherInterface && !$matcher instanceof RequestMatcherInterface) {
      throw new \InvalidArgumentException('Matcher must either implement UrlMatcherInterface or RequestMatcherInterface.');
    }
    if (null === $context && !$matcher instanceof RequestContextAwareInterface) {
      throw new \InvalidArgumentException('You must either pass a RequestContext or the matcher must implement RequestContextAwareInterface.');
    }
    if (!$requestStack instanceof RequestStack) {
      @trigger_error('The ' . __METHOD__ . ' method now requires a RequestStack instance as ' . __CLASS__ . '::setRequest method will not be supported anymore in 3.0.', E_USER_DEPRECATED);
    }
    $this->matcher = $matcher;
    $this->context = $context ?: $matcher
      ->getContext();
    $this->requestStack = $requestStack;
    $this->logger = $logger;
  }

  /**
   * Sets the current Request.
   *
   * This method was used to synchronize the Request, but as the HttpKernel
   * is doing that automatically now, you should never call it directly.
   * It is kept public for BC with the 2.3 version.
   *
   * @param Request|null $request A Request instance
   *
   * @deprecated since version 2.4, to be removed in 3.0.
   */
  public function setRequest(Request $request = null) {
    @trigger_error('The ' . __METHOD__ . ' method is deprecated since version 2.4 and will be made private in 3.0.', E_USER_DEPRECATED);
    $this
      ->setCurrentRequest($request);
  }
  private function setCurrentRequest(Request $request = null) {
    if (null !== $request && $this->request !== $request) {
      $this->context
        ->fromRequest($request);
    }
    $this->request = $request;
  }
  public function onKernelFinishRequest(FinishRequestEvent $event) {
    if (null === $this->requestStack) {
      return;

      // removed when requestStack is required
    }
    $this
      ->setCurrentRequest($this->requestStack
      ->getParentRequest());
  }
  public function onKernelRequest(GetResponseEvent $event) {
    $request = $event
      ->getRequest();

    // initialize the context that is also used by the generator (assuming matcher and generator share the same context instance)
    // we call setCurrentRequest even if most of the time, it has already been done to keep compatibility
    // with frameworks which do not use the Symfony service container
    // when we have a RequestStack, no need to do it
    if (null !== $this->requestStack) {
      $this
        ->setCurrentRequest($request);
    }
    if ($request->attributes
      ->has('_controller')) {

      // routing is already done
      return;
    }

    // add attributes based on the request (routing)
    try {

      // matching a request is more powerful than matching a URL path + context, so try that first
      if ($this->matcher instanceof RequestMatcherInterface) {
        $parameters = $this->matcher
          ->matchRequest($request);
      }
      else {
        $parameters = $this->matcher
          ->match($request
          ->getPathInfo());
      }
      if (null !== $this->logger) {
        $this->logger
          ->info(sprintf('Matched route "%s".', isset($parameters['_route']) ? $parameters['_route'] : 'n/a'), array(
          'route_parameters' => $parameters,
          'request_uri' => $request
            ->getUri(),
        ));
      }
      $request->attributes
        ->add($parameters);
      unset($parameters['_route'], $parameters['_controller']);
      $request->attributes
        ->set('_route_params', $parameters);
    } catch (ResourceNotFoundException $e) {
      $message = sprintf('No route found for "%s %s"', $request
        ->getMethod(), $request
        ->getPathInfo());
      if ($referer = $request->headers
        ->get('referer')) {
        $message .= sprintf(' (from "%s")', $referer);
      }
      throw new NotFoundHttpException($message, $e);
    } catch (MethodNotAllowedException $e) {
      $message = sprintf('No route found for "%s %s": Method Not Allowed (Allow: %s)', $request
        ->getMethod(), $request
        ->getPathInfo(), implode(', ', $e
        ->getAllowedMethods()));
      throw new MethodNotAllowedHttpException($e
        ->getAllowedMethods(), $message, $e);
    }
  }
  public static function getSubscribedEvents() {
    return array(
      KernelEvents::REQUEST => array(
        array(
          'onKernelRequest',
          32,
        ),
      ),
      KernelEvents::FINISH_REQUEST => array(
        array(
          'onKernelFinishRequest',
          0,
        ),
      ),
    );
  }

}

Members

Name	Modifiers	Type	Description	Overrides
RouterListener::$context	private	property
RouterListener::$logger	private	property
RouterListener::$matcher	private	property
RouterListener::$request	private	property
RouterListener::$requestStack	private	property
RouterListener::getSubscribedEvents	public static	function	Returns an array of event names this subscriber wants to listen to. Overrides EventSubscriberInterface::getSubscribedEvents
RouterListener::onKernelFinishRequest	public	function
RouterListener::onKernelRequest	public	function
RouterListener::setCurrentRequest	private	function
RouterListener::setRequest Deprecated	public	function	Sets the current Request.
RouterListener::__construct	public	function	Constructor.