AuthProviderHandler - Code Metrics - Inspection of "Remove `ACTION_AdminTags` from admin menu" - rkit/bootstrap-yii2 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 567ea1...6214df )

by Igor

created 2016-11-16 17:03 UTC

AuthProviderHandler A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	254
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

Metric	Value
wmc	26
c	0
b	0
f	0
lcom	1
cbo	4
dl	0
loc	254
rs	10

15 Methods

Rating	Name	Size	Complexity
A	__construct()	5	1
B	handle()	25	5
A	getUser()	4	1
A	getEmail()	4	1
A	isExist()	4	1
A	isVerified()	4	1
A	findUserByProvider()	13	2
B	parseProvider()	22	4
A	parseProfile()	20	4
A	parseProviderFacebook()	9	1
A	parseProviderVkontakte()	9	1
A	parseProviderTwitter()	9	1
A	parseProfileFacebook()	8	1
A	parseProfileVkontakte()	11	1
A	parseProfileTwitter()	8	1

<?php

namespace app\handlers;

use yii\authclient\ClientInterface;
use yii\helpers\ArrayHelper;
use app\models\User;
use app\models\UserProvider;

/**
 * AuthProviderHandler handles successful authentication
 */
class AuthProviderHandler
{
    /**
     * @var int
     */
    private $type;
    /**
     * @var User
     */
    private $user;
    /**
     * @var string
     */
    private $email;
    /**
     * @var bool
     */
    private $verified = false;
    /**
     * @var bool
     */
    private $exist = false;
    /**
     * @var ClientInterface
     */
    private $client;

    public function __construct(ClientInterface $client)
    {
        $this->client = $client;
        $this->type = UserProvider::getTypeByName($client->id);
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
    }

    /**
     * @SuppressWarnings(PHPMD.ElseExpression)
     */
    public function handle()
    {
        $user = $this->findUserByProvider();
        if ($user) {
            $this->exist = true;
        } else {
            $profile = $this->client->getUserAttributes();
            $this->email = ArrayHelper::getValue($profile, 'email');
            $this->verified = ArrayHelper::getValue($profile, 'verified');

            if ($this->verified && !empty($this->email)) {
                $user = User::findByEmail($this->email);
            }

            if (!$user) {
                $user = new User();
                $user->setProfile($this->parseProfile());
            }
        }

        $user->setProviders($this->parseProvider());
        $this->user = $user;
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;
    }

    public function getUser()
    {
        return $this->user;
    }

    public function getEmail()
    {
        return $this->email;
    }

    public function isExist()
    {
        return $this->exist;
    }

    public function isVerified()
    {
        return $this->verified;
    }

    /**
     * Find user by provider
     *
     * @return app\models\User|null
     */
    private function findUserByProvider()
    {
        $profile = $this->client->getUserAttributes();
        $id = ArrayHelper::getValue($profile, 'id');
        if ($provider = UserProvider::findByProvider($this->type, $id)) {
            $user = $provider->user;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            $provider->setAttributes($this->parseProvider());
            $provider->save();

            return $user;
        }
        return null;
    }

