QuizController - Code Metrics - Inspection of "Merge pull request #286 from gregorybesson/develop" - gregorybesson/PlaygroundGame - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( f7296b...16f165 )

by greg

created 2016-01-11 08:37 UTC

QuizController F

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	402
Duplicated Lines	28.86 %

Coupling/Cohesion

Components	1
Dependencies	15

Importance

Changes	10
Bugs	0	Features	0

Metric	Value
wmc	63
c	10
b	0
f	0
lcom	1
cbo	15
dl	116
loc	402
rs	3.6585

7 Methods

Rating	Name	Duplication	Size	Complexity
A	fbshareAction()	21	21	4
A	fbrequestAction()	20	20	4
A	tweetAction()	20	20	4
A	googleAction()	20	20	4
A	getGameService()	0	8	2
F	playAction()	11	162	27
F	resultAction()	24	136	18

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like QuizController often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use QuizController, and based on these observations, apply Extract Interface, too.

<?php
namespace PlaygroundGame\Controller\Frontend;

use Zend\Form\Element;
use Zend\Form\Fieldset;
use Zend\Form\Form;
use Zend\InputFilter\Factory as InputFactory;

class QuizController extends GameController
{
    /**
     *
     * @var gameService
     */
    protected $gameService;

    public function playAction()
    {
        $redirectFb = $this->checkFbRegistration($this->user, $this->game);
        if ($redirectFb) {
            return $redirectFb;
        }

        $entry = $this->getGameService()->play($this->game, $this->user);
        if (!$entry) {

            // the user has already taken part of this game and the participation limit has been reached
            $this->flashMessenger()->addMessage('Vous avez déjà participé!');

            return $this->redirect()->toUrl(
                $this->frontendUrl()->fromRoute(
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
                    $this->game->getClassType() . '/result',
                    array('id' => $this->game->getIdentifier())
                )
            );
        }

        $reply = $this->getGameService()->getQuizReplyMapper()->getLastGameReply($entry);
        $userAnswers = array();
        if($reply){
            foreach ($reply->getAnswers() as $answer) {
                $userAnswers[$answer->getQuestionId()][$answer->getAnswerId()] = true;
                $userAnswers[$answer->getQuestionId()]['answer'] = $answer->getAnswer();
            }
        }

        $questions = $this->game->getQuestions();
        $totalQuestions = count($questions);

        $form = new Form();

        $inputFilter = new \Zend\InputFilter\InputFilter();
        $factory = new InputFactory();

        $i = 0;
        $j = 0;
        $elementData = array();
        $explanations = array();

        foreach ($questions as $q) {
            if (
                ($this->game->getQuestionGrouping() > 0 && $i % $this->game->getQuestionGrouping() === 0) ||
                ($i === 0 && $this->game->getQuestionGrouping() === 0)
            ) {
                $fieldsetName = 'questionGroup' . ++ $j;
                $fieldset = new Fieldset($fieldsetName);
            }
            $name = 'q' . $q->getId();
            $fieldsetFilter = new \Zend\InputFilter\InputFilter();
            if ($q->getType() === 0) {
                $element = new Element\Radio($name);
                $values = array();
                $valuesSortedByPosition = array();
                foreach ($q->getAnswers() as $a) {
                    $values[$a->getPosition()] = array(
                        'id' => $a->getId(),
                        'position' => $a->getPosition(),
                        'answer' => $a->getAnswer(),
                        );
                    $explanations[$a->getAnswer()] = $a->getExplanation();
                }
                ksort($values);
                foreach ($values as $key => $value) {
                    $valuesSortedByPosition[$value['id']] = $value['answer'];
                }
                $element->setValueOptions($valuesSortedByPosition);
                $element->setLabelOptions(array("disable_html_escape"=>true));
                $elementData[$q->getId()] = new Element\Hidden($name.'-data');
            } elseif ($q->getType() === 1) {
                $element = new Element\MultiCheckbox($name);
                $values = array();
                $valuesSortedByPosition = array();
                foreach ($q->getAnswers() as $a) {
                    $values[$a->getId()] = array(
                        'id' => $a->getId(),
                        'position' => $a->getPosition(),
                        'answer' => $a->getAnswer(),
                    );
                    $explanations[$a->getAnswer()] = $a->getExplanation();
                    $elementData[$a->getId()] = new Element\Hidden($name.'-'.$a->getId().'-data');
                }

                foreach ($values as $key => $value) {
                    $valuesSortedByPosition[$value['id']] = $value['answer'];
                }

                $element->setValueOptions($valuesSortedByPosition);
                $element->setLabelOptions(array("disable_html_escape"=>true));
            } elseif ($q->getType() == 2) {
                $element = new Element\Textarea($name);
                if(isset($userAnswers[$q->getId()])) $element->setValue($userAnswers[$q->getId()]['answer']);
                $elementData[$q->getId()] = new Element\Hidden($name.'-data');
            }

            $element->setLabel($q->getQuestion());
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

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

    // $x is potentially undefined here.
    echo $x;
}
            $fieldset->add($element);
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

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

    // $x is potentially undefined here.
    echo $x;
}
            if (is_array($elementData)) {
                foreach ($elementData as $id => $e) {
                    $fieldset->add($e);
                }
            } else {
                $fieldset->add($elementData);
            }

