Settings::setIssuer() - Code Metrics - Inspection of "Adding some logic here" - flipboxfactory/craft-jwt - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — develop (8ea255)

by Nate

created 2018-03-21 15:42 UTC

Settings::setIssuer() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php

/**
 * @copyright  Copyright (c) Flipbox Digital Limited
 * @license    https://flipboxfactory.com/software/jwt/license
 * @link       https://www.flipboxfactory.com/jwt/organization/
 */

namespace flipbox\craft\jwt\models;

use Craft;
use Lcobucci\JWT\Signer;
use Lcobucci\JWT\Signer\Hmac\Sha256;
use Lcobucci\JWT\Signer\Hmac\Sha384;
use Lcobucci\JWT\Signer\Hmac\Sha512;
use yii\base\InvalidArgumentException;
use yii\base\Model;

/**
 * @author Flipbox Factory <[email protected]>
 * @since 1.0.0
 */
class Settings extends Model
{
    /**
     * Supported algorithms
     *
     * @var array
     */
    public $algorithms = [
        'HS256' => Sha256::class,
        'HS384' => Sha384::class,
        'HS512' => Sha512::class,
    ];

    /**
     * The selected algorithm
     *
     * @var string
     */
    public $algorithm = 'HS512';

    /**
     * The key used for token signature
     *
     * @var string
     */
    private $key;

    /**
     * The default token Expiration
     * @var int
     */
    public $tokenExpiration = 3600;

    /**
     * The default audience
     *
     * @var string
     */
    private $selfConsumableAudience = null;

    /**
     * The available audiences
     *
     * @var array
     */
    private $selfConsumableIssuers = [];

    /** The default target
     *
     * @var int
     */
    private $issuer = null;

    /**
     * @return string
     */
    public function getKey(): string
    {
        if (empty($this->key)) {
            return Craft::$app->getConfig()->getGeneral()->securityKey;
        }
        return $this->key;
    }

    /**
     * @param array|null $selfConsumableIssuers
     * @return $this
     */
    public function setSelfConsumableIssuers(array $selfConsumableIssuers = [])
    {
        $this->selfConsumableIssuers = $selfConsumableIssuers;
        return $this;
    }

    /**
     * @return array
     * @throws \craft\errors\SiteNotFoundException
     */
    public function getSelfConsumableIssuers(): array
    {
        if (empty($this->selfConsumableIssuers)) {
            return [Craft::$app->getSites()->getCurrentSite()->baseUrl];
        }
        return (array)$this->selfConsumableIssuers;
    }



    /**
     * @param string|null $selfConsumableAudience
     * @return $this
     */
    public function setSelfConsumableAudience(string $selfConsumableAudience = null)
    {
        $this->selfConsumableAudience = $selfConsumableAudience;
        return $this;
    }

    /**
     * @return string
     * @throws \craft\errors\SiteNotFoundException
     */
    public function getSelfConsumableAudience(): string
    {
        if (null === $this->selfConsumableAudience) {
            return Craft::$app->getSites()->getCurrentSite()->baseUrl;
        }
        return (string)$this->selfConsumableAudience;
    }

    /**
     * @param string|null $issuer
     * @return $this
     */
    public function setIssuer(string $issuer = null)
    {
        $this->issuer = $issuer;
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
        return $this;
    }

    /**
     * @return string
     * @throws \craft\errors\SiteNotFoundException
     */
    public function getIssuer(): string
    {
        if (null === $this->issuer) {
            return Craft::$app->getSites()->getCurrentSite()->baseUrl;
        }
        return (string)$this->issuer;
    }

    /**
     * Creates a Signer class based on the configured algorithm
     *
     * @return Signer
     * @throws \yii\base\InvalidConfigException
     */
    public function getSigner(): Signer
    {
        return $this->resolveSigner($this->algorithm);
    }

    /**
     * Resolves a Signer class based on an algorithm key
     *
     * @param $key
     * @return Signer
     * @throws \yii\base\InvalidConfigException
     */
    public function resolveSigner($key): Signer
    {
        if (empty($this->algorithms[$key])) {
            throw new InvalidArgumentException('Algorithm not supported');
        }

        /** @var Signer $signer */
        $signer = Craft::createObject(
            $this->algorithms[$key]
        );

        return $signer;
    }

    /**
     * @inheritdoc
     */
    public function attributes()
    {
        return array_merge(
            parent::attributes(),
            [
                'key',
                'selfConsumableAudience',
                'selfConsumableIssuers',
                'issuer'
            ]
        );
    }
}