    /**
     * Parse provider
     *
     * @return array
     */
    private function parseProvider()
    {
        $profile = $this->client->getUserAttributes();
        $token = $this->client->getAccessToken()->getParams();
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.
    }
}

        $data = [];
        switch ($this->type) {
            case UserProvider::TYPE_FACEBOOK:
                $data = $this->parseProviderFacebook($profile, $token);
                break;

            case UserProvider::TYPE_VKONTAKTE:
                $data = $this->parseProviderVkontakte($profile, $token);
                break;

            case UserProvider::TYPE_TWITTER:
                $data = $this->parseProviderTwitter($profile, $token);
                break;
        }
        $data['type'] = $this->type;
        return $data;
    }

    /**
     * Parse profile
     *
     * @return array
     */
    private function parseProfile()
    {
        $profile = $this->client->getUserAttributes();

        $data = [];
        switch ($this->type) {
            case UserProvider::TYPE_FACEBOOK:
                $data = $this->parseProfileFacebook($profile);
                break;

            case UserProvider::TYPE_VKONTAKTE:
                $data = $this->parseProfileVkontakte($profile);
                break;

            case UserProvider::TYPE_TWITTER:
                $data = $this->parseProfileTwitter($profile);
                break;
        }
        return $data;
    }

    /**
     * Prepare provider attributes for facebook
     *
     * @param array $profile
     * @param array $token
     * @return array
     */
    private function parseProviderFacebook($profile, $token)
    {
        return [
            'profile_id' => ArrayHelper::getValue($profile, 'id'),
            'profile_url' => ArrayHelper::getValue($profile, 'link'),
            'access_token' => ArrayHelper::getValue($token, 'access_token'),
            'access_token_secret' => ''
        ];
    }

    /**
     * Prepare provider attributes for vkontakte
     *
     * @param array $profile
     * @param array $token
     * @return array
     */
    private function parseProviderVkontakte($profile, $token)
    {
        return [
            'profile_id' => ArrayHelper::getValue($profile, 'id'),
            'profile_url' => 'https://vk.com/id' . ArrayHelper::getValue($profile, 'id'),
            'access_token' => ArrayHelper::getValue($token, 'access_token'),
            'access_token_secret' => ''
        ];
    }

    /**
     * Prepare provider attributes for twitter
     *
     * @param array $profile
     * @param array $token
     * @return array
     */
    private function parseProviderTwitter($profile, $token)
    {
        return [
            'profile_id' => ArrayHelper::getValue($profile, 'id'),
            'profile_url' => 'https://twitter.com/' . ArrayHelper::getValue($profile, 'screen_name'),
            'access_token' => ArrayHelper::getValue($token, 'oauth_token'),
            'access_token_secret' => ArrayHelper::getValue($token, 'oauth_token_secret')
        ];
    }

    /**
     * Prepare profile attributes for facebook
     *
     * @param array $profile
     * @return array
     */
    private function parseProfileFacebook($profile)
    {
        return [
            'full_name' => trim(ArrayHelper::getValue($profile, 'name')),
            'birth_day' => '—',
            'photo' => ArrayHelper::getValue($profile, 'picture.data.url', '')
        ];
    }

    /**
     * Prepare profile attributes for vkontakte
     *
     * @param array $profile
     * @return array
     */
    private function parseProfileVkontakte($profile)
    {
        $firstName = ArrayHelper::getValue($profile, 'first_name');
        $lastName = ArrayHelper::getValue($profile, 'last_name');
        $birthDay = date_create_from_format('d.m.Y', ArrayHelper::getValue($profile, 'bdate'));
        return [
            'full_name' => trim($firstName . ' ' . $lastName),
            'birth_day' => date_format($birthDay, 'Y-m-d'),
            'photo' => str_replace('_50', '_400', ArrayHelper::getValue($profile, 'photo'))
        ];
    }

    /**
     * Prepare profile attributes for twitter
     *
     * @param array $profile
     * @return array
     */
    private function parseProfileTwitter($profile)
    {
        $photo = ArrayHelper::getValue($profile, 'profile_image_url');
        return [
            'full_name' => $profile['name'],
            'photo' => str_replace('_normal', '_400x400', $photo)
        ];
    }
}


Push — master ( 567ea1...6214df )

AuthProviderHandler A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

15 Methods

Available Fixes

Available Fixes

