User::verifyQuestion() - Code Metrics - Inspection of "new sql setup" - Nicklas766/Comment - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Push — master ( 7c8781...44e581 )

by Nicklas

created 2017-10-23 15:42 UTC

User::verifyQuestion() A

↳ Parent: User

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1.037

Importance

Changes

Metric	Value
dl	0
loc	5
ccs	2
cts	3
cp	0.6667
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	3
nc	1
nop	2
crap	1.037

<?php

namespace Nicklas\Comment\Modules;

/**
 * A database driven model.
 */
class User extends ActiveRecordModelExtender
{

        /**
     * @var string $tableName name of the database table.
     */
    protected $tableName = "coffee_users";

    /**
     * Columns in the table.
     *
     * @var integer $id primary key auto incremented.
     */
    public $id;
    public $name;
    public $email;
    public $pass;
    public $authority = "user";
    public $question;

    public function getReputation($user)
    {
        // Get all the vote->scores connected to users posts
        $questionPoints = array_reduce($user->questions, function ($carry, $item) {
            $carry += $item->question->vote->score;
            return $carry;
        });

        $postPoints = array_reduce($user->posts, function ($carry, $item) {
            $carry += $item->vote->score;
            return $carry;
        });

        $commentPoints = array_reduce($user->comments, function ($carry, $item) {
            $carry += $item->vote->score;
            return $carry;
        });

        $points =
        ($questionPoints * 2) +
        ($postPoints     * 3) +
        ($commentPoints  * 1);

        // Algorithm for reputation points
        $reputation =
        (count($user->questions) * 2)   +
        (count($user->posts)     * 3)   +
        (count($user->comments)  * 1)   + $points;

         return $reputation;
    }


    /**
     * Sets up user
     * @param object $user
     *
     * @return object
     */
    public function setupUser($user)
    {
        $question = new Question($this->db);
        $post     = new Post($this->db);
        $comment  = new Comment($this->db);
        $vote     = new Vote($this->db);

        // Basic setup for user
        $user->img        = $this->getGravatar($user->name);

        // Get all posts/votes user made
        $user->questions  = $question->getQuestions("user = ?", $user->name);
        $user->comments   = $comment->getComments("user = ?", $user->name);
        $user->posts      = $post->getAllPosts("user = ? AND type = ?", [$user->name, "answer"]);
        $user->votes      = $vote->getVote("user = ?", [$user->name]);

        // Amount of posts
        $user->postAmount = count($user->questions) + count($user->posts) + count($user->comments);

        // Algorithm for reputation points
        $user->reputation = $this->getReputation($user);

        // Get all the questions connected to answers
        $user->answeredQuestions = array_map(function ($answer) {
            $question = new Question($this->db);
            return $question->getQuestion($answer->questionId);
        }, $user->posts);

        return $user;
    }

    /**
     * Returns post with markdown and gravatar
     * @param string $sql
     * @param array $param
/**
 * @param array $germany
 * @param array $ireland
 */
function finale($germany, $island) {
    return "2:1";
}
     *
     * @return array
     */
    public function getAllUsers($sql = null, $params = null)

    {
        if ($sql == null) {

            $users = $this->findAll();
        }
        if ($sql != null) {

            $users = $this->findAllWhere($sql, $params);
        }

        return array_map(array($this, 'setupUser'), $users);
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
    }

    /**
     * return question/answer, three attributes are set, comments connected to them is an array.
     * @param string $name
     *
     * @return object
    */
    public function getUser($name)
    {
        $user = $this->find("name", $name);
        $user = $this->setupUser($user);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        return $user;
    }


