PollsController - Code Metrics - Inspection of "Add the administration of the Poll system" - XetaIO/Xeta - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#220)

by Fèvre

created 2017-04-23 01:32 UTC

PollsController A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	224
Duplicated Lines	42.86 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes

Metric	Value
wmc	20
lcom	1
cbo	5
dl	96
loc	224
rs	10
c	0
b	0
f	0

4 Methods

Rating	Name	Duplication	Size	Complexity
B	index()	24	24	1
B	add()	31	64	7
C	edit()	15	84	9
B	delete()	26	26	3

How to fix Duplicated Code

<?php
namespace App\Controller\Admin;

use App\Controller\AppController;
use Cake\Routing\Router;

class PollsController extends AppController
{
    /**
     * Display all Polls.
     *
     * @return \Cake\Network\Response
     */
    public function index()

    {
        $this->loadModel('Polls');

        $this->paginate = [
            'maxLimit' => 15
        ];

        $polls = $this->Polls
<?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([
                'Users' => function ($q) {
                    return $q->find('short');
                },
                'PollsAnswers',
                'BlogArticles'
            ])
            ->order([
                'Polls.created' => 'desc'
            ]);

        $polls = $this->paginate($polls);
        $this->set(compact('polls'));
    }

    /**
     * Create a Poll.
     *
     * @return \Cake\Network\Response|void
     */
    public function add()
    {
        $this->loadModel('BlogArticles');
        $this->loadModel('Polls');
        $this->loadModel('PollsAnswers');

        $poll = $this->Polls->newEntity($this->request->getParsedBody());
<?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.");
        }
    }

}
        $articles = $this->Polls->BlogArticles->find('list');
<?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->request->is('post')) {
            $article = $this->BlogArticles
<?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([
                    'BlogArticles.id' => $poll->article_id
                ])
                ->first();

            //Check if the article has already a poll
            if (!is_null($article->poll)) {

                $this->Flash->error(
                    __d(
                        'admin',
                        'This article has already a poll, you can edit it <a href="{0}" class="btn btn-sm btn-danger-outline">here</a>.',
                        Router::url(['_name' => 'polls-edit', 'id' => $article->poll->id, 'slug' => $article->poll->name])
                    )
                );

                return $this->redirect(['action' => 'index']);
            }

            $pollAnswers = [];

            foreach ($poll->answers as $answers => $answer) {

                $answer = trim($answer);

                if (!empty($answer)) {
                    $entity = $this->Polls->PollsAnswers->newEntity();
<?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.");
        }
    }

}
                    $entity->response = $answer;
                    array_push($pollAnswers, $entity);
                }
            }

            if (empty($pollAnswers)) {

                $this->Flash->error(__d('admin', 'You must add at least one answer for this poll.'));
                $this->set(compact('poll', 'articles'));

                return;
            }
            $poll->user_id = $this->Auth->user('id');
            $poll->polls_answers = $pollAnswers;
            $poll->unsetProperty('anwsers');

            if ($poll = $this->Polls->save($poll)) {
<?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(__d('admin', 'Your poll has been created successfully !'));

                return $this->redirect(['action' => 'index']);
            }
        }

        $this->set(compact('poll', 'articles'));
    }

    /**
     * Edit a Poll.
     *
     * @return \Cake\Network\Response
     */
    public function edit()
    {
        $this->loadModel('Polls');
        $this->loadModel('BlogArticles');

        $poll = $this->Polls
<?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([
                'id' => $this->request->getAttribute('params')['id']
            ])
            ->first();

        //Check if the poll is found.
        if (empty($poll)) {
            $this->Flash->error(__d('admin', 'This poll doesn\'t exist or has been deleted.'));

            return $this->redirect(['action' => 'index']);
        }

        if ($this->request->is(['put', 'post'])) {
            $this->Polls->patchEntity($poll, $this->request->getParsedBody());
<?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.");
        }
    }

}
            $articles = $this->Polls->BlogArticles->find('list');
<?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.");
        }
    }

}

            //Check if the article has already a poll
            $article = $this->BlogArticles
<?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([
                    'BlogArticles.id' => $poll->article_id
                ])
                ->first();

            //Check if the article has already a poll
            if (!is_null($article->poll) && $article->poll->id != $this->request->getAttribute('params')['id']) {
                $this->Flash->error(
                    __d(
                        'admin',
                        'This article has already a poll, you can edit it <a href="{0}" class="btn btn-sm btn-danger-outline">here</a>.',
                        Router::url(['_name' => 'polls-edit', 'id' => $article->poll->id, 'slug' => $article->poll->name])
                    )
                );

                return $this->redirect(['action' => 'index']);
            }

            $poll->polls_answers = [];

            foreach ($poll->answers as $answers => $answer) {

                $answer = trim($answer);

                if (!empty($answer)) {
                    $entity = $this->Polls->PollsAnswers->newEntity();
<?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.");
        }
    }

}
                    $entity->response = $answer;
                    array_push($poll->polls_answers, $entity);
                }
            }

            if (empty($poll->polls_answers)) {

                $this->Flash->error(__d('admin', 'You must add at least one answer for this poll.'));
                $this->set(compact('poll', 'articles'));

                return;
            }

            $poll->user_id = $this->Auth->user('id');
            $poll->unsetProperty('anwsers');

            if ($poll = $this->Polls->save($poll)) {
<?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(__d('admin', 'Your poll has been edited successfully !'));
            } else {
                $this->Flash->error(__d('admin', 'An error occurred while editing the poll.'));
            }

            return $this->redirect(['action' => 'index']);
        }

        $articles = $this->Polls->BlogArticles->find('list');
<?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->set(compact('poll', 'articles'));
    }

    /**
     * Delete a Poll.
     *
     * @return \Cake\Network\Response
     */
    public function delete()

    {
        $this->loadModel('Polls');

        $poll = $this->Polls
<?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()
            ->where([
                'id' => $this->request->getAttribute('params')['id']
            ])
            ->first();

        //Check if the poll is found.
        if (empty($poll)) {
            $this->Flash->error(__d('admin', 'This poll doesn\'t exist or has been deleted.'));

            return $this->redirect(['action' => 'index']);
        }

        if ($this->Polls->delete($poll)) {
<?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(__d('admin', 'This poll has been deleted successfully !'));
        } else {
            $this->Flash->error(__d('admin', 'Unable to delete this poll.'));
        }

        return $this->redirect(['action' => 'index']);
    }
}


1		<?php
2		namespace App\Controller\Admin;
3
4		use App\Controller\AppController;
5		use Cake\Routing\Router;
6
7		class PollsController extends AppController
8		{
9		/**
10		* Display all Polls.
11		*
12		* @return \Cake\Network\Response
13		*/
14	View Code Duplication	public function index()
		0 ignored issues – show Duplication introduced 2016-10-31 13:59 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...
15		{
16		$this->loadModel('Polls');
17
18		$this->paginate = [
19		'maxLimit' => 15
20		];
21
22		$polls = $this->Polls
		0 ignored issues – show Documentation introduced 2017-04-23 02:46 UTC by Report Bug Copy Issue Report The property `Polls` does not exist on `object<App\Controller\Admin\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...
23		->find()
24		->contain([
25		'Users' => function ($q) {
26		return $q->find('short');
27		},
28		'PollsAnswers',
29		'BlogArticles'
30		])
31		->order([
32		'Polls.created' => 'desc'
33		]);
34
35		$polls = $this->paginate($polls);
36		$this->set(compact('polls'));
37		}
38

XetaIO / Xeta

Pull Request — master (#220)

PollsController A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

4 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like