Configuration::isRevokeRotatedRefreshToken() - Code Metrics - Inspection of "Add getter for configuration" - platine-php/oauth2 - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — develop ( e406ab...abebfb )

by nguereza

created 2023-07-30 11:19 UTC

Configuration::isRevokeRotatedRefreshToken() A

↳ Parent: Configuration

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

/**
 * Platine OAuth2
 *
 * Platine OAuth2 is a library that implements the OAuth2 specification
 *
 * This content is released under the MIT License (MIT)
 *
 * Copyright (c) 2020 Platine OAuth2
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

/**
 *  @file Configuration.php
 *
 *  The OAuth2 Configuration class
 *
 *  @package    Platine\OAuth2
 *  @author Platine Developers Team
 *  @copyright  Copyright (c) 2020
 *  @license    http://opensource.org/licenses/MIT  MIT License
 *  @link   http://www.iacademy.cf
 *  @version 1.0.0
 *  @filesource
 */

declare(strict_types=1);

namespace Platine\OAuth2;

use Platine\Stdlib\Config\AbstractConfiguration;

/**
 * @class Configuration
 * @package Platine\OAuth2
 */
class Configuration extends AbstractConfiguration
{
    /**
     * Return the access token request attribute value
     * @return string
     */
    public function getTokenRequestAttribute(): string
    {
        return $this->get('request_attribute.token');

    }

    /**
     * Return the owner request attribute value
     * @return string
     */
    public function getOwnerRequestAttribute(): string
    {
        return $this->get('request_attribute.owner');

    }

    /**
     * Return the authorization code TTL value
     * @return int
     */
    public function getAuthorizationCodeTtl(): int
    {
        return $this->get('ttl.authorization_code');

    }

    /**
     * Return the access token TTL value
     * @return int
     */
    public function getAccessTokenTtl(): int
    {
        return $this->get('ttl.access_token');

    }

    /**
     * Return the refresh token TTL value
     * @return int
     */
    public function getRefreshTokenTtl(): int
    {
        return $this->get('ttl.refresh_token');

    }

    /**
     * Whether need rotate refresh token
     * @return bool
     */
    public function isRotateRefreshToken(): bool
    {
        return $this->get('rotate_refresh_token');

    }

    /**
     * Whether need rotate refresh token after revocation
     * @return bool
     */
    public function isRevokeRotatedRefreshToken(): bool
    {
        return $this->get('revoke_rotated_refresh_token');

    }

    /**
     * Return the supported grants
     * @return array<int, string>
     */
    public function getGrants(): array
    {
        return $this->get('grants');

    }

    /**
     * {@inheritdoc}
     */
    public function getValidationRules(): array
    {
        return [
            'request_attribute' => 'array',
            'request_attribute.token' => 'string',
            'request_attribute.owner' => 'string',
            'ttl' => 'array',
            'ttl.authorization_code' => 'integer',
            'ttl.access_token' => 'integer',
            'ttl.refresh_token' => 'integer',
            'rotate_refresh_token' => 'boolean',
            'revoke_rotated_refresh_token' => 'boolean',
            'grants' => 'array'
        ];
    }

    /**
     * {@inheritdoc}
     */
    public function getDefault(): array
    {
        return [
            'grants' => [],
            'ttl' => [
                'authorization_code' => 120,
                'access_token' => 3600,
                'refresh_token' => 86400,
            ],
            'rotate_refresh_token' => false,
            'revoke_rotated_refresh_token' => true,
            'request_attribute' => [
                'token' => 'oauth_token',
                'owner' => 'owner',
            ],
        ];
    }
}


