vendor/can/rest/src/Can/RestBundle/EventListener/PreferenceListener.php line 53

Open in your IDE?
  1. <?php
  3. namespace Can\RestBundle\EventListener;
  5. use Can\RestBundle\CanRestBundle;
  6. use Can\RestBundle\Http\Header\Prefer;
  7. use Can\RestBundle\Preference\PreferenceConfiguration;
  8. use Can\RestBundle\Preference\PreferenceEventDispatcher;
  10. use Symfony\Component\HttpFoundation\Request;
  11. use Symfony\Component\HttpKernel\Event\RequestEvent;
  12. use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
  14. use InvalidArgumentException;
  16. /**
  17.  * A listener which collects client preferences, specified through the the
  18.  * HTTP Prefer request header.
  19.  *
  20.  * @group preference
  21.  *
  22.  * @package can/rest-bundle
  23.  * @author lechecacharro <lechecacharro@gmail.com>
  24.  */
  25. class PreferenceListener
  26. {
  28.     /**
  29.      * @var PreferenceConfiguration
  30.      */
  31.     protected $configuration;
  33.     /**
  34.      * @var PreferenceEventDispatcher
  35.      */
  36.     protected $dispatcher;
  38.     /**
  39.      * PreferenceListener constructor.
  40.      *
  41.      * @param PreferenceConfiguration   $configuration
  42.      * @param PreferenceEventDispatcher $dispatcher
  43.      */
  44.     public function __construct(PreferenceConfiguration $configuration, PreferenceEventDispatcher $dispatcher)
  45.     {
  46.         $this->configuration = $configuration;
  47.         $this->dispatcher = $dispatcher;
  48.     }
  50.     /**
  51.      * @param RequestEvent $event
  52.      */
  53.     public function onRequest(RequestEvent $event): void
  54.     {
  55.         // Skip processing if the component is not enabled
  56.         if (! $this->configuration->isEnabled()) {
  57.             return;
  58.         }
  60.         // Do process only the master request
  61.         if (! $event->isMasterRequest()) {
  62.             return;
  63.         }
  65.         $request = $event->getRequest();
  67.         // Skip processing if not in the service zone
  68.         if (! $request->attributes->get(CanRestBundle::ATTR_SERVICE_ZONE)) {
  69.             return;
  70.         }
  72.         $this->setPreferences($request);
  73.     }
  75.     /**
  76.      * Sets the list of requested preferences via the HTTP Prefer header as the
  77.      * {@link CanRestBundle::ATTR_PREFERENCES} request attribute.
  78.      *
  79.      * @param Request $request the HTTP request
  80.      *
  81.      * @throws BadRequestHttpException if the Prefer header is invalid
  82.      */
  83.     protected function setPreferences(Request $request): void
  84.     {
  85.         try {
  86.             $preferenceList = Prefer::parseHeader($request->headers->get('Prefer'));
  87.         } catch (InvalidArgumentException $e) {
  88.             throw new BadRequestHttpException('Invalid Prefer header', $e);
  89.         }
  91.         // Allow third parties to modify the list of requested preferences
  92.         $event = $this->dispatcher->dispatchPreferencesRequested($preferenceList);
  94.         $request->attributes->set(CanRestBundle::ATTR_PREFERENCES, $event->getPreferenceList());
  95.     }
  97. }