class AcceptHeaderMiddleware

Same name in other branches
  1. 9 core/modules/system/tests/modules/accept_header_routing_test/src/AcceptHeaderMiddleware.php \Drupal\accept_header_routing_test\AcceptHeaderMiddleware
  2. 8.9.x core/modules/system/tests/modules/accept_header_routing_test/src/AcceptHeaderMiddleware.php \Drupal\accept_header_routing_test\AcceptHeaderMiddleware
  3. 11.x core/modules/system/tests/modules/accept_header_routing_test/src/AcceptHeaderMiddleware.php \Drupal\accept_header_routing_test\AcceptHeaderMiddleware

Example implementation of "accept header"-based content negotiation.

Hierarchy

Expanded class hierarchy of AcceptHeaderMiddleware

File

core/modules/system/tests/modules/accept_header_routing_test/src/AcceptHeaderMiddleware.php, line 12

Namespace

Drupal\accept_header_routing_test
View source 
class AcceptHeaderMiddleware implements HttpKernelInterface {
    
    /**
     * The app kernel.
     */
    protected HttpKernelInterface $app;
    
    /**
     * Constructs a new AcceptHeaderMiddleware instance.
     *
     * @param \Symfony\Component\HttpKernel\HttpKernelInterface $app
     *   The app.
     */
    public function __construct(HttpKernelInterface $app) {
        $this->app = $app;
    }
    
    /**
     * {@inheritdoc}
     */
    public function handle(Request $request, $type = self::MAIN_REQUEST, $catch = TRUE) : Response {
        $mapping = [
            'application/json' => 'json',
            'application/xml' => 'xml',
            'text/html' => 'html',
        ];
        $accept = $request->headers
            ->get('Accept') ?: [
            'text/html',
        ];
        if (isset($mapping[$accept[0]])) {
            $request->setRequestFormat($mapping[$accept[0]]);
        }
        return $this->app
            ->handle($request, $type, $catch);
    }

}

Members

Title Modifiers Object type Summary
AcceptHeaderMiddleware::$app protected property The app kernel.
AcceptHeaderMiddleware::handle public function
AcceptHeaderMiddleware::__construct public function Constructs a new AcceptHeaderMiddleware instance.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.