Skip to content

EncryptCookiesMiddleware

  • Full name: \Qubus\Http\Cookies\Middleware\EncryptCookiesMiddleware
  • This class implements: MiddlewareInterface

Properties

bypass

A list of cookie names not to encrypt/decrypt.

protected array<int,string> $bypass

key

The key with which to encrypt cookies.

protected \Defuse\Crypto\Key|null $key

Methods

__construct

Create a new instance of the middleware

public __construct(\Defuse\Crypto\Key $cryptoKey, array<int,string> $bypassCookieNames = []): mixed

Parameters:

Parameter Type Description
$cryptoKey \Defuse\Crypto\Key
$bypassCookieNames array

process

public process(\Psr\Http\Message\ServerRequestInterface $request, \Psr\Http\Server\RequestHandlerInterface $handler): \Psr\Http\Message\ResponseInterface

Parameters:

Parameter Type Description
$request \Psr\Http\Message\ServerRequestInterface
$handler \Psr\Http\Server\RequestHandlerInterface

Throws:

encrypt

public encrypt(\Qubus\Http\Cookies\SetCookieCollection $setCookie): \Qubus\Http\Cookies\SetCookieCollection

Parameters:

Parameter Type Description
$setCookie \Qubus\Http\Cookies\SetCookieCollection

Throws:

decrypt

public decrypt(\Qubus\Http\Cookies\CookieCollection $cookie): \Qubus\Http\Cookies\CookieCollection

Parameters:

Parameter Type Description
$cookie \Qubus\Http\Cookies\CookieCollection