vendor/friendsofsymfony/rest-bundle/EventListener/ZoneMatcherListener.php line 37

  1. <?php
  3. /*
  4.  * This file is part of the FOSRestBundle package.
  5.  *
  6.  * (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace FOS\RestBundle\EventListener;
  14. use FOS\RestBundle\FOSRestBundle;
  15. use Symfony\Component\HttpFoundation\RequestMatcherInterface;
  16. use Symfony\Component\HttpKernel\Event\RequestEvent;
  18. /**
  19.  * Matches FOSRest's zones.
  20.  *
  21.  * @author Florian Voutzinos <florian@voutzinos.com>
  22.  *
  23.  * @internal
  24.  */
  25. class ZoneMatcherListener
  26. {
  27.     private $requestMatchers = [];
  29.     public function addRequestMatcher(RequestMatcherInterface $requestMatcher)
  30.     {
  31.         $this->requestMatchers[] = $requestMatcher;
  32.     }
  34.     /**
  35.      * Adds an optional "_fos_rest_zone" request attribute to be checked for existence by other listeners.
  36.      */
  37.     public function onKernelRequest(RequestEvent $event): void
  38.     {
  39.         $request = $event->getRequest();
  41.         foreach ($this->requestMatchers as $requestMatcher) {
  42.             if ($requestMatcher->matches($request)) {
  43.                 $request->attributes->set(FOSRestBundle::ZONE_ATTRIBUTE, true);
  45.                 return;
  46.             }
  47.         }
  49.         $request->attributes->set(FOSRestBundle::ZONE_ATTRIBUTE, false);
  50.     }
  51. }