ClientGrantTrait::clientSetIntegration() - Code Metrics - limoncello-php-dist/oauth-server - Measure and Improve Code Quality continuously with Scrutinizer

ClientGrantTrait::clientSetIntegration() A
last analyzed 2019-06-17 07:44 UTC

↳ Parent: ClientGrantTrait

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php declare(strict_types=1);

namespace Limoncello\OAuthServer\GrantTraits;

/**
 * Copyright 2015-2019 [email protected]
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

use Limoncello\OAuthServer\Contracts\ClientInterface;
use Limoncello\OAuthServer\Contracts\Integration\ClientIntegrationInterface;
use Limoncello\OAuthServer\Exceptions\OAuthTokenBodyException;
use Psr\Http\Message\ResponseInterface;
use function array_key_exists;
use function explode;
use function is_string;

/**
 * @package Limoncello\OAuthServer
 *
 * @link https://tools.ietf.org/html/rfc6749#section-1.3
 * @link https://tools.ietf.org/html/rfc6749#section-4.4
 */
trait ClientGrantTrait
{
    /**
     * @var ClientIntegrationInterface
     */
    private $clientIntegration;

    /**
     * @return ClientIntegrationInterface
     */
    protected function clientGetIntegration(): ClientIntegrationInterface
    {
        return $this->clientIntegration;
    }

    /**
     * @param ClientIntegrationInterface $clientIntegration
     *
     * @return void
     */
    public function clientSetIntegration(ClientIntegrationInterface $clientIntegration): void
    {
        $this->clientIntegration = $clientIntegration;
    }

    /**
     * @param string[] $parameters
     *
     * @return string[]|null

     */
    protected function clientGetScope(array $parameters): ?array
    {
        $scope = $this->clientReadStringValue($parameters, 'scope');

        return empty($scope) === false ? explode(' ', $scope) : null;
    }

    /**
     * @param string[]        $parameters
     * @param ClientInterface $determinedClient
     *
     * @return ResponseInterface
     */
    protected function clientIssueToken(array $parameters, ClientInterface $determinedClient): ResponseInterface
    {
        if ($determinedClient->isClientGrantEnabled() === false) {
            throw new OAuthTokenBodyException(OAuthTokenBodyException::ERROR_UNAUTHORIZED_CLIENT);
        }

        $scope = $this->clientGetScope($parameters);
        list ($isScopeValid, $scopeList, $isScopeModified) =
            $this->clientGetIntegration()->clientValidateScope($determinedClient, $scope);
        if ($isScopeValid === false) {
            throw new OAuthTokenBodyException(OAuthTokenBodyException::ERROR_INVALID_SCOPE);
        }

        $response = $this->clientGetIntegration()->clientCreateAccessTokenResponse(
            $determinedClient,
            $isScopeModified,
            $scopeList,
            $parameters
        );

        return $response;
    }

    /**
     * @param array  $parameters
     * @param string $name
     *
     * @return null|string
     */
    private function clientReadStringValue(array $parameters, string $name): ?string
    {
        return array_key_exists($name, $parameters) === true && is_string($value = $parameters[$name]) === true ?
            $value : null;
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
    }
}


1		<?php declare(strict_types=1);
2
3		namespace Limoncello\OAuthServer\GrantTraits;
4
5		/**
6		* Copyright 2015-2019 [email protected]
7		*
8		* Licensed under the Apache License, Version 2.0 (the "License");
9		* you may not use this file except in compliance with the License.
10		* You may obtain a copy of the License at
11		*
12		* http://www.apache.org/licenses/LICENSE-2.0
13		*
14		* Unless required by applicable law or agreed to in writing, software
15		* distributed under the License is distributed on an "AS IS" BASIS,
16		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17		* See the License for the specific language governing permissions and
18		* limitations under the License.
19		*/
20
21		use Limoncello\OAuthServer\Contracts\ClientInterface;
22		use Limoncello\OAuthServer\Contracts\Integration\ClientIntegrationInterface;
23		use Limoncello\OAuthServer\Exceptions\OAuthTokenBodyException;
24		use Psr\Http\Message\ResponseInterface;
25		use function array_key_exists;
26		use function explode;
27		use function is_string;
28
29		/**
30		* @package Limoncello\OAuthServer
31		*
32		* @link https://tools.ietf.org/html/rfc6749#section-1.3
33		* @link https://tools.ietf.org/html/rfc6749#section-4.4
34		*/
35		trait ClientGrantTrait
36		{
37		/**
38		* @var ClientIntegrationInterface
39		*/
40	3	private $clientIntegration;
41
42	3	/**
43		* @return ClientIntegrationInterface
44		*/
45		protected function clientGetIntegration(): ClientIntegrationInterface
46		{
47		return $this->clientIntegration;
48		}
49
50	44	/**
51		* @param ClientIntegrationInterface $clientIntegration
52	44	*
53		* @return void
54		*/
55		public function clientSetIntegration(ClientIntegrationInterface $clientIntegration): void
56		{
57		$this->clientIntegration = $clientIntegration;
58		}
59
60	3	/**
61		* @param string[] $parameters
62	3	*
63		* @return string[]\|null
		0 ignored issues – show Documentation introduced 2017-08-15 18:29 UTC by Report Bug Copy Issue Report Should the return type not be `array\|null`? Also, consider making the array more specific, something like `array<String>`, or `String[]`. This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. If the return type contains the type array, this check recommends the use of a more specific type like `String[]` or `array<String>`. Loading history...
64	3	*/
65		protected function clientGetScope(array $parameters): ?array
66		{
67		$scope = $this->clientReadStringValue($parameters, 'scope');
68
69		return empty($scope) === false ? explode(' ', $scope) : null;
70		}
71
72		/**
73	4	* @param string[] $parameters
74		* @param ClientInterface $determinedClient
75	4	*
76	1	* @return ResponseInterface
77		*/
78		protected function clientIssueToken(array $parameters, ClientInterface $determinedClient): ResponseInterface
79	3	{
80		if ($determinedClient->isClientGrantEnabled() === false) {
81	3	throw new OAuthTokenBodyException(OAuthTokenBodyException::ERROR_UNAUTHORIZED_CLIENT);
82	3	}
83	1
84		$scope = $this->clientGetScope($parameters);
85		list ($isScopeValid, $scopeList, $isScopeModified) =
86	2	$this->clientGetIntegration()->clientValidateScope($determinedClient, $scope);
87	2	if ($isScopeValid === false) {
88	2	throw new OAuthTokenBodyException(OAuthTokenBodyException::ERROR_INVALID_SCOPE);
89	2	}
90	2
91		$response = $this->clientGetIntegration()->clientCreateAccessTokenResponse(
92		$determinedClient,
93	2	$isScopeModified,
94		$scopeList,
95		$parameters
96		);
97
98		return $response;
99		}
100
101		/**
102	3	* @param array $parameters
103		* @param string $name
104	3	*
105	3	* @return null\|string
106		*/
107		private function clientReadStringValue(array $parameters, string $name): ?string
108		{
109		return array_key_exists($name, $parameters) === true && is_string($value = $parameters[$name]) === true ?
110		$value : null;
		0 ignored issues – show Bug introduced 2017-05-30 15:57 UTC by Report Bug Copy Issue Report The variable `$value` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
111		}
112		}
113

limoncello-php-dist / oauth-server

ClientGrantTrait::clientSetIntegration() A last analyzed 2019-06-17 07:44 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like

ClientGrantTrait::clientSetIntegration() A
last analyzed 2019-06-17 07:44 UTC