            $fieldsetFilter->add($factory->createInput(array(
                'name'     => $name,
                'required' => true,
                'validators'=>array(
                    array(
                        'name'=>'NotEmpty',
                        'options'=>array(
                            'messages'=>array(
                                'isEmpty' => 'Merci de répondre à la question.',
                            ),
                        ),
                    ),
                )
            )));

            $i ++;
            if (
                ($this->game->getQuestionGrouping() > 0 && $i % $this->game->getQuestionGrouping() == 0 && $i > 0) ||
                $i == $totalQuestions
            ) {
                $form->add($fieldset);
                $inputFilter->add($fieldsetFilter, $fieldsetName);
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

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

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

        $form->setInputFilter($inputFilter);

        if ($this->getRequest()->isPost()) {
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            $data = $this->getRequest()->getPost()->toArray();
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            $form->setData($data);

            // Improve it : I don't validate the form in a timer quiz as no answer is mandatory
            if ($this->game->getTimer() || $form->isValid()) {
                unset($data['submitForm']);
                $entry = $this->getGameService()->createQuizReply($data, $this->game, $this->user);
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
            }

            return $this->redirect()->toUrl(
                $this->frontendUrl()->fromRoute(
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
                    $this->game->getClassType() . '/'. $this->game->nextStep($this->params('action')),
                    array('id' => $this->game->getIdentifier())
                )
            );
        }

        $viewModel = $this->buildView($this->game);
        $viewModel->setVariables(array(
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            'questions' => $questions,
            'form'      => $form,
            'explanations' => $explanations,
            'flashMessages' => $this->flashMessenger()->getMessages(),
        ));

        return $viewModel;
    }

    public function resultAction()
    {
        $statusMail = null;
        $prediction = false;
        $userTimer = array();
        $secretKey = strtoupper(substr(sha1(uniqid('pg_', true).'####'.time()), 0, 15));
        $socialLinkUrl = $this->frontendUrl()->fromRoute(
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
            'quiz',
            array('id' => $this->game->getIdentifier()),
            array('force_canonical' => true)
        ).'?key='.$secretKey;

        // With core shortener helper
        $socialLinkUrl = $this->shortenUrl()->shortenUrl($socialLinkUrl);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }

        $lastEntry = $this->getGameService()->findLastEntry($this->game, $this->user);
        if (!$lastEntry) {

            return $this->redirect()->toUrl(
                $this->frontendUrl()->fromRoute(
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
                    'quiz',
                    array('id' => $this->game->getIdentifier()),
                    array('force_canonical' => true)
                )
            );
        }

