AuthenticatorService - Code Metrics - Inspection of "Feature auth" - FloKnapp/faulancer - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#16)

by Flo

created 2017-02-06 19:47 UTC

AuthenticatorService A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	118
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	7

Importance

Changes

Metric	Value
wmc	11
lcom	1
cbo	7
dl	0
loc	118
rs	10
c	0
b	0
f	0

7 Methods

Rating	Name	Size	Complexity
A	__construct()	5	1
A	loginUser()	20	2
A	redirectToAuthentication()	8	1
A	redirectAfterAuthentication()	4	1
A	isAuthenticated()	19	4
A	saveUserInSession()	4	1
A	getUserFromSession()	8	1

<?php
/**
 * Class AuthenticatorService | AuthenticatorService.php
 * @package Faulancer\Auth
 * @author  Florian Knapp <[email protected]>
 */
namespace Faulancer\Service;

use Faulancer\Controller\Controller;
use Faulancer\ORM\User\Entity as UserEntity;
use Faulancer\ServiceLocator\ServiceInterface;
use Faulancer\Session\SessionManager;

/**
 * Class AuthenticatorService
 */
class AuthenticatorService implements ServiceInterface
{

    /** @var Controller */
    protected $controller;

    /** @var DbService */
    protected $orm;

    /** @var Config */
    protected $config;

    /** @var string */
    protected $redirectAfterAuth;

    /**
     * Authenticator constructor.
     * @param Controller $controller
     * @param Config     $config
     */
    public function __construct(Controller $controller, Config $config)
    {
        $this->controller = $controller;
        $this->config     = $config;
    }

    /**
     * @param UserEntity $user
     * @return bool
     * @codeCoverageIgnore
     */
    public function loginUser(UserEntity $user)
    {
        /** @var UserEntity $userData */
        $userData = $this->controller
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.
    }
}
            ->getDb()
            ->fetch(get_class($user))
            ->where('login', '=', $user->login)
            ->andWhere('password', '=', $user->password)
            ->one();

        if ($userData instanceof UserEntity) {
            $this->saveUserInSession($userData);
            return $this->controller->redirect($this->redirectAfterAuth);
        }

        /** @var SessionManagerService $sessionManager */
        $sessionManager = $this->controller->getServiceLocator()->get(SessionManagerService::class);
        $sessionManager->setFlashbag('loginError', 'No valid username/password combination found.');
        return $this->redirectToAuthentication();
    }

    /**
     * @return bool
     */
    public function redirectToAuthentication()
    {
        /** @var Config $config */
        $config  = $this->controller->getServiceLocator()->get(Config::class);
        $authUrl = $config->get('auth:authUrl');

        return $this->controller->redirect($authUrl);
    }

    /**
     * @param string $uri
     * @codeCoverageIgnore
     */
    public function redirectAfterAuthentication(string $uri)
    {
        $this->redirectAfterAuth = $uri;
    }

    /**
     * @param array $roles
     * @return bool
     */
    public function isAuthenticated(array $roles)
    {
        /** @var UserEntity $user */
        $user = $this->getUserFromSession();

        if (!$user instanceof UserEntity) {
            return false;
        }

        foreach ($user->roles as $userRole) {

            if (in_array($userRole->roleName, $roles, true)) {
                return true;
            }

        }

        return false;
    }

    /**
     * @param UserEntity $user
     */
    public function saveUserInSession(UserEntity $user)
    {
        $this->controller->getSessionManager()->set('user', $user->id);
    }

    /**
     * @return UserEntity
     */
    public function getUserFromSession()
    {
        $id = $this->controller->getSessionManager()->get('user');

        /** @var UserEntity $user */
        $user = $this->controller->getDb()->fetch(UserEntity::class, $id);
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.
    }
}
        return $user;
    }

}

