LotteryController::createLotteryAction() - 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

LotteryController::createLotteryAction() B

↳ Parent: LotteryController

Complexity

Conditions	6
Paths	9

Size

Total Lines	47
Code Lines	32

Duplication

Lines	0
Ratio	0 %

Importance

Changes	3
Bugs	0	Features	0

Metric	Value
c	3
b	0
f	0
dl	0
loc	47
rs	8.5126
cc	6
eloc	32
nc	9
nop	0

<?php

namespace PlaygroundGame\Controller\Admin;

use PlaygroundGame\Service\Game as AdminGameService;
use PlaygroundGame\Entity\Lottery;
use PlaygroundGame\Controller\Admin\GameController;
use Zend\View\Model\ViewModel;

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

    public function createLotteryAction()
    {
        $service = $this->getAdminGameService();
        $viewModel = new ViewModel();
        $viewModel->setTemplate('playground-game/lottery/lottery');

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

        $lottery = new Lottery();

        $form = $this->getServiceLocator()->get('playgroundgame_lottery_form');
        $form->bind($lottery);
        $form->get('submit')->setAttribute('label', 'Add');
        $form->setAttribute(
            'action',
            $this->url()->fromRoute(
                'admin/playgroundgame/create-lottery',
                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();
            }
            if (isset($data['drawDate']) && $data['drawDate']) {
                $data['drawDate'] = \DateTime::createFromFormat('d/m/Y', $data['drawDate']);
            }
            $game = $service->create($data, $lottery, 'playgroundgame_lottery_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' => $lottery));
        $viewModel->addChild($gameForm, 'game_form');

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

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

        return $this->editGame(
            'playground-game/lottery/lottery',
            'playgroundgame_lottery_form'
        );
    }

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

LotteryController::createLotteryAction() B

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

1			<?php
2
3			namespace PlaygroundGame\Controller\Admin;
4
5			use PlaygroundGame\Service\Game as AdminGameService;
6			use PlaygroundGame\Entity\Lottery;
7			use PlaygroundGame\Controller\Admin\GameController;
8			use Zend\View\Model\ViewModel;
9
10			class LotteryController extends GameController
11			{
12			/**
13			* @var GameService
14			*/
15			protected $adminGameService;
16
17			public function createLotteryAction()
18			{
19			$service = $this->getAdminGameService();
20			$viewModel = new ViewModel();
21			$viewModel->setTemplate('playground-game/lottery/lottery');
22
23			$gameForm = new ViewModel();
24			$gameForm->setTemplate('playground-game/game/game-form');
25
26			$lottery = new Lottery();
27
28			$form = $this->getServiceLocator()->get('playgroundgame_lottery_form');
29			$form->bind($lottery);
30			$form->get('submit')->setAttribute('label', 'Add');
31			$form->setAttribute(
32			'action',
33			$this->url()->fromRoute(
34			'admin/playgroundgame/create-lottery',
35			array('gameId' => 0)
36			)
37			);
38			$form->setAttribute('method', 'post');
39
40			$request = $this->getRequest();
41			if ($request->isPost()) {
42			$data = array_replace_recursive(
43			$this->getRequest()->getPost()->toArray(),
			0 ignored issues – show Bug introduced 2015-11-21 00:28 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Zend\Stdlib\RequestInterface` as the method `getPost()` does only exist in the following implementations of said interface: `Zend\Http\PhpEnvironment\Request`, `Zend\Http\Request`. Let’s take a look at an example: 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. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
44			$this->getRequest()->getFiles()->toArray()
			0 ignored issues – show Bug introduced 2015-11-21 00:28 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Zend\Stdlib\RequestInterface` as the method `getFiles()` does only exist in the following implementations of said interface: `Zend\Http\PhpEnvironment\Request`, `Zend\Http\Request`. Let’s take a look at an example: 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. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
45			);
46			if (empty($data['prizes'])) {
47			$data['prizes'] = array();
48			}
49			if (isset($data['drawDate']) && $data['drawDate']) {
50			$data['drawDate'] = \DateTime::createFromFormat('d/m/Y', $data['drawDate']);
51			}
52			$game = $service->create($data, $lottery, 'playgroundgame_lottery_form');
53			if ($game) {
54			$this->flashMessenger()->setNamespace('playgroundgame')->addMessage('The game was created');
55
56			return $this->redirect()->toRoute('admin/playgroundgame/list');
57			}
58			}
59			$gameForm->setVariables(array('form' => $form, 'game' => $lottery));
60			$viewModel->addChild($gameForm, 'game_form');
61
62			return $viewModel->setVariables(array('form' => $form, 'title' => 'Create lottery'));
63			}
64
65			public function editLotteryAction()
66			{
67			$this->checkGame();
68
69			return $this->editGame(
70			'playground-game/lottery/lottery',
71			'playgroundgame_lottery_form'
72			);
73			}
74
75			public function getAdminGameService()
76			{
77			if (!$this->adminGameService) {
78			$this->adminGameService = $this->getServiceLocator()->get('playgroundgame_lottery_service');
			0 ignored issues – show Documentation Bug introduced 2015-11-21 00:28 UTC by Report Bug Copy Issue Report It seems like `$this->getServiceLocator...dgame_lottery_service')` can also be of type `array`. However, the property `$adminGameService` is declared as type `object<PlaygroundGame\Co...ller\Admin\GameService>`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. 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; } Loading history...
79			}
80
81			return $this->adminGameService;
82			}
83
84			public function setAdminGameService(AdminGameService $adminGameService)
85			{
86			$this->adminGameService = $adminGameService;
			0 ignored issues – show Documentation Bug introduced 2015-11-21 00:28 UTC by Report Bug Copy Issue Report It seems like `$adminGameService` of type `object<PlaygroundGame\Service\Game>` is incompatible with the declared type `object<PlaygroundGame\Co...ller\Admin\GameService>` of property `$adminGameService`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
87
88			return $this;
89			}
90			}
91

gregorybesson / PlaygroundGame

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

LotteryController::createLotteryAction() B

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like