QueryParameter::authenticate() - Code Metrics - yiisoft/auth - Measure and Improve Code Quality continuously with Scrutinizer

QueryParameter::authenticate() A
last analyzed 2024-04-07 09:17 UTC

↳ Parent: QueryParameter

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	2

Importance

Changes

Metric	Value
cc	2
eloc	4
nc	2
nop	1
dl	0
loc	8
ccs	5
cts	5
cp	1
crap	2
rs	10
c	0
b	0
f	0

<?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;

    public function __construct(private IdentityWithTokenRepositoryInterface $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
     *
     * @return $this
     *
     * @psalm-immutable
     */
    public function withTokenType(?string $type): self
    {
        $new = clone $this;
        $new->tokenType = $type;
        return $new;
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Yiisoft\Auth\Method;
6
7		use Psr\Http\Message\ResponseInterface;
8		use Psr\Http\Message\ServerRequestInterface;
9		use Yiisoft\Auth\AuthenticationMethodInterface;
10		use Yiisoft\Auth\IdentityInterface;
11		use Yiisoft\Auth\IdentityWithTokenRepositoryInterface;
12
13		use function is_string;
14
15		/**
16		* QueryParameter supports the authentication based on the access token passed through a query parameter.
17		*/
18		final class QueryParameter implements AuthenticationMethodInterface
19		{
20		private string $parameterName = 'access-token';
21		private ?string $tokenType = null;
22
23	10	public function __construct(private IdentityWithTokenRepositoryInterface $identityRepository)
24		{
25	10	}
26
27	7	public function authenticate(ServerRequestInterface $request): ?IdentityInterface
28		{
29	7	$accessToken = $request->getQueryParams()[$this->parameterName] ?? null;
30	7	if (is_string($accessToken)) {
31	6	return $this->identityRepository->findIdentityByToken($accessToken, $this->tokenType);
32		}
33
34	3	return null;
35		}
36
37	2	public function challenge(ResponseInterface $response): ResponseInterface
38		{
39	2	return $response;
40		}
41
42		/**
43		* @param string $name The parameter name for passing the access token.
44		*
45		* @return $this
46		*
47		* @psalm-immutable
48		*/
49	2	public function withParameterName(string $name): self
50		{
51	2	$new = clone $this;
52	2	$new->parameterName = $name;
53	2	return $new;
54		}
55
56		/**
57		* @param string\|null $type Identity token type
58		*
59		* @return $this
60		*
61		* @psalm-immutable
62		*/
63	2	public function withTokenType(?string $type): self
64		{
65	2	$new = clone $this;
66	2	$new->tokenType = $type;
67	2	return $new;
68		}
69		}
70

yiisoft / auth

QueryParameter::authenticate() A last analyzed 2024-04-07 09:17 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

QueryParameter::authenticate() A
last analyzed 2024-04-07 09:17 UTC