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

Completed

Push — develop ( 89108e...7bb4ed )

by greg

created 2015-11-25 21:29 UTC

GameController B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	364
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	14

Importance

Changes	13
Bugs	4	Features	0

Metric	Value
wmc	37
c	13
b	4
f	0
lcom	1
cbo	14
dl	0
loc	364
rs	8.6

16 Methods

Rating	Name	Size	Complexity
A	checkGame()	13	3
B	createForm()	30	4
C	editGame()	65	8
A	listAction()	21	2
B	entryAction()	24	1
B	downloadAction()	27	1
B	drawAction()	33	2
A	exportAction()	20	1
B	importAction()	34	5
A	removeAction()	15	2
A	setActiveAction()	9	1
A	formAction()	8	1
A	setOptions()	6	1
A	getOptions()	8	2
A	getAdminGameService()	8	2
A	setAdminGameService()	6	1

<?php

namespace PlaygroundGame\Controller\Admin;

use PlaygroundGame\Service\Game as AdminGameService;
use Zend\Mvc\Controller\AbstractActionController;
use Zend\View\Model\ViewModel;
use PlaygroundGame\Options\ModuleOptions;
use Zend\Paginator\Paginator;
use DoctrineORMModule\Paginator\Adapter\DoctrinePaginator as DoctrineAdapter;
use PlaygroundCore\ORM\Pagination\LargeTablePaginator;
use Doctrine\ORM\Tools\Pagination\Paginator as ORMPaginator;
use Zend\Stdlib\ErrorHandler;

class GameController extends AbstractActionController
{
    protected $options;

    /**
     * @var \PlaygroundGame\Service\Game
     */
    protected $adminGameService;

    protected $game;

    public function checkGame()
    {
        $gameId = $this->getEvent()->getRouteMatch()->getParam('gameId');
        if (!$gameId) {
            return $this->redirect()->toRoute('admin/playgroundgame/list');
        }
        $service = $this->getAdminGameService();
        $game = $service->getGameMapper()->findById($gameId);
        if (!$game) {
            return $this->redirect()->toRoute('admin/playgroundgame/list');
        }
        $this->game = $game;
    }

    public function createForm($form)
    {
        // I use the wonderful Form Generator to create the Post & Vote form
        $this->forward()->dispatch(
            'PlaygroundCore\Controller\Formgen',
            array(
                'controller' => 'PlaygroundCore\Controller\Formgen',
                'action' => 'create'
            )
        );

        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 = $service->createForm($data, $game, $form);

            if ($form) {
                $this->flashMessenger()->setNamespace('playgroundgame')->addMessage('The form was created');
            }
        }
        $formTemplate='';
        if ($form) {
            $formTemplate = $form->getFormTemplate();
        }

