ClientMetadata::jsonSerialize() - Code Metrics - Inspection of "New implementation" - thomasvargiu/php-openid-client - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 898cc7...450add )

by Thomas Mauro

created 2019-07-08 11:59 UTC

ClientMetadata::jsonSerialize() A

↳ Parent: ClientMetadata

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

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

<?php

declare(strict_types=1);

namespace TMV\OpenIdClient\Model;

use TMV\OpenIdClient\Exception\InvalidArgumentException;

class ClientMetadata implements ClientMetadataInterface
{
    /**
     * @var array
     */
    private $claims;

    private static $requiredKeys = [
        'client_id',
    ];

    private static $defaults = [
        'client_id' => null,
        'redirect_uris' => [],
        'client_secret' => null,
        'jwks' => null,
        'jwks_uri' => null,
        'id_token_signed_response_alg' => 'RS256',
        'id_token_encrypted_response_alg' => null,
        'id_token_encrypted_response_enc' => null,
        'userinfo_signed_response_alg' => null,
        'userinfo_encrypted_response_alg' => null,
        'userinfo_encrypted_response_enc' => null,
        'response_types' => ['code'],
        'post_logout_redirect_uris' => [],
        'require_auth_time' => false,
        'request_object_signing_alg' => null,
        'request_object_encryption_alg' => null,
        'request_object_encryption_enc' => null,
        'token_endpoint_auth_method' => 'client_secret_basic',
        //'introspection_endpoint_auth_method' => 'client_secret_basic',
        //'revocation_endpoint_auth_method' => 'client_secret_basic',
        'token_endpoint_auth_signing_alg' => null,
        'introspection_endpoint_auth_signing_alg' => null,
        'revocation_endpoint_auth_signing_alg' => null,
        'tls_client_certificate_bound_access_tokens' => false,
    ];

    /**
     * IssuerMetadata constructor.
     *
     * @param string $clientId
     * @param array<string, mixed> $claims
     */
    public function __construct(string $clientId, $claims = [])
    {
        $requiredClaims = [
            'client_id' => $clientId,
        ];

        $defaults = static::$defaults;


        $this->claims = \array_merge($defaults, $claims, $requiredClaims);
    }

    public static function fromClaims(array $claims): self
    {
        $missingKeys = \array_diff(static::$requiredKeys, \array_keys($claims));

        if (0 !== \count($missingKeys)) {
            throw new InvalidArgumentException('Invalid client metadata. Missing keys: ' . \implode(', ', $missingKeys));
        }

        return new self($claims['client_id'], $claims);
    }

    public function getClientId(): string
    {
        return $this->claims['client_id'];
    }

    public function getClientSecret(): ?string
    {
        return $this->claims['client_secret'] ?? null;
    }

    public function getRedirectUris(): array
    {
        return $this->claims['redirect_uris'] ?? [];
    }

    public function getResponseTypes(): array
    {
        return $this->claims['response_types'] ?? ['code'];
    }

    public function getTokenEndpointAuthMethod(): string
    {
        return $this->claims['token_endpoint_auth_method'];
    }

    public function getAuthorizationSignedResponseAlg(): ?string
    {
        return $this->claims['authorization_signed_response_alg'] ?? null;
    }

    public function getAuthorizationEncryptedResponseAlg(): ?string
    {
        return $this->claims['authorization_encrypted_response_alg'] ?? null;
    }

    public function getAuthorizationEncryptedResponseEnc(): ?string
    {
        return $this->claims['authorization_encrypted_response_enc'] ?? null;
    }

    public function getIdTokenSignedResponseAlg(): string
    {
        return $this->claims['id_token_signed_response_alg'];
    }

    public function getIdTokenEncryptedResponseAlg(): ?string
    {
        return $this->claims['id_token_encrypted_response_alg'] ?? null;
    }

    public function getIdTokenEncryptedResponseEnc(): ?string
    {
        return $this->claims['id_token_encrypted_response_enc'] ?? null;
    }

    public function getUserinfoSignedResponseAlg(): ?string
    {
        return $this->claims['userinfo_signed_response_alg'] ?? null;
    }

    public function getUserinfoEncryptedResponseAlg(): ?string
    {
        return $this->claims['userinfo_encrypted_response_alg'] ?? null;
    }

    public function getUserinfoEncryptedResponseEnc(): ?string
    {
        return $this->claims['userinfo_encrypted_response_enc'] ?? null;
    }

    public function getRequestObjectSigningAlg(): ?string
    {
        return $this->claims['request_object_signing_alg'] ?? null;
    }

