0 follower

Final Class Yiisoft\Auth\Method\QueryParameter

All Classes | Methods
InheritanceYiisoft\Auth\Method\QueryParameter
ImplementsYiisoft\Auth\AuthenticationMethodInterface

QueryParameter supports the authentication based on the access token passed through a query parameter.

Public Methods

Hide inherited methods

Method Description Defined By
__construct() Yiisoft\Auth\Method\QueryParameter
authenticate() Yiisoft\Auth\Method\QueryParameter
challenge() Yiisoft\Auth\Method\QueryParameter
withParameterName() Yiisoft\Auth\Method\QueryParameter
withTokenType() Yiisoft\Auth\Method\QueryParameter

Method Details

Hide inherited methods

__construct() public method

public __construct( Yiisoft\Auth\IdentityWithTokenRepositoryInterface $identityRepository ): mixed
$identityRepository Yiisoft\Auth\IdentityWithTokenRepositoryInterface 

                public function __construct(private IdentityWithTokenRepositoryInterface $identityRepository) {}
authenticate() public method

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

                public function authenticate(ServerRequestInterface $request): ?IdentityInterface
{
    $accessToken = $request->getQueryParams()[$this->parameterName] ?? null;
    if (is_string($accessToken)) {
        return $this->identityRepository->findIdentityByToken($accessToken, $this->tokenType);
    }
    return null;
}
challenge() public method

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

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

public withParameterName( string $name ): $this
$name string

The parameter name for passing the access token.

 

                public function withParameterName(string $name): self
{
    $new = clone $this;
    $new->parameterName = $name;
    return $new;
}
withTokenType() public method

public withTokenType( string|null $type ): $this
$type string|null

Identity token type

 

                public function withTokenType(?string $type): self
{
    $new = clone $this;
    $new->tokenType = $type;
    return $new;
}