UserAuthenticator::userFromCookie() - Code Metrics - Inspection of "Controller" - zortje/mvc - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#2)

by René

created 2016-03-08 20:00 UTC

UserAuthenticator::userFromCookie() A

↳ Parent: UserAuthenticator

Complexity

Conditions	3
Paths	7

Size

Total Lines	18
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	12

Metric	Value
dl	0
loc	18
ccs	0
cts	15
cp	0
rs	9.4285
cc	3
eloc	11
nc	7
nop	1
crap	12

<?php
declare(strict_types = 1);

namespace Zortje\MVC\User;

use Zortje\MVC\Configuration\Configuration;
use Zortje\MVC\Storage\Cookie\Cookie;
use Zortje\MVC\Storage\Cookie\Exception\CookieUndefinedIndexException;

/**
 * Class UserAuthenticator
 *
 * @package Zortje\MVC\User
 */
class UserAuthenticator
{

    /**
     * @var \PDO PDO
     */
    protected $pdo;

    /**
     * @var Configuration
     */
    protected $configuration;

    /**
     * UserAuthenticator constructor.
     *
     * @param \PDO          $pdo
     * @param Configuration $configuration
     */
    public function __construct(\PDO $pdo, Configuration $configuration)
    {
        $this->pdo           = $pdo;
        $this->configuration = $configuration;
    }

    /**
     * Authenticate user object from cookie
     *
     * @param Cookie $cookie Cookie object
     *
     * @return User|null User if a user ID is sent in cookie

     */
    public function userFromCookie(Cookie $cookie)
    {
        try {
            $userId = $cookie->get('User.id');

            $userTable = new UserTable($this->pdo);

            $users = $userTable->findBy('id', $userId);

            if (count($users) === 1) {
                return $users[0];
            } else {
                return null;
            }
        } catch (CookieUndefinedIndexException $e) {
            return null;
        }
    }

    /**
     * Sign in an user
     *
     * @param User   $user     User object
     * @param string $password User password
     *
     * @return bool Returns true if sign in was successful, otherwise false will be returned
     */
    public function signIn(User $user, string $password): bool
    {
        /**
         * Verify password
         */
        if (password_verify($password, $user->get('password_hash')) === false) {
            /**
             * Return false to indicate incorrect credentials
             */
            return false;
        } else {
            /**
             * Check if a new hashing algorithm is available or the cost has changed
             * If so, create a new hash and replace the old one in the user
             */
            $options = ['cost' => $this->configuration->get('User.Password.Cost')];

            if (password_needs_rehash($user->get('password_hash'), PASSWORD_DEFAULT, $options)) {
                /**
                 * Create new password hash
                 */
                $user->set('password_hash', password_hash($password, PASSWORD_DEFAULT, $options));

                /**
                 * Update user in database
                 */
                $userTable = new UserTable($this->pdo);
                $userTable->update($user);
            }

            /**
             * Regenerate session ID to prevent session fixation attacks
             */
            session_regenerate_id();

            /**
             * Set User id in session
             */
            $this->cookie->set('User.id', $user->get('id'));
class MyClass { }

$x = new MyClass();
$x->foo = true;

            /**
             * Return true to indicate a successful sign in
             */
            return true;
        }
    }
}


1			<?php
2			declare(strict_types = 1);
3
4			namespace Zortje\MVC\User;
5
6			use Zortje\MVC\Configuration\Configuration;
7			use Zortje\MVC\Storage\Cookie\Cookie;
8			use Zortje\MVC\Storage\Cookie\Exception\CookieUndefinedIndexException;
9
10			/**
11			* Class UserAuthenticator
12			*
13			* @package Zortje\MVC\User
14			*/
15			class UserAuthenticator
16			{
17
18			/**
19			* @var \PDO PDO
20			*/
21			protected $pdo;
22
23			/**
24			* @var Configuration
25			*/
26			protected $configuration;
27
28			/**
29			* UserAuthenticator constructor.
30			*
31			* @param \PDO $pdo
32			* @param Configuration $configuration
33			*/
34			public function __construct(\PDO $pdo, Configuration $configuration)
35			{
36			$this->pdo = $pdo;
37			$this->configuration = $configuration;
38			}
39
40			/**
41			* Authenticate user object from cookie
42			*
43			* @param Cookie $cookie Cookie object
44			*
45			* @return User\|null User if a user ID is sent in cookie
			0 ignored issues – show Documentation introduced 2016-03-08 19:49 UTC by Report Bug Copy Issue Report Should the return type not be `\Zortje\MVC\Model\Table\Entity\Entity\|null`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
46			*/
47			public function userFromCookie(Cookie $cookie)
48			{
49			try {
50			$userId = $cookie->get('User.id');
51
52			$userTable = new UserTable($this->pdo);
53
54			$users = $userTable->findBy('id', $userId);
55
56			if (count($users) === 1) {
57			return $users[0];
58			} else {
59			return null;
60			}
61			} catch (CookieUndefinedIndexException $e) {
62			return null;
63			}
64			}
65
66			/**
67			* Sign in an user
68			*
69			* @param User $user User object
70			* @param string $password User password
71			*
72			* @return bool Returns true if sign in was successful, otherwise false will be returned
73			*/
74			public function signIn(User $user, string $password): bool
75			{
76			/**
77			* Verify password
78			*/
79			if (password_verify($password, $user->get('password_hash')) === false) {
80			/**
81			* Return false to indicate incorrect credentials
82			*/
83			return false;
84			} else {
85			/**
86			* Check if a new hashing algorithm is available or the cost has changed
87			* If so, create a new hash and replace the old one in the user
88			*/
89			$options = ['cost' => $this->configuration->get('User.Password.Cost')];
90
91			if (password_needs_rehash($user->get('password_hash'), PASSWORD_DEFAULT, $options)) {
92			/**
93			* Create new password hash
94			*/
95			$user->set('password_hash', password_hash($password, PASSWORD_DEFAULT, $options));
96
97			/**
98			* Update user in database
99			*/
100			$userTable = new UserTable($this->pdo);
101			$userTable->update($user);
102			}
103
104			/**
105			* Regenerate session ID to prevent session fixation attacks
106			*/
107			session_regenerate_id();
108
109			/**
110			* Set User id in session
111			*/
112			$this->cookie->set('User.id', $user->get('id'));
			0 ignored issues – show Bug introduced 2016-03-07 00:01 UTC by Report Bug Copy Issue Report The property `cookie` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
113
114			/**
115			* Return true to indicate a successful sign in
116			*/
117			return true;
118			}
119			}
120			}
121

zortje / mvc

Pull Request — master (#2)

UserAuthenticator::userFromCookie() A

Complexity

Size

Duplication

Code Coverage

Duplication Side-by-Side

Filter issues like