TwoFactorQrCodeUriGeneratorService - Code Metrics - Inspection of "Close #15 added two factor authentication" - 2amigos/yii2-usuario - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 5ee4c9...308b6a )

by Antonio

created 2017-09-21 15:48 UTC

TwoFactorQrCodeUriGeneratorService A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	35
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

Importance

Changes

Metric	Value
wmc	3
lcom	1
cbo	5
dl	0
loc	35
ccs	0
cts	15
cp	0
rs	10
c	0
b	0
f	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	run()	0	13	2

<?php

namespace Da\User\Service;

use Da\TwoFA\Manager;
use Da\TwoFA\Service\QrCodeDataUriGeneratorService;
use Da\TwoFA\Service\TOTPSecretKeyUriGeneratorService;
use Da\User\Contracts\ServiceInterface;
use Da\User\Model\User;
use Yii;

class TwoFactorQrCodeUriGeneratorService implements ServiceInterface
{
    /**
     * @var User
     */
    protected $user;

    /**
     * TwoFactorQrCodeUriGeneratorService constructor.
     *
     * @param User $user
     */
    public function __construct(User $user)
    {
        $this->user = $user;
    }

    /**
     * @inheritdoc
     */
    public function run()
    {
        $user = $this->user;
        if (!$user->auth_tf_key) {
            $user->auth_tf_key = (new Manager())->generateSecretKey();
            $user->updateAttributes(['auth_tf_key']);
        }

        $totpUri = (new TOTPSecretKeyUriGeneratorService(Yii::$app->name, $user->email, $user->auth_tf_key))->run();
        $dataUri = (new QrCodeDataUriGeneratorService($totpUri))->run();

        return $dataUri;
class Author {
    private $name;

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

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

}


1			<?php
2
3			namespace Da\User\Service;
4
5			use Da\TwoFA\Manager;
6			use Da\TwoFA\Service\QrCodeDataUriGeneratorService;
7			use Da\TwoFA\Service\TOTPSecretKeyUriGeneratorService;
8			use Da\User\Contracts\ServiceInterface;
9			use Da\User\Model\User;
10			use Yii;
11
12			class TwoFactorQrCodeUriGeneratorService implements ServiceInterface
13			{
14			/**
15			* @var User
16			*/
17			protected $user;
18
19			/**
20			* TwoFactorQrCodeUriGeneratorService constructor.
21			*
22			* @param User $user
23			*/
24			public function __construct(User $user)
25			{
26			$this->user = $user;
27			}
28
29			/**
30			* @inheritdoc
31			*/
32			public function run()
33			{
34			$user = $this->user;
35			if (!$user->auth_tf_key) {
36			$user->auth_tf_key = (new Manager())->generateSecretKey();
37			$user->updateAttributes(['auth_tf_key']);
38			}
39
40			$totpUri = (new TOTPSecretKeyUriGeneratorService(Yii::$app->name, $user->email, $user->auth_tf_key))->run();
41			$dataUri = (new QrCodeDataUriGeneratorService($totpUri))->run();
42
43			return $dataUri;
			0 ignored issues – show Bug Best Practice introduced 2017-09-21 15:53 UTC by Report Bug Copy Issue Report The return type of `return $dataUri;` (`string`) is incompatible with the return type declared by the interface `Da\User\Contracts\ServiceInterface::run` of type `boolean`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
44			}
45
46			}
47

2amigos / yii2-usuario

Push — master ( 5ee4c9...308b6a )

TwoFactorQrCodeUriGeneratorService A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

2 Methods

Duplication Side-by-Side

Filter issues like