User::checkForBanAlternative() - Code Metrics - Inspection of "Merge branch 'development' of https://github.com/s..." - sant0ro/chocolatey - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — development ( 3ace6a )

by Claudio

created 2017-05-09 18:07 UTC

User::checkForBanAlternative() A

↳ Parent: User

Complexity

Conditions	3
Paths	3

Size

Total Lines	11
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	11
rs	9.4285
c	0
b	0
f	0
cc	3
eloc	6
nc	3
nop	2

<?php

namespace App\Helpers;

use App\Facades\Session;
.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php
use App\Models\ChocolateyId;
use App\Models\User as UserModel;
use App\Singleton;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Config;

/**
 * Class User.
 */
final class User extends Singleton
{
    /**
     * Update User Data without overwriting Session.
     *
     * @param array $parameters
     *
     * @return UserModel
     */
    public function updateSession(array $parameters)
    {
        return $this->setSession($this->updateUser($this->getUser(), $parameters));
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
    }

    /**
     * Set User Data on Session.
     *
     * @param UserModel $user
     *
     * @return UserModel
     */
    public function setSession(UserModel $user)
    {
        return Session::set(Config::get('chocolatey.security.session'), $user);
    }

    /**
     * Update User Data by User Model.
     *
     * @param UserModel $user
     * @param array     $parameters
     *
     * @return UserModel
     */
    public function updateUser($user, array $parameters)
    {
        $user->update($parameters);

        return $user;
    }

    /**
     * Get User Data from Session
     * If User Session doesn't exists, return null.
     *
     * @return UserModel|null
     */
    public function getUser()
    {
        return Session::get(Config::get('chocolatey.security.session')) ?? null;
    }
    
    /**
     * Retrieve Non Banned Users (If all Users are Banned, return the Banned user Also)
     *
     * @param Request $request
     * @param ChocolateyId $chocolateyId
     *
     * @return UserModel
     */
    private function checkForBanAlternative(Request $request, ChocolateyId $chocolateyId) {

        $temporaryUsers = UserModel::where('mail', $request->json()->get('email'))->get();
                
        foreach($temporaryUsers as $forUser) {
            if(!$forUser->isBanned()) {
                return $forUser;
            }
        }
        
        return $temporaryUsers->get(0);
    }
    
    /**
     * Get Users
     *
     * @param Request $request
     * @param ChocolateyId $chocolateyId
     *
     * @return UserModel
     */
    private function retrieveUser(Request $request, ChocolateyId $chocolateyId) {
        if($chocolateyId->last_logged_id != 0) {
            $temporaryUser = UserModel::find($chocolateyId->last_logged_id);
            
            if($temporaryUser->isBanned()) {
                return $this->checkForBanAlternative($request, $chocolateyId);
            }
            
            return $temporaryUser;
        }
        
        $temporaryUser = UserModel::where('mail', $request->json()->get('email'))->first();
        
        if($temporaryUser->isBanned()) {
            return $this->checkForBanAlternative($request, $chocolateyId);
        }
        
        return $temporaryUser;
    }

    /**
     * Set Session From Login Credentials.
     *
     * @param Request $request
     *
     * @return UserModel
     */
    public function loginUser(Request $request)
    {
        $chocolateyId = ChocolateyId::find($request->json()->get('email'));

        if ($chocolateyId == null) {
            return null;
        }
        
        $user = $this->retrieveUser($request, $chocolateyId);
        
        $chocolateyId->last_logged_id = $user->uniqueId;

        return $chocolateyId->password == hash(Config::get('chocolatey.security.hash'), $request->json()->get('password'))
            ? $this->setSession($user) : null;
    }

    /**
     * Return if USer Session Exists.
     *
     * @return bool
     */
    public function hasSession()
    {
        return (bool) Session::get(Config::get('chocolatey.security.session'));
    }

    /**
     * Erase User Session.
     */
    public function eraseSession()
    {
        Session::erase(Config::get('chocolatey.security.session'));
    }
}


