PollsController::vote() - Code Metrics - Inspection of "Add Polls feature" - XetaIO/Xeta - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#210)

by Fèvre

created 2016-12-15 15:59 UTC

PollsController::vote() C

↳ Parent: PollsController

Complexity

Conditions	8
Paths	6

Size

Total Lines	62
Code Lines	38

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
dl	0
loc	62
rs	6.943
c	1
b	0
f	0
cc	8
eloc	38
nc	6
nop	0

How to fix Long Method

<?php
namespace App\Controller;

use Cake\I18n\Time;
use Cake\Network\Exception\NotFoundException;

class PollsController extends AppController
{
    /**
     * Initialization hook method.
     *
     * @return void
     */
    public function initialize()
    {
        parent::initialize();
        $this->loadComponent('Security');
    }

    /**
     * An user vote to a poll.
     *
     * @return \Cake\Network\Exception\NotFoundException|\Cake\Network\Response
     */
    public function vote()
    {
        if (!$this->request->is('post') || !isset($this->request->data['answer_id'])) {
            throw new NotFoundException();
        }

        $this->loadModel('PollsAnswers');
        $answer = $this->PollsAnswers
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            ->find()
            ->contain([
                'Polls'
            ])
            ->where([
                'PollsAnswers.id' => $this->request->data['answer_id'],
                'Polls.article_id' => $this->request->id
            ])
            ->first();

        if (is_null($answer)) {
            $this->Flash->error(__('This answer doesn\'t exist.'));

            return $this->redirect($this->referer());

        }

        if ($answer->poll->is_timed == true && $answer->poll->end_date < new Time()) {
            $this->Flash->error(__('This poll is expired, you can not vote anymore.'));

            return $this->redirect($this->referer());

        }

        $this->loadModel('PollsUsers');
        $hasVoted = $this->PollsUsers
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            ->find()
            ->contain([
                'PollsAnswers'
            ])
            ->where([
                'PollsUsers.poll_id' => $answer->poll->id,
                'PollsUsers.user_id' => $this->Auth->user('id')
            ])
            ->first();

        if (!is_null($hasVoted)) {
            $this->Flash->error(__('You have already voted for this poll ! (You voted <strong>{0}</strong>)', h($hasVoted->polls_answer->response)));

            return $this->redirect($this->referer());

        }

        $this->request->data['poll_id'] = $answer->poll->id;
        $this->request->data['user_id'] = $this->Auth->user('id');
        $user = $this->PollsUsers->newEntity($this->request->data);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

        if ($this->PollsUsers->save($user)) {
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            $this->Flash->success(__('Your have successfully voted for this poll ! (You voted <strong>{0}</strong>)', h($answer->response)));

            return $this->redirect($this->referer());

        }

        $this->Flash->error(__('An error occured while saving the vote !'));

        return $this->redirect($this->referer());

    }
}