1			<?php
2
3			/**
4			* Platine OAuth2
5			*
6			* Platine OAuth2 is a library that implements the OAuth2 specification
7			*
8			* This content is released under the MIT License (MIT)
9			*
10			* Copyright (c) 2020 Platine OAuth2
11			*
12			* Permission is hereby granted, free of charge, to any person obtaining a copy
13			* of this software and associated documentation files (the "Software"), to deal
14			* in the Software without restriction, including without limitation the rights
15			* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
16			* copies of the Software, and to permit persons to whom the Software is
17			* furnished to do so, subject to the following conditions:
18			*
19			* The above copyright notice and this permission notice shall be included in all
20			* copies or substantial portions of the Software.
21			*
22			* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
23			* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
24			* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
25			* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
26			* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
27			* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
28			* SOFTWARE.
29			*/
30
31			/**
32			* @file Configuration.php
33			*
34			* The OAuth2 Configuration class
35			*
36			* @package Platine\OAuth2
37			* @author Platine Developers Team
38			* @copyright Copyright (c) 2020
39			* @license http://opensource.org/licenses/MIT MIT License
40			* @link http://www.iacademy.cf
41			* @version 1.0.0
42			* @filesource
43			*/
44
45			declare(strict_types=1);
46
47			namespace Platine\OAuth2;
48
49			use Platine\Stdlib\Config\AbstractConfiguration;
50
51			/**
52			* @class Configuration
53			* @package Platine\OAuth2
54			*/
55			class Configuration extends AbstractConfiguration
56			{
57			/**
58			* Return the access token request attribute value
59			* @return string
60			*/
61			public function getTokenRequestAttribute(): string
62			{
63			return $this->get('request_attribute.token');
			0 ignored issues – show Bug Best Practice introduced 2023-07-30 11:20 UTC by Report Bug Copy Issue Report The expression `return $this->get('request_attribute.token')` could return the type `null` which is incompatible with the type-hinted return `string`. Consider adding an additional type-check to rule them out. Loading history...
64			}
65
66			/**
67			* Return the owner request attribute value
68			* @return string
69			*/
70			public function getOwnerRequestAttribute(): string
71			{
72			return $this->get('request_attribute.owner');
			0 ignored issues – show Bug Best Practice introduced 2023-07-30 11:20 UTC by Report Bug Copy Issue Report The expression `return $this->get('request_attribute.owner')` could return the type `null` which is incompatible with the type-hinted return `string`. Consider adding an additional type-check to rule them out. Loading history...
73			}
74
75			/**
76			* Return the authorization code TTL value
77			* @return int
78			*/
79			public function getAuthorizationCodeTtl(): int
80			{
81			return $this->get('ttl.authorization_code');
			0 ignored issues – show Bug Best Practice introduced 2023-07-30 11:20 UTC by Report Bug Copy Issue Report The expression `return $this->get('ttl.authorization_code')` could return the type `null` which is incompatible with the type-hinted return `integer`. Consider adding an additional type-check to rule them out. Loading history...
82			}
83
84			/**
85			* Return the access token TTL value
86			* @return int
87			*/
88			public function getAccessTokenTtl(): int
89			{
90			return $this->get('ttl.access_token');
			0 ignored issues – show Bug Best Practice introduced 2023-07-30 11:20 UTC by Report Bug Copy Issue Report The expression `return $this->get('ttl.access_token')` could return the type `null` which is incompatible with the type-hinted return `integer`. Consider adding an additional type-check to rule them out. Loading history...
91			}
92
93			/**
94			* Return the refresh token TTL value
95			* @return int
96			*/
97			public function getRefreshTokenTtl(): int
98			{
99			return $this->get('ttl.refresh_token');
			0 ignored issues – show Bug Best Practice introduced 2023-07-30 11:20 UTC by Report Bug Copy Issue Report The expression `return $this->get('ttl.refresh_token')` could return the type `null` which is incompatible with the type-hinted return `integer`. Consider adding an additional type-check to rule them out. Loading history...
100			}
101
102			/**
103			* Whether need rotate refresh token
104			* @return bool
105			*/
106			public function isRotateRefreshToken(): bool
107			{
108			return $this->get('rotate_refresh_token');
			0 ignored issues – show Bug Best Practice introduced 2023-07-30 11:20 UTC by Report Bug Copy Issue Report The expression `return $this->get('rotate_refresh_token')` could return the type `null` which is incompatible with the type-hinted return `boolean`. Consider adding an additional type-check to rule them out. Loading history...
109			}
110
111			/**
112			* Whether need rotate refresh token after revocation
113			* @return bool
114			*/
115			public function isRevokeRotatedRefreshToken(): bool
116			{
117			return $this->get('revoke_rotated_refresh_token');
			0 ignored issues – show Bug Best Practice introduced 2023-07-30 11:20 UTC by Report Bug Copy Issue Report The expression `return $this->get('revoke_rotated_refresh_token')` could return the type `null` which is incompatible with the type-hinted return `boolean`. Consider adding an additional type-check to rule them out. Loading history...
118			}
119
120			/**
121			* Return the supported grants
122			* @return array<int, string>
123			*/
124			public function getGrants(): array
125			{
126			return $this->get('grants');
			0 ignored issues – show Bug Best Practice introduced 2023-07-30 11:20 UTC by Report Bug Copy Issue Report The expression `return $this->get('grants')` could return the type `null` which is incompatible with the type-hinted return `array`. Consider adding an additional type-check to rule them out. Loading history...
127			}
128
129			/**
130			* {@inheritdoc}
131			*/
132			public function getValidationRules(): array
133			{
134			return [
135			'request_attribute' => 'array',
136			'request_attribute.token' => 'string',
137			'request_attribute.owner' => 'string',
138			'ttl' => 'array',
139			'ttl.authorization_code' => 'integer',
140			'ttl.access_token' => 'integer',
141			'ttl.refresh_token' => 'integer',
142			'rotate_refresh_token' => 'boolean',
143			'revoke_rotated_refresh_token' => 'boolean',
144			'grants' => 'array'
145			];
146			}
147
148			/**
149			* {@inheritdoc}
150			*/
151			public function getDefault(): array
152			{
153			return [
154			'grants' => [],
155			'ttl' => [
156			'authorization_code' => 120,
157			'access_token' => 3600,
158			'refresh_token' => 86400,
159			],
160			'rotate_refresh_token' => false,
161			'revoke_rotated_refresh_token' => true,
162			'request_attribute' => [
163			'token' => 'oauth_token',
164			'owner' => 'owner',
165			],
166			];
167			}
168			}
169

platine-php / oauth2

Push — develop ( e406ab...abebfb )

Configuration::isRevokeRotatedRefreshToken() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like