TokenEntityTrait::setScopes() - Code Metrics - Inspection of "Remove the encrypted payload from AuthCode and Ref..." - thephpleague/oauth2-server - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#1470)

unknown

created 2025-01-19 23:59 UTC

TokenEntityTrait::setScopes() A

↳ Parent: TokenEntityTrait

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	1
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	1
dl	0
loc	3
ccs	1
cts	1
cp	1
crap	1
rs	10
c	0
b	0
f	0

<?php

/**
 * @author      Alex Bilbie <[email protected]>
 * @copyright   Copyright (c) Alex Bilbie
 * @license     http://mit-license.org/
 *
 * @link        https://github.com/thephpleague/oauth2-server
 */

declare(strict_types=1);

namespace League\OAuth2\Server\Entities\Traits;

use DateTimeImmutable;
use League\OAuth2\Server\Entities\ClientEntityInterface;
use League\OAuth2\Server\Entities\ScopeEntityInterface;

use function array_values;

trait TokenEntityTrait
{
    /**
     * @var ScopeEntityInterface[]
     */
    protected array $scopes = [];

    protected DateTimeImmutable $expiryDateTime;

    /**
     * @var non-empty-string|null

     */
    protected string|null $userIdentifier = null;

    protected ClientEntityInterface $client;

    /**
     * Associate a scope with the token.
     */
    public function addScope(ScopeEntityInterface $scope): void
    {
        $this->scopes[$scope->getIdentifier()] = $scope;
    }

    /**
     * Return an array of scopes associated with the token.
     *
     * @return ScopeEntityInterface[]
     */
    public function getScopes(): array
    {
        return array_values($this->scopes);
    }

    /**
     * Set the scopes array (doesn't check for duplicates)
     * @param array scopes
filter:
    dependency_paths: ["lib/*"]
     */
    public function setScopes(array $scopes): void
    {
        $this->scopes = $scopes;
    }

    /**
     * Get the token's expiry date time.
     */
    public function getExpiryDateTime(): DateTimeImmutable
    {
        return $this->expiryDateTime;
    }

    /**
     * Set the date time when the token expires.
     */
    public function setExpiryDateTime(DateTimeImmutable $dateTime): void
    {
        $this->expiryDateTime = $dateTime;
    }

    /**
     * Set the identifier of the user associated with the token.
     *
     * @param non-empty-string $identifier The identifier of the user

     */
    public function setUserIdentifier(?string $identifier): void
    {
        $this->userIdentifier = $identifier;
    }

    /**
     * Get the token user's identifier.
     *
     * @return non-empty-string|null

     */
    public function getUserIdentifier(): ?string
    {
        return $this->userIdentifier;
    }

    /**
     * Get the client that the token was issued to.
     */
    public function getClient(): ClientEntityInterface
    {
        return $this->client;
    }

    /**
     * Set the client that the token was issued to.
     */
    public function setClient(ClientEntityInterface $client): void
    {
        $this->client = $client;
    }
}


1		<?php
2
3		/**
4		* @author Alex Bilbie <[email protected]>
5		* @copyright Copyright (c) Alex Bilbie
6		* @license http://mit-license.org/
7		*
8		* @link https://github.com/thephpleague/oauth2-server
9		*/
10
11		declare(strict_types=1);
12
13		namespace League\OAuth2\Server\Entities\Traits;
14
15		use DateTimeImmutable;
16		use League\OAuth2\Server\Entities\ClientEntityInterface;
17		use League\OAuth2\Server\Entities\ScopeEntityInterface;
18
19		use function array_values;
20
21		trait TokenEntityTrait
22		{
23		/**
24		* @var ScopeEntityInterface[]
25		*/
26		protected array $scopes = [];
27
28		protected DateTimeImmutable $expiryDateTime;
29
30		/**
31		* @var non-empty-string\|null
		0 ignored issues – show Documentation Bug introduced 2024-03-27 00:04 UTC by Report Bug Copy Issue Report The doc comment `non-empty-string\|null` at position `0` could not be parsed: Unknown type name 'non-empty-string' at position 0 in non-empty-string\|null. Loading history...
32		*/
33		protected string\|null $userIdentifier = null;
34
35		protected ClientEntityInterface $client;
36
37		/**
38		* Associate a scope with the token.
39		*/
40	10	public function addScope(ScopeEntityInterface $scope): void
41		{
42	10	$this->scopes[$scope->getIdentifier()] = $scope;
43		}
44
45		/**
46		* Return an array of scopes associated with the token.
47		*
48		* @return ScopeEntityInterface[]
49		*/
50	15	public function getScopes(): array
51		{
52	15	return array_values($this->scopes);
53		}
54
55		/**
56		* Set the scopes array (doesn't check for duplicates)
57		* @param array scopes
		0 ignored issues – show Bug introduced 2025-01-20 00:30 UTC by Report Bug Copy Issue Report The type `League\OAuth2\Server\Entities\Traits\scopes` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
58	21	*/
59		public function setScopes(array $scopes): void
60	21	{
61		$this->scopes = $scopes;
62		}
63
64		/**
65		* Get the token's expiry date time.
66	52	*/
67		public function getExpiryDateTime(): DateTimeImmutable
68	52	{
69		return $this->expiryDateTime;
70		}
71
72		/**
73		* Set the date time when the token expires.
74		*/
75		public function setExpiryDateTime(DateTimeImmutable $dateTime): void
76	20	{
77		$this->expiryDateTime = $dateTime;
78	20	}
79
80		/**
81		* Set the identifier of the user associated with the token.
82		*
83		* @param non-empty-string $identifier The identifier of the user
		0 ignored issues – show Documentation Bug introduced 2024-03-27 00:04 UTC by Report Bug Copy Issue Report The doc comment `non-empty-string` at position `0` could not be parsed: Unknown type name 'non-empty-string' at position 0 in non-empty-string. Loading history...
84		*/
85		public function setUserIdentifier(?string $identifier): void
86	19	{
87		$this->userIdentifier = $identifier;
88	19	}
89
90		/**
91		* Get the token user's identifier.
92		*
93		* @return non-empty-string\|null
		0 ignored issues – show Documentation Bug introduced 2024-03-27 00:04 UTC by Report Bug Copy Issue Report The doc comment `non-empty-string\|null` at position `0` could not be parsed: Unknown type name 'non-empty-string' at position 0 in non-empty-string\|null. Loading history...
94	18	*/
95		public function getUserIdentifier(): ?string
96	18	{
97		return $this->userIdentifier;
98		}
99
100		/**
101		* Get the client that the token was issued to.
102	28	*/
103		public function getClient(): ClientEntityInterface
104	28	{
105		return $this->client;
106		}
107
108		/**
109		* Set the client that the token was issued to.
110		*/
111		public function setClient(ClientEntityInterface $client): void
112		{
113		$this->client = $client;
114		}
115		}
116

thephpleague / oauth2-server

Pull Request — master (#1470)

TokenEntityTrait::setScopes() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like