1			<?php
2
3			/**
4			* @copyright Copyright (c) Flipbox Digital Limited
5			* @license https://flipboxfactory.com/software/jwt/license
6			* @link https://www.flipboxfactory.com/jwt/organization/
7			*/
8
9			namespace flipbox\craft\jwt\models;
10
11			use Craft;
12			use Lcobucci\JWT\Signer;
13			use Lcobucci\JWT\Signer\Hmac\Sha256;
14			use Lcobucci\JWT\Signer\Hmac\Sha384;
15			use Lcobucci\JWT\Signer\Hmac\Sha512;
16			use yii\base\InvalidArgumentException;
17			use yii\base\Model;
18
19			/**
20			* @author Flipbox Factory <[email protected]>
21			* @since 1.0.0
22			*/
23			class Settings extends Model
24			{
25			/**
26			* Supported algorithms
27			*
28			* @var array
29			*/
30			public $algorithms = [
31			'HS256' => Sha256::class,
32			'HS384' => Sha384::class,
33			'HS512' => Sha512::class,
34			];
35
36			/**
37			* The selected algorithm
38			*
39			* @var string
40			*/
41			public $algorithm = 'HS512';
42
43			/**
44			* The key used for token signature
45			*
46			* @var string
47			*/
48			private $key;
49
50			/**
51			* The default token Expiration
52			* @var int
53			*/
54			public $tokenExpiration = 3600;
55
56			/**
57			* The default audience
58			*
59			* @var string
60			*/
61			private $selfConsumableAudience = null;
62
63			/**
64			* The available audiences
65			*
66			* @var array
67			*/
68			private $selfConsumableIssuers = [];
69
70			/** The default target
71			*
72			* @var int
73			*/
74			private $issuer = null;
75
76			/**
77			* @return string
78			*/
79			public function getKey(): string
80			{
81			if (empty($this->key)) {
82			return Craft::$app->getConfig()->getGeneral()->securityKey;
83			}
84			return $this->key;
85			}
86
87			/**
88			* @param array\|null $selfConsumableIssuers
89			* @return $this
90			*/
91			public function setSelfConsumableIssuers(array $selfConsumableIssuers = [])
92			{
93			$this->selfConsumableIssuers = $selfConsumableIssuers;
94			return $this;
95			}
96
97			/**
98			* @return array
99			* @throws \craft\errors\SiteNotFoundException
100			*/
101			public function getSelfConsumableIssuers(): array
102			{
103			if (empty($this->selfConsumableIssuers)) {
104			return [Craft::$app->getSites()->getCurrentSite()->baseUrl];
105			}
106			return (array)$this->selfConsumableIssuers;
107			}
108
109
110
111			/**
112			* @param string\|null $selfConsumableAudience
113			* @return $this
114			*/
115			public function setSelfConsumableAudience(string $selfConsumableAudience = null)
116			{
117			$this->selfConsumableAudience = $selfConsumableAudience;
118			return $this;
119			}
120
121			/**
122			* @return string
123			* @throws \craft\errors\SiteNotFoundException
124			*/
125			public function getSelfConsumableAudience(): string
126			{
127			if (null === $this->selfConsumableAudience) {
128			return Craft::$app->getSites()->getCurrentSite()->baseUrl;
129			}
130			return (string)$this->selfConsumableAudience;
131			}
132
133			/**
134			* @param string\|null $issuer
135			* @return $this
136			*/
137			public function setIssuer(string $issuer = null)
138			{
139			$this->issuer = $issuer;
			0 ignored issues – show Documentation Bug introduced 2018-03-21 15:47 UTC by Report Bug Copy Issue Report It seems like `$issuer` can also be of type `string`. However, the property `$issuer` is declared as type `integer`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
140			return $this;
141			}
142
143			/**
144			* @return string
145			* @throws \craft\errors\SiteNotFoundException
146			*/
147			public function getIssuer(): string
148			{
149			if (null === $this->issuer) {
150			return Craft::$app->getSites()->getCurrentSite()->baseUrl;
151			}
152			return (string)$this->issuer;
153			}
154
155			/**
156			* Creates a Signer class based on the configured algorithm
157			*
158			* @return Signer
159			* @throws \yii\base\InvalidConfigException
160			*/
161			public function getSigner(): Signer
162			{
163			return $this->resolveSigner($this->algorithm);
164			}
165
166			/**
167			* Resolves a Signer class based on an algorithm key
168			*
169			* @param $key
170			* @return Signer
171			* @throws \yii\base\InvalidConfigException
172			*/
173			public function resolveSigner($key): Signer
174			{
175			if (empty($this->algorithms[$key])) {
176			throw new InvalidArgumentException('Algorithm not supported');
177			}
178
179			/** @var Signer $signer */
180			$signer = Craft::createObject(
181			$this->algorithms[$key]
182			);
183
184			return $signer;
185			}
186
187			/**
188			* @inheritdoc
189			*/
190			public function attributes()
191			{
192			return array_merge(
193			parent::attributes(),
194			[
195			'key',
196			'selfConsumableAudience',
197			'selfConsumableIssuers',
198			'issuer'
199			]
200			);
201			}
202			}
203

flipboxfactory / craft-jwt

Branch — develop (8ea255)

Settings::setIssuer() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like