InstantWinController - Code Metrics - Inspection of "refactoring admin controllers" - gregorybesson/PlaygroundGame - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 0bc71f...f6430f )

by greg

created 2015-11-25 19:52 UTC

InstantWinController C

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	381
Duplicated Lines	20.47 %

Coupling/Cohesion

Components	1
Dependencies	20

Importance

Changes	8
Bugs	0	Features	0

Metric	Value
wmc	30
c	8
b	0
f	0
lcom	1
cbo	20
dl	78
loc	381
rs	6.4706

11 Methods

Rating	Name	Duplication	Size	Complexity
A	removeAction()	0	8	1
B	createInstantWinAction()	0	45	4
B	editInstantWinAction()	62	62	6
A	listOccurrenceAction()	0	21	1
A	addOccurrenceAction()	0	51	3
B	importOccurrencesAction()	0	63	4
A	editOccurrenceAction()	16	55	4
B	removeOccurrenceAction()	0	24	3
A	exportOccurrencesAction()	0	19	1
A	getAdminGameService()	0	8	2
A	setAdminGameService()	0	6	1

How to fix Duplicated Code

<?php

namespace PlaygroundGame\Controller\Admin;

use PlaygroundGame\Entity\InstantWin;
use PlaygroundGame\Entity\InstantWinOccurrence;
use Zend\InputFilter;
use Zend\Validator;
use PlaygroundGame\Controller\Admin\GameController;
use Zend\View\Model\ViewModel;
use Zend\Paginator\Paginator;
use PlaygroundCore\ORM\Pagination\LargeTablePaginator;
use DoctrineORMModule\Paginator\Adapter\DoctrinePaginator as DoctrineAdapter;

class InstantWinController extends GameController
{
    /**
     * @var GameService
     */
    protected $adminGameService;

    public function removeAction()
    {
        $this->checkGame();
        $service->getGameMapper()->remove($this->game);

        $this->flashMessenger()->setNamespace('playgroundgame')->addMessage('The game has been removed');

        return $this->redirect()->toRoute('admin/playgroundgame/list');
    }