    public function getRequestObjectEncryptionAlg(): ?string
    {
        return $this->claims['request_object_encryption_alg'] ?? null;
    }

    public function getRequestObjectEncryptionEnc(): ?string
    {
        return $this->claims['request_object_encryption_enc'] ?? null;
    }

    public function getIntrospectionEndpointAuthMethod(): string
    {
        return $this->claims['introspection_endpoint_auth_method'] ?? $this->getTokenEndpointAuthMethod();
    }

    public function getRevocationEndpointAuthMethod(): string
    {
        return $this->claims['revocation_endpoint_auth_method'] ?? $this->getTokenEndpointAuthMethod();
    }

    /**
     * @return array<string, mixed>
     */
    private function getFilteredClaims(): array
    {
        return \array_filter($this->claims, static function ($value, string $key) {
            return \array_key_exists($key, static::$requiredKeys)

                || $value !== (static::$defaults[$key] ?? null);

        }, \ARRAY_FILTER_USE_BOTH);
    }

    /**
     * @return array<string, mixed>
     */
    public function jsonSerialize(): array
    {
        return $this->getFilteredClaims();
    }

    /**
     * @param string $name
     *
     * @return bool
     */
    public function has(string $name): bool
    {
        return \array_key_exists($name, $this->claims);
    }

