0

Final Class Yiisoft\User\Login\Cookie\CookieLoginMiddleware

All Classes | Methods
InheritanceYiisoft\User\Login\Cookie\CookieLoginMiddleware
ImplementsPsr\Http\Server\MiddlewareInterface

CookieLoginMiddleware automatically logs user in based on cookie.

The auto-login cookie value must be protected against tampering: either configure a signature key for {@see \Yiisoft\User\Login\Cookie\CookieLogin}, or sign/encrypt the cookie separately (for example with {@see \Yiisoft\Cookies\CookieMiddleware}). Otherwise anyone able to edit the cookie (the end user, or an attacker who obtained it) can change the identity or the expiration timestamp.

Public Methods

Hide inherited methods

Method Description Defined By
__construct() Yiisoft\User\Login\Cookie\CookieLoginMiddleware
process() Yiisoft\User\Login\Cookie\CookieLoginMiddleware

Method Details

Hide inherited methods

__construct() public method

public mixed __construct ( Yiisoft\User\CurrentUser $currentUser, \Yiisoft\Auth\IdentityRepositoryInterface $identityRepository, \Psr\Log\LoggerInterface $logger, Yiisoft\User\Login\Cookie\CookieLogin $cookieLogin, boolean $forceAddCookie = false )
$currentUser Yiisoft\User\CurrentUser

The current user instance.
$identityRepository \Yiisoft\Auth\IdentityRepositoryInterface

The identity repository instance.
$logger \Psr\Log\LoggerInterface

The logger instance.
$cookieLogin Yiisoft\User\Login\Cookie\CookieLogin

The cookie login instance.
$forceAddCookie boolean

Whether to force add a cookie.

 

                public function __construct(
    private readonly CurrentUser $currentUser,
    private readonly IdentityRepositoryInterface $identityRepository,
    private readonly LoggerInterface $logger,
    private readonly CookieLogin $cookieLogin,
    private readonly bool $forceAddCookie = false,
) {}
process() public method

public process ( \Psr\Http\Message\ServerRequestInterface $request, \Psr\Http\Server\RequestHandlerInterface $handler )
$request \Psr\Http\Message\ServerRequestInterface
$handler \Psr\Http\Server\RequestHandlerInterface
throws JsonException

If an error occurs when JSON encoding the cookie value while adding the cookie file.
throws RuntimeException

If during authentication, the identity repository {@see \Yiisoft\Auth\IdentityRepositoryInterface} does not return an instance of {@see \Yiisoft\User\Login\Cookie\CookieLoginIdentityInterface}.

 

                public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
{
    if ($this->currentUser->isGuest()) {
        $this->authenticateUserByCookieFromRequest($request);
    }
    $guestBeforeHandle = $this->currentUser->isGuest();
    $response = $handler->handle($request);
    $guestAfterHandle = $this->currentUser->isGuest();
    if ($this->forceAddCookie && $guestBeforeHandle && !$guestAfterHandle) {
        $identity = $this->currentUser->getIdentity();
        if ($identity instanceof CookieLoginIdentityInterface) {
            $response = $this->cookieLogin->addCookie($identity, $response);
        }
    }
    if (!$guestBeforeHandle && $guestAfterHandle) {
        $response = $this->cookieLogin->expireCookie($response);
    }
    return $response;
}