        return array(
            'form' => $form,
            'formTemplate' => $formTemplate,
            'gameId' => $this->game->getId(),
            'game' => $this->game,
        );
    }

    public function editGame($templatePath, $formId)
    {

        $viewModel = new ViewModel();
        $viewModel->setTemplate($templatePath);

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

        $form   = $this->getServiceLocator()->get($formId);
        $form->setAttribute(
            'action',
            $this->url()->fromRoute(
                'admin/playgroundgame/edit-' . $this->game->getClassType(),
                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();
            }
            if (isset($data['drawDate']) && $data['drawDate']) {
                $data['drawDate'] = \DateTime::createFromFormat('d/m/Y', $data['drawDate']);
            }
            $result = $this->getAdminGameService()->edit($data, $this->game, $formId);

            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 this game',
            )
        );
    
    }

    public function listAction()
    {
        $filter    = $this->getEvent()->getRouteMatch()->getParam('filter');
        $type    = $this->getEvent()->getRouteMatch()->getParam('type');

        $service    = $this->getAdminGameService();
        $adapter = new DoctrineAdapter(new ORMPaginator($service->getQueryGamesOrderBy($type, $filter)));
        $paginator = new Paginator($adapter);
        $paginator->setItemCountPerPage(25);
        $paginator->setCurrentPageNumber($this->getEvent()->getRouteMatch()->getParam('p'));

        foreach ($paginator as $game) {
            $game->entry = $service->getEntryMapper()->countByGame($game);
        }

        return array(
            'games'    => $paginator,
            'type'        => $type,
            'filter'    => $filter,
        );
    }

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

        $adapter = new DoctrineAdapter(
            new LargeTablePaginator(
                $this->getAdminGameService()->getEntriesQuery($this->game)
            )
        );
        $paginator = new Paginator($adapter);
        $paginator->setItemCountPerPage(10);
        $paginator->setCurrentPageNumber($this->getEvent()->getRouteMatch()->getParam('p'));

        $header = $this->getAdminGameService()->getEntriesHeader($this->game);
        $entries = $this->getAdminGameService()->getGameEntries($header, $paginator, $this->game);

        return array(
            'paginator' => $paginator,
            'entries' => $entries,
            'header' => $header,
            'game' => $this->game,
            'gameId' => $this->game->getId()
        );
    }

    public function downloadAction()
    {
        $this->checkGame();
        $header = $this->getAdminGameService()->getEntriesHeader($this->game);
        $query = $this->getAdminGameService()->getEntriesQuery($this->game);

        $content = "\xEF\xBB\xBF"; // UTF-8 BOM
        $content .= $this->getAdminGameService()->getCSV(
            $this->getAdminGameService()->getGameEntries(
                $header,
                $query->getResult(),
                $this->game
            )
        );

        $response = $this->getResponse();
        $headers = $response->getHeaders();
        $headers->addHeaderLine('Content-Encoding: UTF-8');
        $headers->addHeaderLine('Content-Type', 'text/csv; charset=UTF-8');
        $headers->addHeaderLine('Content-Disposition', "attachment; filename=\"entry.csv\"");
        $headers->addHeaderLine('Accept-Ranges', 'bytes');
        $headers->addHeaderLine('Content-Length', strlen($content));

        $response->setContent($content);

        return $response;
    }

    // Only used for Quiz and Lottery
    public function drawAction()
    {
        $this->checkGame();

        $winningEntries = $this->getAdminGameService()->draw($this->game);

        $content = "\xEF\xBB\xBF"; // UTF-8 BOM
        $content .= "ID;Pseudo;Nom;Prenom;E-mail;Etat\n";

        foreach ($winningEntries as $e) {
            $etat = 'gagnant';

            $content   .= $e->getUser()->getId()
            . ";" . $e->getUser()->getUsername()
            . ";" . $e->getUser()->getLastname()
            . ";" . $e->getUser()->getFirstname()
            . ";" . $e->getUser()->getEmail()
            . ";" . $etat
            ."\n";
        }

        $response = $this->getResponse();
        $headers = $response->getHeaders();
        $headers->addHeaderLine('Content-Encoding: UTF-8');
        $headers->addHeaderLine('Content-Type', 'text/csv; charset=UTF-8');
        $headers->addHeaderLine('Content-Disposition', "attachment; filename=\"gagnants.csv\"");
        $headers->addHeaderLine('Accept-Ranges', 'bytes');
        $headers->addHeaderLine('Content-Length', strlen($content));

        $response->setContent($content);

        return $response;
    }
    
    /**
     * This method serialize a game an export it as a txt file
     * @return \Zend\Stdlib\ResponseInterface
     */
    public function exportAction()
    {
        $this->checkGame();
        $content = serialize($this->game);

        $response = $this->getResponse();
        $headers = $response->getHeaders();
        $headers->addHeaderLine('Content-Encoding: UTF-8');
        $headers->addHeaderLine('Content-Type', 'text/plain; charset=UTF-8');
        $headers->addHeaderLine(
            'Content-Disposition',
            "attachment; filename=\"". $this->game->getIdentifier() .".txt\""
        );
        $headers->addHeaderLine('Accept-Ranges', 'bytes');
        $headers->addHeaderLine('Content-Length', strlen($content));
    
        $response->setContent($content);
    
        return $response;
    }
    
    /**
     * This method take an uploaded txt file containing a serialized game
     * and persist it in the database
     * @return unknown
     */
    public function importAction()
    {
        $form = $this->getServiceLocator()->get('playgroundgame_import_form');
        $form->setAttribute('action', $this->url()->fromRoute('admin/playgroundgame/import'));
        $form->setAttribute('method', 'post');
        
        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['import_file']['tmp_name'])) {
                ErrorHandler::start();
                $game = unserialize(file_get_contents($data['import_file']['tmp_name']));
                $game->setId(null);
                if ($data['slug']) {
                    $game->setIdentifier($data['slug']);
                }
                $duplicate = $this->getAdminGameService()->getGameMapper()->findByIdentifier($game->getIdentifier());
                if (!$duplicate) {
                    $this->getAdminGameService()->getGameMapper()->insert($game);
                }

                ErrorHandler::stop(true);
            }
            
            return $this->redirect()->toRoute('admin/playgroundgame/list');
        }
        
        return array(
            'form' => $form,
        );
    }

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

        try {
            $this->getAdminGameService()->getGameMapper()->remove($this->game);
            $this->flashMessenger()->setNamespace('playgroundgame')->addMessage('The game has been edited');
        } catch (\Doctrine\DBAL\DBALException $e) {
            $this->flashMessenger()->setNamespace('playgroundgame')->addMessage(
                'Il y a déjà eu des participants à ce jeu. Vous ne pouvez plus le supprimer'
            );
        }

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

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

        $this->game->setActive(!$this->game->getActive());
        $this->getAdminGameService()->getGameMapper()->update($game);


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

    public function formAction()
    {
        $this->checkGame();
        
        $form = $this->game->getPlayerForm();

        return $this->createForm($form);
    }

    public function setOptions(ModuleOptions $options)
    {
        $this->options = $options;

        return $this;
    }

    public function getOptions()
    {
        if (!$this->options instanceof ModuleOptions) {
            $this->setOptions($this->getServiceLocator()->get('playgroundgame_module_options'));
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

        return $this->options;
    }

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

        return $this;
    }
}


Push — develop ( 89108e...7bb4ed )

GameController B

Complexity

Size/Duplication

Coupling/Cohesion

Importance

16 Methods

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

gregorybesson / PlaygroundGame

Push — develop ( 89108e...7bb4ed )

GameController B

Complexity

Size/Duplication

Coupling/Cohesion

Importance

16 Methods

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like