1			<?php
2			/**
3			* Class AuthenticatorService \| AuthenticatorService.php
4			* @package Faulancer\Auth
5			* @author Florian Knapp <[email protected]>
6			*/
7			namespace Faulancer\Service;
8
9			use Faulancer\Controller\Controller;
10			use Faulancer\ORM\User\Entity as UserEntity;
11			use Faulancer\ServiceLocator\ServiceInterface;
12			use Faulancer\Session\SessionManager;
13
14			/**
15			* Class AuthenticatorService
16			*/
17			class AuthenticatorService implements ServiceInterface
18			{
19
20			/** @var Controller */
21			protected $controller;
22
23			/** @var DbService */
24			protected $orm;
25
26			/** @var Config */
27			protected $config;
28
29			/** @var string */
30			protected $redirectAfterAuth;
31
32			/**
33			* Authenticator constructor.
34			* @param Controller $controller
35			* @param Config $config
36			*/
37			public function __construct(Controller $controller, Config $config)
38			{
39			$this->controller = $controller;
40			$this->config = $config;
41			}
42
43			/**
44			* @param UserEntity $user
45			* @return bool
46			* @codeCoverageIgnore
47			*/
48			public function loginUser(UserEntity $user)
49			{
50			/** @var UserEntity $userData */
51			$userData = $this->controller
			0 ignored issues – show Bug introduced 2017-02-06 19:54 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Faulancer\ServiceLocator\ServiceInterface` as the method `fetch()` does only exist in the following implementations of said interface: `Faulancer\Service\DbService`. 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...
52			->getDb()
53			->fetch(get_class($user))
54			->where('login', '=', $user->login)
55			->andWhere('password', '=', $user->password)
56			->one();
57
58			if ($userData instanceof UserEntity) {
59			$this->saveUserInSession($userData);
60			return $this->controller->redirect($this->redirectAfterAuth);
61			}
62
63			/** @var SessionManagerService $sessionManager */
64			$sessionManager = $this->controller->getServiceLocator()->get(SessionManagerService::class);
65			$sessionManager->setFlashbag('loginError', 'No valid username/password combination found.');
66			return $this->redirectToAuthentication();
67			}
68
69			/**
70			* @return bool
71			*/
72			public function redirectToAuthentication()
73			{
74			/** @var Config $config */
75			$config = $this->controller->getServiceLocator()->get(Config::class);
76			$authUrl = $config->get('auth:authUrl');
77
78			return $this->controller->redirect($authUrl);
79			}
80
81			/**
82			* @param string $uri
83			* @codeCoverageIgnore
84			*/
85			public function redirectAfterAuthentication(string $uri)
86			{
87			$this->redirectAfterAuth = $uri;
88			}
89
90			/**
91			* @param array $roles
92			* @return bool
93			*/
94			public function isAuthenticated(array $roles)
95			{
96			/** @var UserEntity $user */
97			$user = $this->getUserFromSession();
98
99			if (!$user instanceof UserEntity) {
100			return false;
101			}
102
103			foreach ($user->roles as $userRole) {
104
105			if (in_array($userRole->roleName, $roles, true)) {
106			return true;
107			}
108
109			}
110
111			return false;
112			}
113
114			/**
115			* @param UserEntity $user
116			*/
117			public function saveUserInSession(UserEntity $user)
118			{
119			$this->controller->getSessionManager()->set('user', $user->id);
120			}
121
122			/**
123			* @return UserEntity
124			*/
125			public function getUserFromSession()
126			{
127			$id = $this->controller->getSessionManager()->get('user');
128
129			/** @var UserEntity $user */
130			$user = $this->controller->getDb()->fetch(UserEntity::class, $id);
			0 ignored issues – show Bug introduced 2017-02-06 19:54 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Faulancer\ServiceLocator\ServiceInterface` as the method `fetch()` does only exist in the following implementations of said interface: `Faulancer\Service\DbService`. 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...
131			return $user;
132			}
133
134			}

FloKnapp / faulancer

Pull Request — master (#16)

AuthenticatorService A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

7 Methods

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like