    /**
     * Check if user exists
     *
     * @param string $name
     *
     * @return boolean true if user exists in database else false
     */
    public function userExists($name)
    {
        $user = $this->find("name", $name);
        return !$user ? false : true;
    }
    /**
     * Returns gravatar link
     *
     * @param string $email
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     *
     * @return string as gravatar link
     */
    public function setGravatar()
    {
        $this->img = $this->gravatar($this->email);
class MyClass { }

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

    /**
     * Returns gravatar link
     *
     * @param string $name
     *
     * @return string as gravatar link
     */
    public function getGravatar($name)
    {
        $this->find("name", $name);
        return $this->gravatar($this->email);
    }

    /**
     * Set the pass.
     *
     * @param string $pass the pass to use.
     *
     * @return void
     */
    public function setPassword($pass)
    {
        $this->pass = password_hash($pass, PASSWORD_DEFAULT);
    }

    /**
     * Verify the name and the pass, if successful the object contains
     * all details from the database row.
     *
     * @param string $name  name to check.
     * @param string $pass the pass to use.
     *
     * @return boolean true if name and pass matches, else false.
     */
    public function verifyPassword($name, $pass)
    {
        $this->find("name", $name);
        return password_verify($pass, $this->pass);
    }

    /**
     * Verify the name and the anaswer, if successful the object contains
     * all details from the database row.
     *
     * @param string $name  name to check.
     * @param string $answer the answer.
     *
     * @return boolean true if name and pass matches, else false.
     */
    public function verifyQuestion($name, $answer)
    {
        $this->find("name", $name);
        return ($this->question == $answer);
    }


    /**
    * Check if a post belongs to user
    *
    *
    * @return boolean
    */
    public function controlAuthority($loggedUser, $name)
    {
        $this->find("name", $loggedUser);
        // IF AUTHORITY == admin, then continue
        if ($this->authority != "admin") {
            return ($this->name == $name);
        }
        return true;
    }
}


1			<?php
2
3			namespace Nicklas\Comment\Modules;
4
5			/**
6			* A database driven model.
7			*/
8			class User extends ActiveRecordModelExtender
9			{
10
11			/**
12			* @var string $tableName name of the database table.
13			*/
14			protected $tableName = "coffee_users";
15
16			/**
17			* Columns in the table.
18			*
19			* @var integer $id primary key auto incremented.
20			*/
21			public $id;
22			public $name;
23			public $email;
24			public $pass;
25			public $authority = "user";
26			public $question;
27
28			public function getReputation($user)
29			{
30			// Get all the vote->scores connected to users posts
31			$questionPoints = array_reduce($user->questions, function ($carry, $item) {
32			$carry += $item->question->vote->score;
33			return $carry;
34			});
35
36			$postPoints = array_reduce($user->posts, function ($carry, $item) {
37			$carry += $item->vote->score;
38			return $carry;
39			});
40
41			$commentPoints = array_reduce($user->comments, function ($carry, $item) {
42			$carry += $item->vote->score;
43			return $carry;
44			});
45
46			$points =
47			($questionPoints * 2) +
48			($postPoints * 3) +
49			($commentPoints * 1);
50
51			// Algorithm for reputation points
52			$reputation =
53			(count($user->questions) * 2) +
54			(count($user->posts) * 3) +
55			(count($user->comments) * 1) + $points;
56
57			return $reputation;
58			}
59
60
61			/**
62			* Sets up user
63			* @param object $user
64			*
65			* @return object
66			*/
67			public function setupUser($user)
68			{
69			$question = new Question($this->db);
70			$post = new Post($this->db);
71			$comment = new Comment($this->db);
72			$vote = new Vote($this->db);
73
74			// Basic setup for user
75			$user->img = $this->getGravatar($user->name);
76
77			// Get all posts/votes user made
78			$user->questions = $question->getQuestions("user = ?", $user->name);
79			$user->comments = $comment->getComments("user = ?", $user->name);
80			$user->posts = $post->getAllPosts("user = ? AND type = ?", [$user->name, "answer"]);
81			$user->votes = $vote->getVote("user = ?", [$user->name]);
82
83			// Amount of posts
84			$user->postAmount = count($user->questions) + count($user->posts) + count($user->comments);
85
86			// Algorithm for reputation points
87			$user->reputation = $this->getReputation($user);
88
89			// Get all the questions connected to answers
90			$user->answeredQuestions = array_map(function ($answer) {
91			$question = new Question($this->db);
92			return $question->getQuestion($answer->questionId);
93			}, $user->posts);
94
95			return $user;
96			}
97
98			/**
99			* Returns post with markdown and gravatar
100			* @param string $sql
101			* @param array $param
			0 ignored issues – show Documentation introduced 2017-10-21 15:30 UTC by Report Bug Copy Issue Report There is no parameter named `$param`. Did you maybe mean `$params`? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. It has, however, found a similar but not annotated parameter which might be a good fit. Consider the following example. The parameter `$ireland` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $ireland */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was changed, but the annotation was not. Loading history...
102			*
103			* @return array
104			*/
105	2	View Code Duplication	public function getAllUsers($sql = null, $params = null)
			0 ignored issues – show Duplication introduced 2017-10-21 11:13 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
106			{
107	2		if ($sql == null) {
			0 ignored issues – show Bug introduced 2017-10-19 08:41 UTC by Report Bug Copy Issue Report It seems like you are loosely comparing `$sql` of type `string\|null` against `null`; this is ambiguous if the string can be empty. Consider using a strict comparison `===` instead. Loading history...
108	2		$users = $this->findAll();
109			}
110			if ($sql != null) {
			0 ignored issues – show Bug introduced 2017-10-19 08:41 UTC by Report Bug Copy Issue Report It seems like you are loosely comparing `$sql` of type `string\|null` against `null`; this is ambiguous if the string can be empty. Consider using a strict comparison `!==` instead. Loading history...
111			$users = $this->findAllWhere($sql, $params);
112			}
113
114			return array_map(array($this, 'setupUser'), $users);
			0 ignored issues – show Bug introduced 2017-10-19 10:30 UTC by Report Bug Copy Issue Report The variable `$users` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
115			}
116
117			/**
118			* return question/answer, three attributes are set, comments connected to them is an array.
119			* @param string $name
120			*
121			* @return object
122			*/
123	3		public function getUser($name)
124			{
125	3		$user = $this->find("name", $name);
126			$user = $this->setupUser($user);
			0 ignored issues – show Documentation introduced 2017-10-21 15:02 UTC by Report Bug Copy Issue Report `$user` is of type `array`, but the function expects a `object`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
127			return $user;
128			}
129
130
131			/**
132			* Check if user exists
133			*
134			* @param string $name
135			*
136			* @return boolean true if user exists in database else false
137			*/
138	1		public function userExists($name)
139			{
140	1		$user = $this->find("name", $name);
141			return !$user ? false : true;
142			}
143			/**
144			* Returns gravatar link
145			*
146			* @param string $email
			0 ignored issues – show Bug introduced 2017-10-04 08:37 UTC by Report Bug Copy Issue Report There is no parameter named `$email`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
147			*
148			* @return string as gravatar link
149			*/
150	1		public function setGravatar()
151			{
152	1		$this->img = $this->gravatar($this->email);
			0 ignored issues – show Bug introduced 2017-10-04 08:37 UTC by Report Bug Copy Issue Report The property `img` 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...
153	1		}
154
155			/**
156			* Returns gravatar link
157			*
158			* @param string $name
159			*
160			* @return string as gravatar link
161			*/
162			public function getGravatar($name)
163			{
164			$this->find("name", $name);
165			return $this->gravatar($this->email);
166			}
167
168			/**
169			* Set the pass.
170			*
171			* @param string $pass the pass to use.
172			*
173			* @return void
174			*/
175	4		public function setPassword($pass)
176			{
177	4		$this->pass = password_hash($pass, PASSWORD_DEFAULT);
178	4		}
179
180			/**
181			* Verify the name and the pass, if successful the object contains
182			* all details from the database row.
183			*
184			* @param string $name name to check.
185			* @param string $pass the pass to use.
186			*
187			* @return boolean true if name and pass matches, else false.
188			*/
189	2		public function verifyPassword($name, $pass)
190			{
191	2		$this->find("name", $name);
192			return password_verify($pass, $this->pass);
193			}
194
195			/**
196			* Verify the name and the anaswer, if successful the object contains
197			* all details from the database row.
198			*
199			* @param string $name name to check.
200			* @param string $answer the answer.
201			*
202			* @return boolean true if name and pass matches, else false.
203			*/
204	1		public function verifyQuestion($name, $answer)
205			{
206	1		$this->find("name", $name);
207			return ($this->question == $answer);
208			}
209
210
211			/**
212			* Check if a post belongs to user
213			*
214			*
215			* @return boolean
216			*/
217			public function controlAuthority($loggedUser, $name)
218			{
219			$this->find("name", $loggedUser);
220			// IF AUTHORITY == admin, then continue
221			if ($this->authority != "admin") {
222			return ($this->name == $name);
223			}
224			return true;
225			}
226			}
227

Nicklas766 / Comment

Push — master ( 7c8781...44e581 )

User::verifyQuestion() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like