    public function createInstantWinAction()
    {
        $service = $this->getAdminGameService();
        $viewModel = new ViewModel();
        $viewModel->setTemplate('playground-game/instant-win/instantwin');

        $gameForm = new ViewModel();
        $gameForm->setTemplate('playground-game/game/game-form');

        $instantwin = new InstantWin();

        $form = $this->getServiceLocator()->get('playgroundgame_instantwin_form');
        $form->bind($instantwin);
        $form->setAttribute(
            'action',
            $this->url()->fromRoute('admin/playgroundgame/create-instantwin', array('gameId' => 0))
        );
        $form->setAttribute('method', 'post');

        $request = $this->getRequest();
        if ($request->isPost()) {
            $data = array_replace_recursive(
                $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.
    }
}
                $this->getRequest()->getFiles()->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.
    }
}
            );
            if (empty($data['prizes'])) {
                $data['prizes'] = array();
            }
            $game = $service->create($data, $instantwin, 'playgroundgame_instantwin_form');
            if ($game) {
                $this->flashMessenger()->setNamespace('playgroundgame')->addMessage('The game was created');

                return $this->redirect()->toRoute('admin/playgroundgame/list');
            }
        }
        $gameForm->setVariables(array('form' => $form, 'game' => $instantwin));
        $viewModel->addChild($gameForm, 'game_form');

        return $viewModel->setVariables(
            array(
                'form' => $form,
                'title' => 'Create instant win',
            )
        );
    }

    public function editInstantWinAction()

    {
        $this->checkGame();

        $viewModel = new ViewModel();
        $viewModel->setTemplate('playground-game/instant-win/instantwin');

        $gameForm = new ViewModel();
        $gameForm->setTemplate('playground-game/game/game-form');

        $form   = $this->getServiceLocator()->get('playgroundgame_instantwin_form');
        $form->setAttribute(
            'action',
            $this->url()->fromRoute(
                'admin/playgroundgame/edit-instantwin',
                array('gameId' => $this->game->getId())
            )
        );
        $form->setAttribute('method', 'post');

        if ($this->game->getFbAppId()) {
            $appIds = $form->get('fbAppId')->getOption('value_options');
            $appIds[$this->game->getFbAppId()] = $this->game->getFbAppId();
            $form->get('fbAppId')->setAttribute('options', $appIds);
        }

        $gameOptions = $this->getAdminGameService()->getOptions();
        $gameStylesheet = $gameOptions->getMediaPath() . '/' . 'stylesheet_'. $this->game->getId(). '.css';
        if (is_file($gameStylesheet)) {
            $values = $form->get('stylesheet')->getValueOptions();
            $values[$gameStylesheet] = 'Style personnalisé de ce jeu';

            $form->get('stylesheet')->setAttribute('options', $values);
        }

        $form->bind($this->game);

        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 = array_replace_recursive(
                $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.
    }
}
                $this->getRequest()->getFiles()->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.
    }
}
            );
            if (empty($data['prizes'])) {
                $data['prizes'] = array();
            }
            $result = $service->edit($data, $this->game, 'playgroundgame_instantwin_form');


            if ($result) {
                return $this->redirect()->toRoute('admin/playgroundgame/list');
            }
        }

        $gameForm->setVariables(array('form' => $form, 'game' => $this->game));
        $viewModel->addChild($gameForm, 'game_form');

        return $viewModel->setVariables(
            array(
                'form' => $form,
                'title' => 'Edit instant win',
            )
        );
    }

    public function listOccurrenceAction()
    {
        $this->checkGame();

        $adapter = new DoctrineAdapter(
            new LargeTablePaginator(
                $service->getInstantWinOccurrenceMapper()->queryByGame($this->game)

            )
        );
        $paginator = new Paginator($adapter);
        $paginator->setItemCountPerPage(25);
        $paginator->setCurrentPageNumber($this->getEvent()->getRouteMatch()->getParam('p'));

        return new ViewModel(
            array(
                'occurrences' => $paginator,
                'gameId'      => $this->game->getId(),
                'game'        => $this->game,
            )
        );
    }

    public function addOccurrenceAction()
    {
        $this->checkGame();

        $viewModel = new ViewModel();
        $viewModel->setTemplate('playground-game/instant-win/occurrence');

        $form = $this->getServiceLocator()->get('playgroundgame_instantwinoccurrence_form');
        $form->get('submit')->setAttribute('label', 'Add');

        $form->setAttribute(
            'action',
            $this->url()->fromRoute(
                'admin/playgroundgame/instantwin-occurrence-add',
                array('gameId' => $this->game->getId())
            )
        );
        $form->setAttribute('method', 'post');
        $form->get('instant_win_id')->setAttribute('value', $this->game->getId());
        $occurrence = new InstantWinOccurrence();
        $form->bind($occurrence);

        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 = array_merge(
                $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.
    }
}
                $this->getRequest()->getFiles()->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.
    }
}
            );

            // Change the format of the date
            $value = \DateTime::createFromFormat('d/m/Y H:i', $data['value']);
            $data['value'] = $value->format('Y-m-d H:i:s');
            
            $occurrence = $service->updateOccurrence($data, $occurrence->getId());

            if ($occurrence) {
                // Redirect to list of games
                $this->flashMessenger()->setNamespace('playgroundgame')->addMessage('The occurrence was created');
                return $this->redirect()->toRoute(
                    'admin/playgroundgame/instantwin-occurrence-list',
                    array('gameId'=>$this->game->getId())
                );
            }
        }
        return $viewModel->setVariables(
            array(
                'form' => $form,
                'game' => $this->game,
                'occurrence_id' => 0,
                'title' => 'Add occurrence',
            )
        );
    }

    public function importOccurrencesAction()
    {
        $this->checkGame();

        $viewModel = new ViewModel();
        $viewModel->setTemplate('playground-game/instant-win/import-occurrences');

        $form = $this->getServiceLocator()->get('playgroundgame_instantwinoccurrenceimport_form');

        $form->get('submit')->setAttribute('label', 'Import');
        $form->setAttribute(
            'action',
            $this->url()->fromRoute(
                'admin/playgroundgame/instantwin-occurrences-import',
                array('gameId' => $this->game->getId())
            )
        );
        $form->get('instant_win_id')->setAttribute('value', $this->game->getId());

        // File validator
        $inputFilter = new InputFilter\InputFilter();
        $fileFilter = new InputFilter\FileInput('file');
        $validatorChain = new Validator\ValidatorChain();
        $validatorChain->attach(new Validator\File\Exists());
        $validatorChain->attach(new Validator\File\Extension('csv'));
        $fileFilter->setValidatorChain($validatorChain);
        $fileFilter->setRequired(true);

        $prizeFilter = new InputFilter\Input('prize');
        $prizeFilter->setRequired(false);

        $inputFilter->add($fileFilter);
        $inputFilter->add($prizeFilter);
        $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 = array_merge_recursive(
                $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.
    }
}
                $this->getRequest()->getFiles()->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);
            if ($form->isValid()) {
                $data = $form->getData();
                $created = $this->getAdminGameService()->importOccurrences($data);
                if ($created) {
                    $this->flashMessenger()->setNamespace('playgroundgame')->addMessage(
                        $created.' occurrences were created !'
                    );
                    return $this->redirect()->toRoute(
                        'admin/playgroundgame/instantwin-occurrence-list',
                        array('gameId'=>$this->game->getId())
                    );
                }
            }
        }

        return $viewModel->setVariables(
            array(
                'form' => $form,
                'title' => 'Import occurrences',
            )
        );
    }

    public function editOccurrenceAction()
    {
        $this->checkGame();

        $viewModel = new ViewModel();
        $viewModel->setTemplate('playground-game/instant-win/occurrence');
        $service = $this->getAdminGameService();

        $occurrenceId = $this->getEvent()->getRouteMatch()->getParam('occurrenceId');
        $occurrence = $service->getInstantWinOccurrenceMapper()->findById($occurrenceId);
        // Si l'occurrence a été utilisée, on ne peut plus la modifier
        if ($occurrence->getUser()) {
            $this->flashMessenger()->setNamespace('playgroundgame')->addMessage(
                'This occurrence has a winner, you can not update it.'
            );
            return $this->redirect()->toRoute(
                'admin/playgroundgame/instantwin-occurrence-list',
                array('gameId'=>$this->game->getId())
            );
        }
        $form = $this->getServiceLocator()->get('playgroundgame_instantwinoccurrence_form');
        $form->remove('occurrences_file');

        $form->get('submit')->setAttribute('label', 'Edit');
        $form->setAttribute('action', '');

        $form->get('instant_win_id')->setAttribute('value', $this->game->getId());

        $form->bind($occurrence);

        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 = array_merge(
                $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.
    }
}
                $this->getRequest()->getFiles()->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.
    }
}
            );
            $occurrence = $service->updateOccurrence($data, $occurrence->getId());

            if ($occurrence) {
                // Redirect to list of games
                $this->flashMessenger()->setNamespace('playgroundgame')->addMessage('The occurrence was edited');
                return $this->redirect()->toRoute(
                    'admin/playgroundgame/instantwin-occurrence-list',
                    array('gameId'=>$this->game->getId())
                );
            }
        }
        return $viewModel->setVariables(
            array(
                'form' => $form,
                'game' => $this->game,
                'occurrence_id' => $occurrenceId,
                'title' => 'Edit occurrence',
            )
        );
    }


    public function removeOccurrenceAction()
    {
        $service = $this->getAdminGameService();
        $occurrenceId = $this->getEvent()->getRouteMatch()->getParam('occurrenceId');
        if (!$occurrenceId) {
            return $this->redirect()->toRoute('admin/playgroundgame/list');
        }
        $occurrence   = $service->getInstantWinOccurrenceMapper()->findById($occurrenceId);
        $instantwinId = $occurrence->getInstantWin()->getId();

        if ($occurrence->getActive()) {
            $service->getInstantWinOccurrenceMapper()->remove($occurrence);
            $this->flashMessenger()->setNamespace('playgroundgame')->addMessage('The occurrence was deleted');
        } else {
            $this->flashMessenger()->setNamespace('playgroundgame')->addMessage(
                'Il y a un participant à cet instant gagnant. Vous ne pouvez plus le supprimer'
            );
        }

        return $this->redirect()->toRoute(
            'admin/playgroundgame/instantwin-occurrence-list',
            array('gameId'=>$instantwinId)
        );
    }

    public function exportOccurrencesAction()
    {
        $this->checkGame();

        $file = $this->getAdminGameService()->setOccurencesToCSV($this->game);

        $response = new \Zend\Http\Response\Stream();
        $response->setStream(fopen($file, 'r'));
        $response->setStatusCode(200);

        $headers = new \Zend\Http\Headers();
        $headers->addHeaderLine('Content-Type', 'text/csv')
                ->addHeaderLine('Content-Disposition', 'attachment; filename="' . $file . '"')
                ->addHeaderLine('Content-Length', filesize($file));

        $response->setHeaders($headers);
        unlink($file);
        return $response;
    }

    public function getAdminGameService()
    {
        if (!$this->adminGameService) {
            $this->adminGameService = $this->getServiceLocator()->get('playgroundgame_instantwin_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->adminGameService;
    }

    public function setAdminGameService(\PlaygroundGame\Service\Game $adminGameService)
    {
        $this->adminGameService = $adminGameService;


        return $this;
    }
}


Push — develop ( 0bc71f...f6430f )

InstantWinController C

Complexity

Size/Duplication

Coupling/Cohesion

Importance

11 Methods

How to fix Duplicated Code

Duplicated Code

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

1			<?php
2
3			namespace PlaygroundGame\Controller\Admin;
4
5			use PlaygroundGame\Entity\InstantWin;
6			use PlaygroundGame\Entity\InstantWinOccurrence;
7			use Zend\InputFilter;
8			use Zend\Validator;
9			use PlaygroundGame\Controller\Admin\GameController;
10			use Zend\View\Model\ViewModel;
11			use Zend\Paginator\Paginator;
12			use PlaygroundCore\ORM\Pagination\LargeTablePaginator;
13			use DoctrineORMModule\Paginator\Adapter\DoctrinePaginator as DoctrineAdapter;
14
15			class InstantWinController extends GameController
16			{
17			/**
18			* @var GameService
19			*/
20			protected $adminGameService;
21
22			public function removeAction()
23			{
24			$this->checkGame();
25			$service->getGameMapper()->remove($this->game);
			0 ignored issues – show Bug introduced 2015-11-25 20:33 UTC by Report Bug Copy Issue Report The variable `$service` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history...
26			$this->flashMessenger()->setNamespace('playgroundgame')->addMessage('The game has been removed');
27
28			return $this->redirect()->toRoute('admin/playgroundgame/list');
29			}
30
31			public function createInstantWinAction()
32			{
33			$service = $this->getAdminGameService();
34			$viewModel = new ViewModel();
35			$viewModel->setTemplate('playground-game/instant-win/instantwin');
36
37			$gameForm = new ViewModel();
38			$gameForm->setTemplate('playground-game/game/game-form');
39

gregorybesson / PlaygroundGame

Push — develop ( 0bc71f...f6430f )

InstantWinController C

Complexity

Size/Duplication

Coupling/Cohesion

Importance

11 Methods

How to fix Duplicated Code

Duplicated Code

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like