vendor/api-platform/core/src/Hydra/EventListener/AddLinkHeaderListener.php line 39

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the API Platform project.
  5.  *
  6.  * (c) Kévin Dunglas <dunglas@gmail.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. declare(strict_types=1);
  14. namespace ApiPlatform\Core\Hydra\EventListener;
  16. use ApiPlatform\Core\Api\UrlGeneratorInterface;
  17. use ApiPlatform\Core\JsonLd\ContextBuilder;
  18. use Fig\Link\GenericLinkProvider;
  19. use Fig\Link\Link;
  20. use Symfony\Component\HttpKernel\Event\FilterResponseEvent;
  22. /**
  23.  * Adds the HTTP Link header pointing to the Hydra documentation.
  24.  *
  25.  * @author Kévin Dunglas <dunglas@gmail.com>
  26.  */
  27. final class AddLinkHeaderListener
  28. {
  29.     private $urlGenerator;
  31.     public function __construct(UrlGeneratorInterface $urlGenerator)
  32.     {
  33.         $this->urlGenerator = $urlGenerator;
  34.     }
  36.     /**
  37.      * Sends the Hydra header on each response.
  38.      */
  39.     public function onKernelResponse(FilterResponseEvent $event): void
  40.     {
  41.         $apiDocUrl = $this->urlGenerator->generate('api_doc', ['_format' => 'jsonld'], UrlGeneratorInterface::ABS_URL);
  42.         $link = new Link(ContextBuilder::HYDRA_NS.'apiDocumentation', $apiDocUrl);
  44.         $attributes = $event->getRequest()->attributes;
  45.         if (null === $linkProvider = $attributes->get('_links')) {
  46.             $attributes->set('_links', new GenericLinkProvider([$link]));
  48.             return;
  49.         }
  50.         $attributes->set('_links', $linkProvider->withLink($link));
  51.     }
  52. }