        // je compte les bonnes réponses et le ratio
        $maxCorrectAnswers = $this->game->getMaxCorrectAnswers();
        $winner = $lastEntry->getWinner();
        $reply = $this->getGameService()->getQuizReplyMapper()->getLastGameReply($lastEntry);
        $userCorrectAnswers = 0;
        $correctAnswers = array();
        $userAnswers = array();
        
        foreach ($reply->getAnswers() as $answer) {
            if ($answer->getCorrect()) {
                $correctAnswers[$answer->getQuestionId()][$answer->getAnswerId()] = true;
                ++$userCorrectAnswers;
            }
            $userAnswers[$answer->getQuestionId()][$answer->getAnswerId()] = true;
            $userAnswers[$answer->getQuestionId()]['answer'] = $answer->getAnswer();
        }

        $ratioCorrectAnswers = 0;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        if ($maxCorrectAnswers > 0) {
            $ratioCorrectAnswers = ($userCorrectAnswers / $maxCorrectAnswers) * 100;
        } else {
            $ratioCorrectAnswers = 100;
        }

        if ($this->game->getTimer()) {
            $timer = $this->getGameService()->getEntryMapper()->findOneBy(
                array('game' => $this->game, 'user'=> $this->user)
            );
            $start = $timer->getCreatedAt()->format('U');
            $end = $timer->getUpdatedAt()->format('U');
            $userTimer = array(
               'ratio'  => $ratioCorrectAnswers,
               'timer'  => $end - $start,
            );
        }

        // Je prépare le tableau des bonnes réponses trouvées et non trouvées
        $ga = array();
        $questions = $this->game->getQuestions();
        foreach ($questions as $q) {
            foreach ($q->getAnswers() as $a) {
                if ($a->getCorrect()) {
                    $ga[$q->getId()]['question'] = $q;
                    $ga[$q->getId()]['answers'][$a->getId()]['answer'] = $a->getAnswer();
                    $ga[$q->getId()]['answers'][$a->getId()]['explanation'] = $a->getExplanation();
                    $ga[$q->getId()]['answers'][$a->getId()]['userAnswer'] = isset($userAnswers[$q->getId()]) ?
                        $userAnswers[$q->getId()]['answer'] :
                        false;

                    if (isset($correctAnswers[$q->getId()]) && isset($correctAnswers[$q->getId()][$a->getId()])) {

                        $ga[$q->getId()]['answers'][$a->getId()]['found'] = true;
                    } else {
                        $ga[$q->getId()]['answers'][$a->getId()]['found'] = false;
                    }
                    
                    if (isset($userAnswers[$q->getId()]) && isset($userAnswers[$q->getId()][$a->getId()])) {

                        $ga[$q->getId()]['answers'][$a->getId()]['yourChoice'] = true;
                    } else {
                        $ga[$q->getId()]['answers'][$a->getId()]['yourChoice'] = false;
                    }

                    $ga[$q->getId()]['answers'][$a->getId()]['correctAnswers'] = true;
                } else {
                    $ga[$q->getId()]['question'] = $q;
                    $ga[$q->getId()]['answers'][$a->getId()]['answer'] = $a->getAnswer();
                    $ga[$q->getId()]['answers'][$a->getId()]['explanation'] = $a->getExplanation();
                    $ga[$q->getId()]['answers'][$a->getId()]['correctAnswers'] = false;
                    $ga[$q->getId()]['answers'][$a->getId()]['userAnswer'] = isset($userAnswers[$q->getId()]) ?
                        $userAnswers[$q->getId()]['answer'] :
                        false;
                    
                    if (isset($userAnswers[$q->getId()]) && isset($userAnswers[$q->getId()][$a->getId()])) {

                        $ga[$q->getId()]['answers'][$a->getId()]['yourChoice'] = true;
                    } else {
                        $ga[$q->getId()]['answers'][$a->getId()]['yourChoice'] = false;
                    }
                }
            }
            // if only one question is a prediction, we can't determine if it's a winner or looser
            if ($q->getPrediction()) {
                $prediction = true;
            }
        }

        $form = $this->getServiceLocator()->get('playgroundgame_sharemail_form');
        $form->setAttribute('method', 'post');

