src/EventListener/VersionDeprecationHeaderListener.php line 38

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. namespace App\EventListener;
  7. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  8. use Symfony\Component\HttpFoundation\JsonResponse;
  9. use Symfony\Component\HttpKernel\Event\ResponseEvent;
  10. use Symfony\Component\HttpKernel\KernelEvents;
  12. /**
  13.  * Class VersionDeprecationHeaderListener
  14.  */
  15. class VersionDeprecationHeaderListener implements EventSubscriberInterface
  16. {
  17.     private $lastVersion;
  18.     private $sunsetVersions;
  19.     private $unsupportedVersions;
  21.     public function __construct(
  22.         string $apiUnsupportedVersions,
  23.         string $apiSunsetVersions,
  24.         string $apiLastVersion
  25.     ) {
  26.         $this->unsupportedVersions = explode(',', $apiUnsupportedVersions);
  27.         $this->sunsetVersions = explode(',', $apiSunsetVersions);
  28.         $this->lastVersion = $apiLastVersion;
  29.     }
  31.     public static function getSubscribedEvents(): array
  32.     {
  33.         return [
  34.             KernelEvents::RESPONSE => 'addVersionDeprecationHeader',
  35.         ];
  36.     }
  38.     public function addVersionDeprecationHeader(ResponseEvent $event): void
  39.     {
  40.         $response = $event->getResponse();
  42.         if (!$response instanceof JsonResponse) {
  43.             return;
  44.         }
  46.         $routeArray = explode('/', $event->getRequest()->getRequestUri());
  47.         if ($routeArray[1] !== 'api') {
  48.             return;
  49.         }
  51.         $currentVersion = $routeArray[2];
  52.         if (strpos($currentVersion, 'v') !== 0) {
  53.             return;
  54.         }
  56.         $isSupported = in_array($currentVersion, $this->unsupportedVersions, true) ? false : true;
  58.         $headers['Api-Supported'] = $isSupported;
  59.         $headers['Api-Last-Version'] = $this->lastVersion;
  60.         $headers['Api-Current-Version'] = $currentVersion;
  62.         $response->headers->add($headers);
  63.     }
  64. }