0 follower

Final Class Yiisoft\User\Method\ApiAuth

All Classes | Methods
InheritanceYiisoft\User\Method\ApiAuth
ImplementsYiisoft\Auth\AuthenticationMethodInterface

Implementation of the AuthenticationMethodInterface for authenticating users in the API clients.

Public Methods

Hide inherited methods

Method Description Defined By
__construct() Yiisoft\User\Method\ApiAuth
authenticate() Yiisoft\User\Method\ApiAuth
challenge() Yiisoft\User\Method\ApiAuth

Method Details

Hide inherited methods

__construct() public method

public mixed __construct ( Yiisoft\User\CurrentUser $currentUser )
$currentUser Yiisoft\User\CurrentUser 

                public function __construct(private readonly CurrentUser $currentUser)
{
}
authenticate() public method

public \Yiisoft\Auth\IdentityInterface|null authenticate ( \Psr\Http\Message\ServerRequestInterface $request )
$request \Psr\Http\Message\ServerRequestInterface 

                public function authenticate(ServerRequestInterface $request): ?IdentityInterface
{
    if ($this->currentUser->isGuest()) {
        return null;
    }
    return $this->currentUser->getIdentity();
}
challenge() public method

public \Psr\Http\Message\ResponseInterface challenge ( \Psr\Http\Message\ResponseInterface $response )
$response \Psr\Http\Message\ResponseInterface 

                public function challenge(ResponseInterface $response): ResponseInterface
{
    return $response;
}