        $viewModel = $this->buildView($this->game);
        
        $this->getGameService()->sendMail($this->game, $this->user, $lastEntry);

        $viewModel->setVariables(array(
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            'entry'               => $lastEntry,
            'statusMail'          => $statusMail,
            'form'                => $form,
            'winner'              => $winner,
            'prediction'          => $prediction,
            'userCorrectAnswers'  => $userCorrectAnswers,
            'maxCorrectAnswers'   => $maxCorrectAnswers,
            'ratioCorrectAnswers' => $ratioCorrectAnswers,
            'gameCorrectAnswers'  => $ga,
            'socialLinkUrl'       => $socialLinkUrl,
            'secretKey'           => $secretKey,
            'userTimer'           => $userTimer,
            'userAnswers'         => $userAnswers,
            'flashMessages'       => $this->flashMessenger()->getMessages(),
        ));

        return $viewModel;
    }

    public function fbshareAction()

    {
        $result = parent::fbshareAction();
        $bonusEntry = false;

        if ($result->getVariable('success')) {
            // Improve this thing
            $lastEntry = $this->getGameService()->findLastInactiveEntry($this->game, $this->user);
            if ($lastEntry && $lastEntry->getWinner()) {
                $bonusEntry = $this->getGameService()->addAnotherChance($this->game, $this->user, 1);
            }
        }

        $response = $this->getResponse();
        $response->setContent(\Zend\Json\Json::encode(array(
                'success' => $result,
                'playBonus' => $bonusEntry
        )));

        return $response;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    public function fbrequestAction()

    {
        $result = parent::fbrequestAction();
        $bonusEntry = false;

        if ($result->getVariable('success')) {
            $lastEntry = $this->getGameService()->findLastInactiveEntry($this->game, $this->user);
            if ($lastEntry && $lastEntry->getWinner()) {
                $bonusEntry = $this->getGameService()->addAnotherChance($this->game, $this->user, 1);
            }
        }

        $response = $this->getResponse();
        $response->setContent(\Zend\Json\Json::encode(array(
            'success' => $result,
            'playBonus' => $bonusEntry
        )));

        return $response;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    public function tweetAction()

    {
        $result = parent::tweetAction();
        $bonusEntry = false;

        if ($result->getVariable('success')) {
            $lastEntry = $this->getGameService()->findLastInactiveEntry($this->game, $this->user);
            if ($lastEntry && $lastEntry->getWinner()) {
                $bonusEntry = $this->getGameService()->addAnotherChance($this->game, $this->user, 1);
            }
        }

        $response = $this->getResponse();
        $response->setContent(\Zend\Json\Json::encode(array(
            'success' => $result,
            'playBonus' => $bonusEntry
        )));

        return $response;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    public function googleAction()

    {
        $result = parent::googleAction();
        $bonusEntry = false;

        if ($result->getVariable('success')) {
            $lastEntry = $this->getGameService()->findLastInactiveEntry($this->game, $this->user);
            if ($lastEntry && $lastEntry->getWinner()) {
                $bonusEntry = $this->getGameService()->addAnotherChance($this->game, $this->user, 1);
            }
        }

        $response = $this->getResponse();
        $response->setContent(\Zend\Json\Json::encode(array(
            'success' => $result,
            'playBonus' => $bonusEntry
        )));

        return $response;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    public function getGameService()
    {
        if (! $this->gameService) {
            $this->gameService = $this->getServiceLocator()->get('playgroundgame_quiz_service');
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
        }

        return $this->gameService;
    }
}


Push — master ( f7296b...16f165 )

QuizController F

Complexity

Size/Duplication

Coupling/Cohesion

Importance

7 Methods

How to fix Duplicated Code Complexity

Duplicated Code

Complex Class

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

gregorybesson / PlaygroundGame

Push — master ( f7296b...16f165 )

QuizController F

Complexity

Size/Duplication

Coupling/Cohesion

Importance

7 Methods

How to fix Duplicated Code Complexity

Duplicated Code

Complex Class

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like