    /**
     * @param string $name
     *
     * @return mixed|null
     */
    public function get(string $name)
    {
        return $this->claims[$name] ?? null;
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace TMV\OpenIdClient\Model;
6
7		use TMV\OpenIdClient\Exception\InvalidArgumentException;
8
9		class ClientMetadata implements ClientMetadataInterface
10		{
11		/**
12		* @var array
13		*/
14		private $claims;
15
16		private static $requiredKeys = [
17		'client_id',
18		];
19
20		private static $defaults = [
21		'client_id' => null,
22		'redirect_uris' => [],
23		'client_secret' => null,
24		'jwks' => null,
25		'jwks_uri' => null,
26		'id_token_signed_response_alg' => 'RS256',
27		'id_token_encrypted_response_alg' => null,
28		'id_token_encrypted_response_enc' => null,
29		'userinfo_signed_response_alg' => null,
30		'userinfo_encrypted_response_alg' => null,
31		'userinfo_encrypted_response_enc' => null,
32		'response_types' => ['code'],
33		'post_logout_redirect_uris' => [],
34		'require_auth_time' => false,
35		'request_object_signing_alg' => null,
36		'request_object_encryption_alg' => null,
37		'request_object_encryption_enc' => null,
38		'token_endpoint_auth_method' => 'client_secret_basic',
39		//'introspection_endpoint_auth_method' => 'client_secret_basic',
40		//'revocation_endpoint_auth_method' => 'client_secret_basic',
41		'token_endpoint_auth_signing_alg' => null,
42		'introspection_endpoint_auth_signing_alg' => null,
43		'revocation_endpoint_auth_signing_alg' => null,
44		'tls_client_certificate_bound_access_tokens' => false,
45		];
46
47		/**
48		* IssuerMetadata constructor.
49		*
50		* @param string $clientId
51		* @param array<string, mixed> $claims
52		*/
53	19	public function __construct(string $clientId, $claims = [])
54		{
55		$requiredClaims = [
56	19	'client_id' => $clientId,
57		];
58
59	19	$defaults = static::$defaults;
		0 ignored issues – show Bug introduced 2019-07-04 16:00 UTC by Report Bug Copy Issue Report Since `$defaults` is declared private, accessing it with `static` will lead to errors in possible sub-classes; you can either use `self`, or increase the visibility of `$defaults` to at least protected. Loading history...
60
61	19	$this->claims = \array_merge($defaults, $claims, $requiredClaims);
62	19	}
63
64	2	public static function fromClaims(array $claims): self
65		{
66	2	$missingKeys = \array_diff(static::$requiredKeys, \array_keys($claims));
		0 ignored issues – show Bug introduced 2019-07-04 16:00 UTC by Report Bug Copy Issue Report Since `$requiredKeys` is declared private, accessing it with `static` will lead to errors in possible sub-classes; you can either use `self`, or increase the visibility of `$requiredKeys` to at least protected. Loading history...
67	2	if (0 !== \count($missingKeys)) {
68	1	throw new InvalidArgumentException('Invalid client metadata. Missing keys: ' . \implode(', ', $missingKeys));
69		}
70
71	1	return new self($claims['client_id'], $claims);
72		}
73
74	2	public function getClientId(): string
75		{
76	2	return $this->claims['client_id'];
77		}
78
79	1	public function getClientSecret(): ?string
80		{
81	1	return $this->claims['client_secret'] ?? null;
82		}
83
84	1	public function getRedirectUris(): array
85		{
86	1	return $this->claims['redirect_uris'] ?? [];
87		}
88
89		public function getResponseTypes(): array
90		{
91		return $this->claims['response_types'] ?? ['code'];
92		}
93
94	4	public function getTokenEndpointAuthMethod(): string
95		{
96	4	return $this->claims['token_endpoint_auth_method'];
97		}
98
99	1	public function getAuthorizationSignedResponseAlg(): ?string
100		{
101	1	return $this->claims['authorization_signed_response_alg'] ?? null;
102		}
103
104	1	public function getAuthorizationEncryptedResponseAlg(): ?string
105		{
106	1	return $this->claims['authorization_encrypted_response_alg'] ?? null;
107		}
108
109	1	public function getAuthorizationEncryptedResponseEnc(): ?string
110		{
111	1	return $this->claims['authorization_encrypted_response_enc'] ?? null;
112		}
113
114		public function getIdTokenSignedResponseAlg(): string
115		{
116		return $this->claims['id_token_signed_response_alg'];
117		}
118
119		public function getIdTokenEncryptedResponseAlg(): ?string
120		{
121		return $this->claims['id_token_encrypted_response_alg'] ?? null;
122		}
123
124		public function getIdTokenEncryptedResponseEnc(): ?string
125		{
126		return $this->claims['id_token_encrypted_response_enc'] ?? null;
127		}
128
129	1	public function getUserinfoSignedResponseAlg(): ?string
130		{
131	1	return $this->claims['userinfo_signed_response_alg'] ?? null;
132		}
133
134	1	public function getUserinfoEncryptedResponseAlg(): ?string
135		{
136	1	return $this->claims['userinfo_encrypted_response_alg'] ?? null;
137		}
138
139	1	public function getUserinfoEncryptedResponseEnc(): ?string
140		{
141	1	return $this->claims['userinfo_encrypted_response_enc'] ?? null;
142		}
143
144	1	public function getRequestObjectSigningAlg(): ?string
145		{
146	1	return $this->claims['request_object_signing_alg'] ?? null;
147		}
148
149	1	public function getRequestObjectEncryptionAlg(): ?string
150		{
151	1	return $this->claims['request_object_encryption_alg'] ?? null;
152		}
153
154	1	public function getRequestObjectEncryptionEnc(): ?string
155		{
156	1	return $this->claims['request_object_encryption_enc'] ?? null;
157		}
158
159	1	public function getIntrospectionEndpointAuthMethod(): string
160		{
161	1	return $this->claims['introspection_endpoint_auth_method'] ?? $this->getTokenEndpointAuthMethod();
162		}
163
164	1	public function getRevocationEndpointAuthMethod(): string
165		{
166	1	return $this->claims['revocation_endpoint_auth_method'] ?? $this->getTokenEndpointAuthMethod();
167		}
168
169		/**
170		* @return array<string, mixed>
171		*/
172	1	private function getFilteredClaims(): array
173		{
174		return \array_filter($this->claims, static function ($value, string $key) {
175	1	return \array_key_exists($key, static::$requiredKeys)
		0 ignored issues – show Bug introduced 2019-07-04 16:00 UTC by Report Bug Copy Issue Report Since `$requiredKeys` is declared private, accessing it with `static` will lead to errors in possible sub-classes; you can either use `self`, or increase the visibility of `$requiredKeys` to at least protected. Loading history...
176	1	\|\| $value !== (static::$defaults[$key] ?? null);
		0 ignored issues – show Bug introduced 2019-07-04 16:00 UTC by Report Bug Copy Issue Report Since `$defaults` is declared private, accessing it with `static` will lead to errors in possible sub-classes; you can either use `self`, or increase the visibility of `$defaults` to at least protected. Loading history...
177	1	}, \ARRAY_FILTER_USE_BOTH);
178		}
179
180		/**
181		* @return array<string, mixed>
182		*/
183	1	public function jsonSerialize(): array
184		{
185	1	return $this->getFilteredClaims();
186		}
187
188		/**
189		* @param string $name
190		*
191		* @return bool
192		*/
193	1	public function has(string $name): bool
194		{
195	1	return \array_key_exists($name, $this->claims);
196		}
197
198		/**
199		* @param string $name
200		*
201		* @return mixed\|null
202		*/
203	2	public function get(string $name)
204		{
205	2	return $this->claims[$name] ?? null;
206		}
207		}
208

thomasvargiu / php-openid-client

Push — master ( 898cc7...450add )

ClientMetadata::jsonSerialize() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like