class RenderArrayNonHtmlSubscriber in Drupal 9

Throws 406 if requesting non-HTML format and controller returns render array.

Hierarchy

• class \Drupal\Core\EventSubscriber\RenderArrayNonHtmlSubscriber implements \Symfony\Component\EventDispatcher\EventSubscriberInterface

1 string reference to 'RenderArrayNonHtmlSubscriber'

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

core/core.services.yml

1 service uses RenderArrayNonHtmlSubscriber

renderer_non_html in core/core.services.yml

Drupal\Core\EventSubscriber\RenderArrayNonHtmlSubscriber

File

core/lib/Drupal/Core/EventSubscriber/RenderArrayNonHtmlSubscriber.php, line 13

Namespace

Drupal\Core\EventSubscriber

class RenderArrayNonHtmlSubscriber implements EventSubscriberInterface {

  /**
   * Throws an HTTP 406 error if client requested a non-HTML format.
   *
   * @param \Symfony\Component\HttpKernel\Event\ViewEvent $event
   *   The event to process.
   */
  public function onRespond(ViewEvent $event) {
    $request = $event
      ->getRequest();
    $result = $event
      ->getControllerResult();

    // If this is a render array then we assume that the router went with the
    // generic controller and not one with a format. If the format requested is
    // not HTML though, we can also assume that the requested format is invalid
    // so we provide a 406 response.
    if (is_array($result) && $request
      ->getRequestFormat() !== 'html') {
      throw new NotAcceptableHttpException('Not acceptable format: ' . $request
        ->getRequestFormat());
    }
  }

  /**
   * {@inheritdoc}
   */
  public static function getSubscribedEvents() {
    $events[KernelEvents::VIEW][] = [
      'onRespond',
      -10,
    ];
    return $events;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
RenderArrayNonHtmlSubscriber::getSubscribedEvents	public static	function
RenderArrayNonHtmlSubscriber::onRespond	public	function	Throws an HTTP 406 error if client requested a non-HTML format.