1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283 |
- <?php
- namespace Drupal\Core\Routing;
- use Symfony\Component\HttpFoundation\Request;
- use Symfony\Component\HttpKernel\Exception\NotAcceptableHttpException;
- use Symfony\Component\Routing\RouteCollection;
- /**
- * Provides a route filter, which filters by the request format.
- */
- class RequestFormatRouteFilter implements FilterInterface {
- /**
- * {@inheritdoc}
- */
- public function filter(RouteCollection $collection, Request $request) {
- // Determine the request format.
- $default_format = static::getDefaultFormat($collection);
- $format = $request->getRequestFormat($default_format);
- $routes_with_requirement = [];
- $routes_without_requirement = [];
- $result_collection = new RouteCollection();
- /** @var \Symfony\Component\Routing\Route $route */
- foreach ($collection as $name => $route) {
- if (!$route->hasRequirement('_format')) {
- $routes_without_requirement[$name] = $route;
- continue;
- }
- else {
- $routes_with_requirement[$name] = $route;
- }
- }
- foreach ($routes_with_requirement as $name => $route) {
- // If the route has no _format specification, we move it to the end. If it
- // does, then no match means the route is removed entirely.
- if (($supported_formats = array_filter(explode('|', $route->getRequirement('_format')))) && in_array($format, $supported_formats, TRUE)) {
- $result_collection->add($name, $route);
- }
- }
- foreach ($routes_without_requirement as $name => $route) {
- $result_collection->add($name, $route);
- }
- if (count($result_collection)) {
- return $result_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 406.
- throw new NotAcceptableHttpException("No route found for the specified format $format.");
- }
- /**
- * Determines the default request format.
- *
- * By default, use 'html' as the default format. But when there's only a
- * single route match, and that route specifies a '_format' requirement
- * listing a single format, then use that as the default format.
- *
- * @param \Symfony\Component\Routing\RouteCollection $collection
- * The route collection to filter.
- *
- * @return string
- * The default format.
- */
- protected static function getDefaultFormat(RouteCollection $collection) {
- $default_format = 'html';
- if ($collection->count() === 1) {
- $only_route = $collection->getIterator()->current();
- $required_format = $only_route->getRequirement('_format');
- if (strpos($required_format, '|') === FALSE) {
- $default_format = $required_format;
- }
- }
- return $default_format;
- }
- }
|