class ContentTypeHeaderMatcher in Zircon Profile 8

Filters routes based on the HTTP Content-type header.

Hierarchy

• class \Drupal\Core\Routing\ContentTypeHeaderMatcher implements RouteFilterInterface

1 file declares its use of ContentTypeHeaderMatcher

ContentTypeHeaderMatcherTest.php in core/tests/Drupal/Tests/Core/Routing/ContentTypeHeaderMatcherTest.php

Contains \Drupal\Tests\Core\Routing\ContentTypeHeaderMatcherTest.

1 string reference to 'ContentTypeHeaderMatcher'

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

core/core.services.yml

1 service uses ContentTypeHeaderMatcher

content_type_header_matcher in core/core.services.yml

Drupal\Core\Routing\ContentTypeHeaderMatcher

File

core/lib/Drupal/Core/Routing/ContentTypeHeaderMatcher.php, line 18

Contains \Drupal\Core\Routing\ContentTypeHeaderMatcher.

Namespace

Drupal\Core\Routing

class ContentTypeHeaderMatcher implements RouteFilterInterface {

  /**
   * {@inheritdoc}
   */
  public function filter(RouteCollection $collection, Request $request) {

    // The Content-type header does not make sense on GET requests, because GET
    // requests do not carry any content. Nothing to filter in this case.
    if ($request
      ->isMethod('GET')) {
      return $collection;
    }
    $format = $request
      ->getContentType();
    foreach ($collection as $name => $route) {
      $supported_formats = array_filter(explode('|', $route
        ->getRequirement('_content_type_format')));
      if (empty($supported_formats)) {

        // No restriction on the route, so we move the route to the end of the
        // collection by re-adding it. That way generic routes sink down in the
        // list and exact matching routes stay on top.
        $collection
          ->add($name, $route);
      }
      elseif (!in_array($format, $supported_formats)) {
        $collection
          ->remove($name);
      }
    }
    if (count($collection)) {
      return $collection;
    }

    // We do not throw a
    // \Symfony\Component\Routing\Exception\ResourceNotFoundException here
    // because we don't want to return a 404 status code, but rather a 415.
    throw new UnsupportedMediaTypeHttpException('No route found that matches the Content-Type header.');
  }

  /**
   * {@inheritdoc}
   */
  public function applies(Route $route) {
    return TRUE;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ContentTypeHeaderMatcher::applies	public	function	Determines if the route filter applies to the given route. Overrides RouteFilterInterface::applies
ContentTypeHeaderMatcher::filter	public	function	Filters the route collection against a request and returns all matching routes. Overrides RouteFilterInterface::filter