User::getAuthData() - Code Metrics - Inspection of "+ `User::getAuthData`" - hiqdev/hipanel-core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 720ad9...c1559c )

by Andrii

created 2017-02-03 16:42 UTC

User::getAuthData() B

↳ Parent: User

Complexity

Conditions	4
Paths	5

Size

Total Lines	23
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	20

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	23
ccs	0
cts	18
cp	0
rs	8.7972
cc	4
eloc	13
nc	5
nop	0
crap	20

<?php

/*
 * HiPanel core package
 *
 * @link      https://hipanel.com/
 * @package   hipanel-core
 * @license   BSD-3-Clause
 * @copyright Copyright (c) 2014-2016, HiQDev (http://hiqdev.com/)
 */

namespace hipanel\components;

use Yii;
use yii\base\InvalidCallException;
use yii\base\InvalidConfigException;

class User extends \yii\web\User
{
    public $isGuestAllowed = false;

    /**
     * @var string the seller login
     */
    public $seller;

    public function init()
    {
        parent::init();
        if (empty($this->seller)) {
            throw new InvalidConfigException('User "seller" must be set');
        }
    }

    public function not($key)
    {
        $identity = $this->getIdentity();
        if (!$identity) {
$a = canBeFalseAndNull();

// Instead of
if ( ! $a) { }

// Better use one of the explicit versions:
if ($a !== null) { }
if ($a !== false) { }
if ($a !== null && $a !== false) { }
            throw new InvalidCallException();
        }

        return $identity->not($key);

    }

    public function is($key)
    {
        $identity = $this->getIdentity();
        if (!$identity) {
$a = canBeFalseAndNull();

// Instead of
if ( ! $a) { }

// Better use one of the explicit versions:
if ($a !== null) { }
if ($a !== false) { }
if ($a !== null && $a !== false) { }
            throw new InvalidCallException();
        }

        return $identity->is($key);

    }
    /**
     * @inheritdoc
     * XXX fixes redirect loop when identity is set but the object is empty
     * @return bool
     */
    public function getIsGuest()
    {
        return empty($this->getIdentity()->id);
    }

    /**
     * Prepares authorization data.
     * Redirects to authorization if necessary.
     * @return array
     */
    public function getAuthData()
    {
        if ($this->isGuest) {
            if ($this->isGuestAllowed) {
                return [];
            } else {
                Yii::$app->response->redirect('/site/login');
                Yii::$app->end();
            }
        }

        $token = $this->identity->getAccessToken();
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        if (empty($token)) {
            /// this is very important line
            /// without this line - redirect loop
            $this->logout();

            Yii::$app->response->redirect('/site/login');
            Yii::$app->end();
        }

        return ['access_token' => $token];
    }
}


1			<?php
2
3			/*
4			* HiPanel core package
5			*
6			* @link https://hipanel.com/
7			* @package hipanel-core
8			* @license BSD-3-Clause
9			* @copyright Copyright (c) 2014-2016, HiQDev (http://hiqdev.com/)
10			*/
11
12			namespace hipanel\components;
13
14			use Yii;
15			use yii\base\InvalidCallException;
16			use yii\base\InvalidConfigException;
17
18			class User extends \yii\web\User
19			{
20			public $isGuestAllowed = false;
21
22			/**
23			* @var string the seller login
24			*/
25			public $seller;
26
27			public function init()
28			{
29			parent::init();
30			if (empty($this->seller)) {
31			throw new InvalidConfigException('User "seller" must be set');
32			}
33			}
34
35			public function not($key)
36			{
37			$identity = $this->getIdentity();
38			if (!$identity) {
			0 ignored issues – show Bug Best Practice introduced 2016-03-31 13:05 UTC by Report Bug Copy Issue Report The expression `$identity` of type `null\|boolean` is loosely compared to `false`; this is ambiguous if the boolean can be false. You might want to explicitly use `!== null` instead. If an expression can have both `false`, and `null` as possible values. It is generally a good practice to always use strict comparison to clearly distinguish between those two values. $a = canBeFalseAndNull(); // Instead of if ( ! $a) { } // Better use one of the explicit versions: if ($a !== null) { } if ($a !== false) { } if ($a !== null && $a !== false) { } Loading history...
39			throw new InvalidCallException();
40			}
41
42			return $identity->not($key);
			0 ignored issues – show Bug introduced 2016-03-31 13:05 UTC by Report Bug Copy Issue Report The method `not` cannot be called on `$identity` (of type `boolean`). Methods can only be called on objects. This check looks for methods being called on variables that have been inferred to never be objects. Loading history...
43			}
44
45			public function is($key)
46			{
47			$identity = $this->getIdentity();
48			if (!$identity) {
			0 ignored issues – show Bug Best Practice introduced 2016-03-31 13:05 UTC by Report Bug Copy Issue Report The expression `$identity` of type `null\|boolean` is loosely compared to `false`; this is ambiguous if the boolean can be false. You might want to explicitly use `!== null` instead. If an expression can have both `false`, and `null` as possible values. It is generally a good practice to always use strict comparison to clearly distinguish between those two values. $a = canBeFalseAndNull(); // Instead of if ( ! $a) { } // Better use one of the explicit versions: if ($a !== null) { } if ($a !== false) { } if ($a !== null && $a !== false) { } Loading history...
49			throw new InvalidCallException();
50			}
51
52			return $identity->is($key);
			0 ignored issues – show Bug introduced 2016-03-31 13:05 UTC by Report Bug Copy Issue Report The method `is` cannot be called on `$identity` (of type `boolean`). Methods can only be called on objects. This check looks for methods being called on variables that have been inferred to never be objects. Loading history...
53			}
54			/**
55			* @inheritdoc
56			* XXX fixes redirect loop when identity is set but the object is empty
57			* @return bool
58			*/
59			public function getIsGuest()
60			{
61			return empty($this->getIdentity()->id);
62			}
63
64			/**
65			* Prepares authorization data.
66			* Redirects to authorization if necessary.
67			* @return array
68			*/
69			public function getAuthData()
70			{
71			if ($this->isGuest) {
72			if ($this->isGuestAllowed) {
73			return [];
74			} else {
75			Yii::$app->response->redirect('/site/login');
76			Yii::$app->end();
77			}
78			}
79
80			$token = $this->identity->getAccessToken();
			0 ignored issues – show Bug introduced 2017-02-03 16:47 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `yii\web\IdentityInterface` as the method `getAccessToken()` does only exist in the following implementations of said interface: `hipanel\models\User`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
81			if (empty($token)) {
82			/// this is very important line
83			/// without this line - redirect loop
84			$this->logout();
85
86			Yii::$app->response->redirect('/site/login');
87			Yii::$app->end();
88			}
89
90			return ['access_token' => $token];
91			}
92			}
93

hiqdev / hipanel-core

Push — master ( 720ad9...c1559c )

User::getAuthData() B

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like