1			<?php
2
3			namespace App\Helpers;
4
5			use App\Facades\Session;
			0 ignored issues – show Bug introduced 2017-04-18 19:58 UTC by Report Bug Copy Issue Report This use statement conflicts with another class in this namespace, `App\Helpers\Session`. Let’s assume that you have a directory layout like this: . \|-- OtherDir \| \|-- Bar.php \| `-- Foo.php `-- SomeDir `-- Foo.php and let’s assume the following content of `Bar.php`: // Bar.php namespace OtherDir; use SomeDir\Foo; // This now conflicts the class OtherDir\Foo If both files `OtherDir/Foo.php` and `SomeDir/Foo.php` are loaded in the same runtime, you will see a PHP error such as the following: PHP Fatal error: Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php However, as `OtherDir/Foo.php` does not necessarily have to be loaded and the error is only triggered if it is loaded before `OtherDir/Bar.php`, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias: // Bar.php namespace OtherDir; use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore. Loading history...
6			use App\Models\ChocolateyId;
7			use App\Models\User as UserModel;
8			use App\Singleton;
9			use Illuminate\Http\Request;
10			use Illuminate\Support\Facades\Config;
11
12			/**
13			* Class User.
14			*/
15			final class User extends Singleton
16			{
17			/**
18			* Update User Data without overwriting Session.
19			*
20			* @param array $parameters
21			*
22			* @return UserModel
23			*/
24			public function updateSession(array $parameters)
25			{
26			return $this->setSession($this->updateUser($this->getUser(), $parameters));
			0 ignored issues – show Bug introduced 2017-04-18 19:58 UTC by Report Bug Copy Issue Report It seems like `$this->getUser()` can be `null`; however, `updateUser()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
27			}
28
29			/**
30			* Set User Data on Session.
31			*
32			* @param UserModel $user
33			*
34			* @return UserModel
35			*/
36			public function setSession(UserModel $user)
37			{
38			return Session::set(Config::get('chocolatey.security.session'), $user);
39			}
40
41			/**
42			* Update User Data by User Model.
43			*
44			* @param UserModel $user
45			* @param array $parameters
46			*
47			* @return UserModel
48			*/
49			public function updateUser($user, array $parameters)
50			{
51			$user->update($parameters);
52
53			return $user;
54			}
55
56			/**
57			* Get User Data from Session
58			* If User Session doesn't exists, return null.
59			*
60			* @return UserModel\|null
61			*/
62			public function getUser()
63			{
64			return Session::get(Config::get('chocolatey.security.session')) ?? null;
65			}
66
67			/**
68			* Retrieve Non Banned Users (If all Users are Banned, return the Banned user Also)
69			*
70			* @param Request $request
71			* @param ChocolateyId $chocolateyId
72			*
73			* @return UserModel
74			*/
75			private function checkForBanAlternative(Request $request, ChocolateyId $chocolateyId) {
			0 ignored issues – show Unused Code introduced 2017-05-09 17:41 UTC by Report Bug Copy Issue Report The parameter `$chocolateyId` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
76			$temporaryUsers = UserModel::where('mail', $request->json()->get('email'))->get();
77
78			foreach($temporaryUsers as $forUser) {
79			if(!$forUser->isBanned()) {
80			return $forUser;
81			}
82			}
83
84			return $temporaryUsers->get(0);
85			}
86
87			/**
88			* Get Users
89			*
90			* @param Request $request
91			* @param ChocolateyId $chocolateyId
92			*
93			* @return UserModel
94			*/
95			private function retrieveUser(Request $request, ChocolateyId $chocolateyId) {
96			if($chocolateyId->last_logged_id != 0) {
97			$temporaryUser = UserModel::find($chocolateyId->last_logged_id);
98
99			if($temporaryUser->isBanned()) {
100			return $this->checkForBanAlternative($request, $chocolateyId);
101			}
102
103			return $temporaryUser;
104			}
105
106			$temporaryUser = UserModel::where('mail', $request->json()->get('email'))->first();
107
108			if($temporaryUser->isBanned()) {
109			return $this->checkForBanAlternative($request, $chocolateyId);
110			}
111
112			return $temporaryUser;
113			}
114
115			/**
116			* Set Session From Login Credentials.
117			*
118			* @param Request $request
119			*
120			* @return UserModel
121			*/
122			public function loginUser(Request $request)
123			{
124			$chocolateyId = ChocolateyId::find($request->json()->get('email'));
125
126			if ($chocolateyId == null) {
127			return null;
128			}
129
130			$user = $this->retrieveUser($request, $chocolateyId);
131
132			$chocolateyId->last_logged_id = $user->uniqueId;
133
134			return $chocolateyId->password == hash(Config::get('chocolatey.security.hash'), $request->json()->get('password'))
135			? $this->setSession($user) : null;
136			}
137
138			/**
139			* Return if USer Session Exists.
140			*
141			* @return bool
142			*/
143			public function hasSession()
144			{
145			return (bool) Session::get(Config::get('chocolatey.security.session'));
146			}
147
148			/**
149			* Erase User Session.
150			*/
151			public function eraseSession()
152			{
153			Session::erase(Config::get('chocolatey.security.session'));
154			}
155			}
156

sant0ro / chocolatey

Push — development ( 3ace6a )

User::checkForBanAlternative() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like