MetadataBuilder::__construct() - Code Metrics - Inspection of "Metadata" - OAuth2-Framework/oauth2-framework - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Pull Request — master (#37)

by Florent

created 2017-04-12 11:55 UTC

MetadataBuilder::__construct() A

↳ Parent: MetadataBuilder

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	5
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	3
nc	1
nop	1

<?php

declare(strict_types=1);

/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2014-2017 Spomky-Labs
 *
 * This software may be modified and distributed under the terms
 * of the MIT license.  See the LICENSE file for details.
 */

namespace OAuth2Framework\Bundle\Server\Service;

use OAuth2Framework\Bundle\Server\TokenEndpointAuthMethod\ClientAssertionJwt;
use OAuth2Framework\Component\Server\Endpoint\Authorization\AuthorizationRequestLoader;
use OAuth2Framework\Component\Server\Endpoint\UserInfo\UserInfo;
use OAuth2Framework\Component\Server\GrantType\GrantTypeManager;
use OAuth2Framework\Component\Server\GrantType\PKCEMethod\PKCEMethodManager;
use OAuth2Framework\Component\Server\Model\Scope\ScopeRepositoryInterface;
use OAuth2Framework\Component\Server\ResponseMode\ResponseModeManager;
use OAuth2Framework\Component\Server\ResponseType\ResponseTypeManager;
use OAuth2Framework\Component\Server\TokenEndpointAuthMethod\TokenEndpointAuthMethodManager;
use Symfony\Component\Routing\RouterInterface;
use OAuth2Framework\Component\Server\Endpoint\Metadata\Metadata;
.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php

final class MetadataBuilder
{
    /**
     * @var RouterInterface
     */
    private $router;

    /**
     * @var Metadata
     */
    private $metadata;

    /**
     * MetadataBuilder constructor.
     *
     * @param RouterInterface $router
     */
    public function __construct(RouterInterface $router)
    {
        $this->router = $router;
        $this->metadata = new Metadata();
    }

    /**
     * @return Metadata
     */
    public function getMetadata(): Metadata
    {
        return $this->metadata;
    }

    /**
     * @param string $name
     * @param string $routeName
     * @param array  $routeParameters
     */
    public function setRoute(string $name, string $routeName, array $routeParameters = [])
    {
        $path = $this->router->generate($routeName, $routeParameters, RouterInterface::ABSOLUTE_URL);
        $this->metadata->set($name, $path);

        /*

        $this->metadata->set('service_documentation', 'https://my.server.com/documentation');
        $this->metadata->set('op_policy_uri', 'https://my.server.com/policy.html');
        $this->metadata->set('op_tos_uri', 'https://my.server.com/tos.html');
        */
    }

    /**
     * @param PKCEMethodManager $PKCEMethodManager
     */
    public function setCodeChallengeMethodsSupported(PKCEMethodManager $PKCEMethodManager)
    {
        $this->metadata->set('code_challenge_methods_supported', $PKCEMethodManager->names());
    }

    /**
     * @param ClientAssertionJwt $clientAssertionJwt
     */
    public function setClientAssertionJwt(ClientAssertionJwt $clientAssertionJwt)
    {
        $this->metadata->set('token_endpoint_auth_signing_alg_values_supported', $clientAssertionJwt->getSupportedSignatureAlgorithms());
        $this->metadata->set('token_endpoint_auth_encryption_alg_values_supported', $clientAssertionJwt->getSupportedKeyEncryptionAlgorithms());
        $this->metadata->set('token_endpoint_auth_encryption_enc_values_supported', $clientAssertionJwt->getSupportedContentEncryptionAlgorithms());
    }

    /**
     * @param GrantTypeManager $grantTypeManager
     */
    public function setGrantTypeManager(GrantTypeManager $grantTypeManager)
    {
        $this->metadata->set('grant_types_supported', $grantTypeManager->getSupportedGrantTypes());
    }

    /**
     * @param ResponseTypeManager $responseTypeManager
     */
    public function setResponseTypeManager(ResponseTypeManager $responseTypeManager)
    {
        $this->metadata->set('response_types_supported', $responseTypeManager->all());
    }

    /**
     * @param ResponseModeManager $responseModeManager
     */
    public function setResponseModeManager(ResponseModeManager $responseModeManager)
    {
        $this->metadata->set('response_modes_supported', $responseModeManager->all());
    }

    /**
     * @param TokenEndpointAuthMethodManager $tokenEndpointAuthMethodManager
     */
    public function setTokenEndpointAuthMethodManager(TokenEndpointAuthMethodManager $tokenEndpointAuthMethodManager)
    {
        $this->metadata->set('token_endpoint_auth_methods_supported', $tokenEndpointAuthMethodManager->all());
    }

    /**
     * @param ScopeRepositoryInterface $scopeRepository
     */
    public function setScopeRepository(ScopeRepositoryInterface $scopeRepository)
    {
        $this->metadata->set('scopes_supported', $scopeRepository->getSupportedScopes());
    }

    /**
     * @param UserInfo $userInfo
     */
    public function setUserinfo(UserInfo $userInfo)
    {
        $this->metadata->set('subject_types_supported', $userInfo->isPairwiseSubjectIdentifierSupported() ? ['public', 'pairwise'] : ['public']);
    }

    /**
     * @param string $name
     * @param mixed  $value
     */
    public function addKeyValuePair(string $name, $value)
    {
        $this->metadata->set($name, $value);
        /*

        $this->metadata->set('acr_values_supported', []);
        $this->metadata->set('display_values_supported', ['page']);
        $this->metadata->set('claim_types_supported', false);
        $this->metadata->set('ui_locales_supported', ['en_US', 'fr_FR']);
        $this->metadata->set('claims_parameter_supported', false);
        */
    }

    /**
     * @param AuthorizationRequestLoader $authorizationRequestLoader
     */
    public function setAuthorizationRequestLoader(AuthorizationRequestLoader $authorizationRequestLoader)
    {
        $this->metadata->set('request_parameter_supported', $authorizationRequestLoader->isRequestObjectSupportEnabled());
        $this->metadata->set('request_uri_parameter_supported', $authorizationRequestLoader->isRequestObjectReferenceSupportEnabled());
        $this->metadata->set('require_request_uri_registration', $authorizationRequestLoader->isRequestUriRegistrationRequired());
        $this->metadata->set('request_object_signing_alg_values_supported', $authorizationRequestLoader->getSupportedSignatureAlgorithms());
        $this->metadata->set('request_object_encryption_alg_values_supported', $authorizationRequestLoader->getSupportedKeyEncryptionAlgorithms());
        $this->metadata->set('request_object_encryption_enc_values_supported', $authorizationRequestLoader->getSupportedContentEncryptionAlgorithms());
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/*
6			* The MIT License (MIT)
7			*
8			* Copyright (c) 2014-2017 Spomky-Labs
9			*
10			* This software may be modified and distributed under the terms
11			* of the MIT license. See the LICENSE file for details.
12			*/
13
14			namespace OAuth2Framework\Bundle\Server\Service;
15
16			use OAuth2Framework\Bundle\Server\TokenEndpointAuthMethod\ClientAssertionJwt;
17			use OAuth2Framework\Component\Server\Endpoint\Authorization\AuthorizationRequestLoader;
18			use OAuth2Framework\Component\Server\Endpoint\UserInfo\UserInfo;
19			use OAuth2Framework\Component\Server\GrantType\GrantTypeManager;
20			use OAuth2Framework\Component\Server\GrantType\PKCEMethod\PKCEMethodManager;
21			use OAuth2Framework\Component\Server\Model\Scope\ScopeRepositoryInterface;
22			use OAuth2Framework\Component\Server\ResponseMode\ResponseModeManager;
23			use OAuth2Framework\Component\Server\ResponseType\ResponseTypeManager;
24			use OAuth2Framework\Component\Server\TokenEndpointAuthMethod\TokenEndpointAuthMethodManager;
25			use Symfony\Component\Routing\RouterInterface;
26			use OAuth2Framework\Component\Server\Endpoint\Metadata\Metadata;
			0 ignored issues – show Bug introduced 2017-04-12 12:03 UTC by Report Bug Copy Issue Report This use statement conflicts with another class in this namespace, `OAuth2Framework\Bundle\Server\Service\Metadata`. Let’s assume that you have a directory layout like this: . \|-- OtherDir \| \|-- Bar.php \| `-- Foo.php `-- SomeDir `-- Foo.php and let’s assume the following content of `Bar.php`: // Bar.php namespace OtherDir; use SomeDir\Foo; // This now conflicts the class OtherDir\Foo If both files `OtherDir/Foo.php` and `SomeDir/Foo.php` are loaded in the same runtime, you will see a PHP error such as the following: PHP Fatal error: Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php However, as `OtherDir/Foo.php` does not necessarily have to be loaded and the error is only triggered if it is loaded before `OtherDir/Bar.php`, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias: // Bar.php namespace OtherDir; use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore. Loading history...
27
28			final class MetadataBuilder
29			{
30			/**
31			* @var RouterInterface
32			*/
33			private $router;
34
35			/**
36			* @var Metadata
37			*/
38			private $metadata;
39
40			/**
41			* MetadataBuilder constructor.
42			*
43			* @param RouterInterface $router
44			*/
45			public function __construct(RouterInterface $router)
46			{
47			$this->router = $router;
48			$this->metadata = new Metadata();
49			}
50
51			/**
52			* @return Metadata
53			*/
54			public function getMetadata(): Metadata
55			{
56			return $this->metadata;
57			}
58
59			/**
60			* @param string $name
61			* @param string $routeName
62			* @param array $routeParameters
63			*/
64			public function setRoute(string $name, string $routeName, array $routeParameters = [])
65			{
66			$path = $this->router->generate($routeName, $routeParameters, RouterInterface::ABSOLUTE_URL);
67			$this->metadata->set($name, $path);
68
69			/*
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-04-12 12:03 UTC by Report Bug Copy Issue Report `70%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
70			$this->metadata->set('service_documentation', 'https://my.server.com/documentation');
71			$this->metadata->set('op_policy_uri', 'https://my.server.com/policy.html');
72			$this->metadata->set('op_tos_uri', 'https://my.server.com/tos.html');
73			*/
74			}
75
76			/**
77			* @param PKCEMethodManager $PKCEMethodManager
78			*/
79			public function setCodeChallengeMethodsSupported(PKCEMethodManager $PKCEMethodManager)
80			{
81			$this->metadata->set('code_challenge_methods_supported', $PKCEMethodManager->names());
82			}
83
84			/**
85			* @param ClientAssertionJwt $clientAssertionJwt
86			*/
87			public function setClientAssertionJwt(ClientAssertionJwt $clientAssertionJwt)
88			{
89			$this->metadata->set('token_endpoint_auth_signing_alg_values_supported', $clientAssertionJwt->getSupportedSignatureAlgorithms());
90			$this->metadata->set('token_endpoint_auth_encryption_alg_values_supported', $clientAssertionJwt->getSupportedKeyEncryptionAlgorithms());
91			$this->metadata->set('token_endpoint_auth_encryption_enc_values_supported', $clientAssertionJwt->getSupportedContentEncryptionAlgorithms());
92			}
93
94			/**
95			* @param GrantTypeManager $grantTypeManager
96			*/
97			public function setGrantTypeManager(GrantTypeManager $grantTypeManager)
98			{
99			$this->metadata->set('grant_types_supported', $grantTypeManager->getSupportedGrantTypes());
100			}
101
102			/**
103			* @param ResponseTypeManager $responseTypeManager
104			*/
105			public function setResponseTypeManager(ResponseTypeManager $responseTypeManager)
106			{
107			$this->metadata->set('response_types_supported', $responseTypeManager->all());
108			}
109
110			/**
111			* @param ResponseModeManager $responseModeManager
112			*/
113			public function setResponseModeManager(ResponseModeManager $responseModeManager)
114			{
115			$this->metadata->set('response_modes_supported', $responseModeManager->all());
116			}
117
118			/**
119			* @param TokenEndpointAuthMethodManager $tokenEndpointAuthMethodManager
120			*/
121			public function setTokenEndpointAuthMethodManager(TokenEndpointAuthMethodManager $tokenEndpointAuthMethodManager)
122			{
123			$this->metadata->set('token_endpoint_auth_methods_supported', $tokenEndpointAuthMethodManager->all());
124			}
125
126			/**
127			* @param ScopeRepositoryInterface $scopeRepository
128			*/
129			public function setScopeRepository(ScopeRepositoryInterface $scopeRepository)
130			{
131			$this->metadata->set('scopes_supported', $scopeRepository->getSupportedScopes());
132			}
133
134			/**
135			* @param UserInfo $userInfo
136			*/
137			public function setUserinfo(UserInfo $userInfo)
138			{
139			$this->metadata->set('subject_types_supported', $userInfo->isPairwiseSubjectIdentifierSupported() ? ['public', 'pairwise'] : ['public']);
140			}
141
142			/**
143			* @param string $name
144			* @param mixed $value
145			*/
146			public function addKeyValuePair(string $name, $value)
147			{
148			$this->metadata->set($name, $value);
149			/*
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-04-12 12:03 UTC by Report Bug Copy Issue Report `72%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
150			$this->metadata->set('acr_values_supported', []);
151			$this->metadata->set('display_values_supported', ['page']);
152			$this->metadata->set('claim_types_supported', false);
153			$this->metadata->set('ui_locales_supported', ['en_US', 'fr_FR']);
154			$this->metadata->set('claims_parameter_supported', false);
155			*/
156			}
157
158			/**
159			* @param AuthorizationRequestLoader $authorizationRequestLoader
160			*/
161			public function setAuthorizationRequestLoader(AuthorizationRequestLoader $authorizationRequestLoader)
162			{
163			$this->metadata->set('request_parameter_supported', $authorizationRequestLoader->isRequestObjectSupportEnabled());
164			$this->metadata->set('request_uri_parameter_supported', $authorizationRequestLoader->isRequestObjectReferenceSupportEnabled());
165			$this->metadata->set('require_request_uri_registration', $authorizationRequestLoader->isRequestUriRegistrationRequired());
166			$this->metadata->set('request_object_signing_alg_values_supported', $authorizationRequestLoader->getSupportedSignatureAlgorithms());
167			$this->metadata->set('request_object_encryption_alg_values_supported', $authorizationRequestLoader->getSupportedKeyEncryptionAlgorithms());
168			$this->metadata->set('request_object_encryption_enc_values_supported', $authorizationRequestLoader->getSupportedContentEncryptionAlgorithms());
169			}
170			}
171

OAuth2-Framework / oauth2-framework

Pull Request — master (#37)

MetadataBuilder::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like