1			<?php
2			namespace App\Controller;
3
4			use Cake\I18n\Time;
5			use Cake\Network\Exception\NotFoundException;
6
7			class PollsController extends AppController
8			{
9			/**
10			* Initialization hook method.
11			*
12			* @return void
13			*/
14			public function initialize()
15			{
16			parent::initialize();
17			$this->loadComponent('Security');
18			}
19
20			/**
21			* An user vote to a poll.
22			*
23			* @return \Cake\Network\Exception\NotFoundException\|\Cake\Network\Response
24			*/
25			public function vote()
26			{
27			if (!$this->request->is('post') \|\| !isset($this->request->data['answer_id'])) {
28			throw new NotFoundException();
29			}
30
31			$this->loadModel('PollsAnswers');
32			$answer = $this->PollsAnswers
			0 ignored issues – show Documentation introduced 2016-12-14 21:44 UTC by Report Bug Copy Issue Report The property `PollsAnswers` does not exist on `object<App\Controller\PollsController>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
33			->find()
34			->contain([
35			'Polls'
36			])
37			->where([
38			'PollsAnswers.id' => $this->request->data['answer_id'],
39			'Polls.article_id' => $this->request->id
40			])
41			->first();
42
43			if (is_null($answer)) {
44			$this->Flash->error(__('This answer doesn\'t exist.'));
45
46			return $this->redirect($this->referer());
			0 ignored issues – show Bug introduced 2016-12-15 16:01 UTC by Report Bug Copy Issue Report It seems like `$this->referer()` targeting `Cake\Controller\Controller::referer()` can also be of type `object<Cake\Network\Request>`; however, `Cake\Controller\Controller::redirect()` does only seem to accept `string\|array`, maybe add an additional type check? This check looks at variables that are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
47			}
48
49			if ($answer->poll->is_timed == true && $answer->poll->end_date < new Time()) {
50			$this->Flash->error(__('This poll is expired, you can not vote anymore.'));
51
52			return $this->redirect($this->referer());
			0 ignored issues – show Bug introduced 2016-12-15 16:01 UTC by Report Bug Copy Issue Report It seems like `$this->referer()` targeting `Cake\Controller\Controller::referer()` can also be of type `object<Cake\Network\Request>`; however, `Cake\Controller\Controller::redirect()` does only seem to accept `string\|array`, maybe add an additional type check? This check looks at variables that are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
53			}
54
55			$this->loadModel('PollsUsers');
56			$hasVoted = $this->PollsUsers
			0 ignored issues – show Documentation introduced 2016-12-14 21:44 UTC by Report Bug Copy Issue Report The property `PollsUsers` does not exist on `object<App\Controller\PollsController>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
57			->find()
58			->contain([
59			'PollsAnswers'
60			])
61			->where([
62			'PollsUsers.poll_id' => $answer->poll->id,
63			'PollsUsers.user_id' => $this->Auth->user('id')
64			])
65			->first();
66
67			if (!is_null($hasVoted)) {
68			$this->Flash->error(__('You have already voted for this poll ! (You voted <strong>{0}</strong>)', h($hasVoted->polls_answer->response)));
69
70			return $this->redirect($this->referer());
			0 ignored issues – show Bug introduced 2016-12-15 16:01 UTC by Report Bug Copy Issue Report It seems like `$this->referer()` targeting `Cake\Controller\Controller::referer()` can also be of type `object<Cake\Network\Request>`; however, `Cake\Controller\Controller::redirect()` does only seem to accept `string\|array`, maybe add an additional type check? This check looks at variables that are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
71			}
72
73			$this->request->data['poll_id'] = $answer->poll->id;
74			$this->request->data['user_id'] = $this->Auth->user('id');
75			$user = $this->PollsUsers->newEntity($this->request->data);
			0 ignored issues – show Documentation introduced 2016-12-14 21:44 UTC by Report Bug Copy Issue Report The property `PollsUsers` does not exist on `object<App\Controller\PollsController>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
76
77			if ($this->PollsUsers->save($user)) {
			0 ignored issues – show Documentation introduced 2016-12-14 21:44 UTC by Report Bug Copy Issue Report The property `PollsUsers` does not exist on `object<App\Controller\PollsController>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
78			$this->Flash->success(__('Your have successfully voted for this poll ! (You voted <strong>{0}</strong>)', h($answer->response)));
79
80			return $this->redirect($this->referer());
			0 ignored issues – show Bug introduced 2016-12-15 16:01 UTC by Report Bug Copy Issue Report It seems like `$this->referer()` targeting `Cake\Controller\Controller::referer()` can also be of type `object<Cake\Network\Request>`; however, `Cake\Controller\Controller::redirect()` does only seem to accept `string\|array`, maybe add an additional type check? This check looks at variables that are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
81			}
82
83			$this->Flash->error(__('An error occured while saving the vote !'));
84
85			return $this->redirect($this->referer());
			0 ignored issues – show Bug introduced 2016-12-15 16:01 UTC by Report Bug Copy Issue Report It seems like `$this->referer()` targeting `Cake\Controller\Controller::referer()` can also be of type `object<Cake\Network\Request>`; however, `Cake\Controller\Controller::redirect()` does only seem to accept `string\|array`, maybe add an additional type check? This check looks at variables that are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
86			}
87			}
88

XetaIO / Xeta

Pull Request — master (#210)

PollsController::vote() C

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like