for testing and deploying your application
for finding and fixing issues
for empowering human code reviews
<?php
declare(strict_types=1);
namespace Yiisoft\Auth\Method;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Yiisoft\Auth\AuthenticationMethodInterface;
use Yiisoft\Auth\IdentityInterface;
use Yiisoft\Auth\IdentityWithTokenRepositoryInterface;
use function is_string;
/**
* QueryParameter supports the authentication based on the access token passed through a query parameter.
*/
final class QueryParameter implements AuthenticationMethodInterface
{
private string $parameterName = 'access-token';
private ?string $tokenType = null;
private IdentityWithTokenRepositoryInterface $identityRepository;
public function __construct(IdentityWithTokenRepositoryInterface $identityRepository)
$this->identityRepository = $identityRepository;
}
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;
public function challenge(ResponseInterface $response): ResponseInterface
return $response;
* @param string $name The parameter name for passing the access token.
*
* @return $this
* @psalm-immutable
public function withParameterName(string $name): self
$new = clone $this;
$new->parameterName = $name;
return $new;
* @param string|null $type Identity token type
public function withTokenType(?string $type): self
$new->tokenType = $type;
yiisoft /
auth