1			<?php
2
3			namespace app\handlers;
4
5			use yii\authclient\ClientInterface;
6			use yii\helpers\ArrayHelper;
7			use app\models\User;
8			use app\models\UserProvider;
9
10			/**
11			* AuthProviderHandler handles successful authentication
12			*/
13			class AuthProviderHandler
14			{
15			/**
16			* @var int
17			*/
18			private $type;
19			/**
20			* @var User
21			*/
22			private $user;
23			/**
24			* @var string
25			*/
26			private $email;
27			/**
28			* @var bool
29			*/
30			private $verified = false;
31			/**
32			* @var bool
33			*/
34			private $exist = false;
35			/**
36			* @var ClientInterface
37			*/
38			private $client;
39
40			public function __construct(ClientInterface $client)
41			{
42			$this->client = $client;
43			$this->type = UserProvider::getTypeByName($client->id);
			0 ignored issues – show Bug introduced 2016-09-19 17:06 UTC by Report Bug Copy Issue Report Accessing `id` on the interface `yii\authclient\ClientInterface` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history... Documentation Bug introduced 2016-09-19 17:06 UTC by Report Bug Copy Issue Report The property `$type` was declared of type `integer`, but `\app\models\UserProvider...TypeByName($client->id)` is of type `string`. Maybe add a type cast? This check looks for assignments to scalar types that may be of the wrong type. To ensure the code behaves as expected, it may be a good idea to add an explicit type cast. $answer = 42; $correct = false; $correct = (bool) $answer; Loading history...
44			}
45
46			/**
47			* @SuppressWarnings(PHPMD.ElseExpression)
48			*/
49			public function handle()
50			{
51			$user = $this->findUserByProvider();
52			if ($user) {
53			$this->exist = true;
54			} else {
55			$profile = $this->client->getUserAttributes();
56			$this->email = ArrayHelper::getValue($profile, 'email');
57			$this->verified = ArrayHelper::getValue($profile, 'verified');
58
59			if ($this->verified && !empty($this->email)) {
60			$user = User::findByEmail($this->email);
61			}
62
63			if (!$user) {
64			$user = new User();
65			$user->setProfile($this->parseProfile());
66			}
67			}
68
69			$user->setProviders($this->parseProvider());
70			$this->user = $user;
			0 ignored issues – show Documentation Bug introduced 2016-11-16 17:08 UTC by Report Bug Copy Issue Report It seems like `$user` can also be of type `object<app\handlers\app\models\User>`. However, the property `$user` is declared as type `object<app\models\User>`. 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...
71
72			return $this;
73			}
74
75			public function getUser()
76			{
77			return $this->user;
78			}
79
80			public function getEmail()
81			{
82			return $this->email;
83			}
84
85			public function isExist()
86			{
87			return $this->exist;
88			}
89
90			public function isVerified()
91			{
92			return $this->verified;
93			}
94
95			/**
96			* Find user by provider
97			*
98			* @return app\models\User\|null
99			*/
100			private function findUserByProvider()
101			{
102			$profile = $this->client->getUserAttributes();
103			$id = ArrayHelper::getValue($profile, 'id');
104			if ($provider = UserProvider::findByProvider($this->type, $id)) {
105			$user = $provider->user;
			0 ignored issues – show Documentation introduced 2016-11-04 14:02 UTC by Report Bug Copy Issue Report The property `user` does not exist on `object<app\models\UserProvider>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
106			$provider->setAttributes($this->parseProvider());
107			$provider->save();
108
109			return $user;
110			}
111			return null;
112			}
113
114			/**
115			* Parse provider
116			*
117			* @return array
118			*/
119			private function parseProvider()
120			{
121			$profile = $this->client->getUserAttributes();
122			$token = $this->client->getAccessToken()->getParams();
			0 ignored issues – show Bug introduced 2016-09-19 17:06 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `yii\authclient\ClientInterface` as the method `getAccessToken()` does only exist in the following implementations of said interface: `yii\authclient\BaseOAuth`, `yii\authclient\OAuth1`, `yii\authclient\OAuth2`, `yii\authclient\clients\Facebook`, `yii\authclient\clients\GitHub`, `yii\authclient\clients\Google`, `yii\authclient\clients\GoogleHybrid`, `yii\authclient\clients\LinkedIn`, `yii\authclient\clients\Live`, `yii\authclient\clients\Twitter`, `yii\authclient\clients\VKontakte`, `yii\authclient\clients\Yandex`. 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...
123
124			$data = [];
125			switch ($this->type) {
126			case UserProvider::TYPE_FACEBOOK:
127			$data = $this->parseProviderFacebook($profile, $token);
128			break;
129
130			case UserProvider::TYPE_VKONTAKTE:
131			$data = $this->parseProviderVkontakte($profile, $token);
132			break;
133
134			case UserProvider::TYPE_TWITTER:
135			$data = $this->parseProviderTwitter($profile, $token);
136			break;
137			}
138			$data['type'] = $this->type;
139			return $data;
140			}
141
142			/**
143			* Parse profile
144			*
145			* @return array
146			*/
147			private function parseProfile()
148			{
149			$profile = $this->client->getUserAttributes();
150
151			$data = [];
152			switch ($this->type) {
153			case UserProvider::TYPE_FACEBOOK:
154			$data = $this->parseProfileFacebook($profile);
155			break;
156
157			case UserProvider::TYPE_VKONTAKTE:
158			$data = $this->parseProfileVkontakte($profile);
159			break;
160
161			case UserProvider::TYPE_TWITTER:
162			$data = $this->parseProfileTwitter($profile);
163			break;
164			}
165			return $data;
166			}
167
168			/**
169			* Prepare provider attributes for facebook
170			*
171			* @param array $profile
172			* @param array $token
173			* @return array
174			*/
175			private function parseProviderFacebook($profile, $token)
176			{
177			return [
178			'profile_id' => ArrayHelper::getValue($profile, 'id'),
179			'profile_url' => ArrayHelper::getValue($profile, 'link'),
180			'access_token' => ArrayHelper::getValue($token, 'access_token'),
181			'access_token_secret' => ''
182			];
183			}
184
185			/**
186			* Prepare provider attributes for vkontakte
187			*
188			* @param array $profile
189			* @param array $token
190			* @return array
191			*/
192			private function parseProviderVkontakte($profile, $token)
193			{
194			return [
195			'profile_id' => ArrayHelper::getValue($profile, 'id'),
196			'profile_url' => 'https://vk.com/id' . ArrayHelper::getValue($profile, 'id'),
197			'access_token' => ArrayHelper::getValue($token, 'access_token'),
198			'access_token_secret' => ''
199			];
200			}
201
202			/**
203			* Prepare provider attributes for twitter
204			*
205			* @param array $profile
206			* @param array $token
207			* @return array
208			*/
209			private function parseProviderTwitter($profile, $token)
210			{
211			return [
212			'profile_id' => ArrayHelper::getValue($profile, 'id'),
213			'profile_url' => 'https://twitter.com/' . ArrayHelper::getValue($profile, 'screen_name'),
214			'access_token' => ArrayHelper::getValue($token, 'oauth_token'),
215			'access_token_secret' => ArrayHelper::getValue($token, 'oauth_token_secret')
216			];
217			}
218
219			/**
220			* Prepare profile attributes for facebook
221			*
222			* @param array $profile
223			* @return array
224			*/
225			private function parseProfileFacebook($profile)
226			{
227			return [
228			'full_name' => trim(ArrayHelper::getValue($profile, 'name')),
229			'birth_day' => '—',
230			'photo' => ArrayHelper::getValue($profile, 'picture.data.url', '')
231			];
232			}
233
234			/**
235			* Prepare profile attributes for vkontakte
236			*
237			* @param array $profile
238			* @return array
239			*/
240			private function parseProfileVkontakte($profile)
241			{
242			$firstName = ArrayHelper::getValue($profile, 'first_name');
243			$lastName = ArrayHelper::getValue($profile, 'last_name');
244			$birthDay = date_create_from_format('d.m.Y', ArrayHelper::getValue($profile, 'bdate'));
245			return [
246			'full_name' => trim($firstName . ' ' . $lastName),
247			'birth_day' => date_format($birthDay, 'Y-m-d'),
248			'photo' => str_replace('_50', '_400', ArrayHelper::getValue($profile, 'photo'))
249			];
250			}
251
252			/**
253			* Prepare profile attributes for twitter
254			*
255			* @param array $profile
256			* @return array
257			*/
258			private function parseProfileTwitter($profile)
259			{
260			$photo = ArrayHelper::getValue($profile, 'profile_image_url');
261			return [
262			'full_name' => $profile['name'],
263			'photo' => str_replace('_normal', '_400x400', $photo)
264			];
265			}
266			}
267

rkit / bootstrap-yii2

Push — master ( 567ea1...6214df )

AuthProviderHandler A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

15 Methods

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like