TradingCardController::ajaxuploadAction() - Code Metrics - Inspection of "upload route for tradingcard" - gregorybesson/PlaygroundGame - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 034c89...77bab4 )

by greg

created 2016-02-21 17:39 UTC

TradingCardController::ajaxuploadAction() B

↳ Parent: TradingCardController

Complexity

Conditions	5
Paths	5

Size

Total Lines	49
Code Lines	28

Duplication

Lines	13
Ratio	26.53 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	13
loc	49
rs	8.5906
cc	5
eloc	28
nc	5
nop	0

<?php
namespace PlaygroundGame\Controller\Frontend;

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

    /**
     * Example of AJAX File Upload with Session Progress and partial validation.
     * It's now possible to send a base64 image in this case the call is the form :
     * this._ajax(
     * {
     *   url: url.dataset.url,
     *    method: 'post',
     *    body: 'photo=' + image
     * },
     *
     * @return \Zend\Stdlib\ResponseInterface
     */
    public function ajaxuploadAction()
    {
        // Call this for the session lock to be released (other ajax calls can then be made)
        session_write_close();

        if (! $this->game) {

            $this->getResponse()->setContent(\Zend\Json\Json::encode(array(
                'success' => 0
            )));

            return $this->getResponse();
        }

        $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->getResponse()->setContent(\Zend\Json\Json::encode(array(
                'success' => 0
            )));

            return $this->getResponse();
        }

        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()->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)) {

                $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.
    }
}
                $key = key($data);
                $uploadImage = array('name' => $key.'.png', 'error' => 0, 'base64' => $data[$key]);
                $data = array($key => $uploadImage);
            }
            $path = $this->getGameService()->getGameUserPath($this->game, $this->user);
            $media_url = '/'.$this->getGameService()->getGameUserMediaUrl($this->game, $this->user);
            $uploadFile = $this->getGameService()->uploadFile(
                $path,
                $data[$key]
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

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

    // $x is potentially undefined here.
    echo $x;
}
            );
            $result = $media_url.$uploadFile;
        }

        $this->getResponse()->setContent(\Zend\Json\Json::encode(array(
            'success' => true,
            'fileUrl' => $result
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

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

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

        return $this->getResponse();
    }

    public function playAction()
    {
        $entry = $this->getGameService()->play($this->game, $this->user);
        $viewModel = $this->buildView($this->game);
        $booster = null;
        if ($entry) {
            $booster = $this->getGameService()->getBooster($this->game, $this->user, $entry);
        }
        
        $album = $this->getGameService()->getAlbum($this->game, $this->user);
        $viewModel->setVariables(array('booster' => $booster, 'album' => $album));
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.
}

        return $viewModel;
    }

    public function resultAction()
    {
        $album = $this->getGameService()->getAlbum($this->game, $this->user);
        $viewModel = $this->buildView($this->game);
        $viewModel->setVariables(array('album' => $album));
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.
}

        return $viewModel;
    }

    public function getGameService()
    {
        if (!$this->gameService) {
            $this->gameService = $this->getServiceLocator()->get('playgroundgame_tradingcard_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;
    }
}


1		<?php
2		namespace PlaygroundGame\Controller\Frontend;
3
4		class TradingCardController extends GameController
5		{
6		/**
7		* @var gameService
8		*/
9		protected $gameService;
10
11		/**
12		* Example of AJAX File Upload with Session Progress and partial validation.
13		* It's now possible to send a base64 image in this case the call is the form :
14		* this._ajax(
15		* {
16		* url: url.dataset.url,
17		* method: 'post',
18		* body: 'photo=' + image
19		* },
20		*
21		* @return \Zend\Stdlib\ResponseInterface
22		*/
23		public function ajaxuploadAction()
24		{
25		// Call this for the session lock to be released (other ajax calls can then be made)
26		session_write_close();
27
28	View Code Duplication	if (! $this->game) {
		0 ignored issues – show Duplication introduced 2016-02-21 17:43 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
29		$this->getResponse()->setContent(\Zend\Json\Json::encode(array(
30		'success' => 0
31		)));
32
33		return $this->getResponse();
34		}
35
36		$entry = $this->getGameService()->play($this->game, $this->user);
37		if (!$entry) {
38		// the user has already taken part of this game and the participation limit has been reached
39		$this->getResponse()->setContent(\Zend\Json\Json::encode(array(
40		'success' => 0
41		)));
42
43		return $this->getResponse();
44		}
45
46		if ($this->getRequest()->isPost()) {
		0 ignored issues – show Bug introduced 2016-02-21 17:43 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 `isPost()` 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...
47
48		$data = $this->getRequest()->getFiles()->toArray();
		0 ignored issues – show Bug introduced 2016-02-21 17:43 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...
49
50	View Code Duplication	if (empty($data)) {
		0 ignored issues – show Duplication introduced 2016-02-21 17:43 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
51		$data = $this->getRequest()->getPost()->toArray();
		0 ignored issues – show Bug introduced 2016-02-21 17:43 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...
52		$key = key($data);
53		$uploadImage = array('name' => $key.'.png', 'error' => 0, 'base64' => $data[$key]);
54		$data = array($key => $uploadImage);
55		}
56		$path = $this->getGameService()->getGameUserPath($this->game, $this->user);
57		$media_url = '/'.$this->getGameService()->getGameUserMediaUrl($this->game, $this->user);
58		$uploadFile = $this->getGameService()->uploadFile(
59		$path,
60		$data[$key]
		0 ignored issues – show Bug introduced 2016-02-21 17:43 UTC by Report Bug Copy Issue Report The variable `$key` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
61		);
62		$result = $media_url.$uploadFile;
63		}
64
65		$this->getResponse()->setContent(\Zend\Json\Json::encode(array(
66		'success' => true,
67		'fileUrl' => $result
		0 ignored issues – show Bug introduced 2016-02-21 17:43 UTC by Report Bug Copy Issue Report The variable `$result` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
68		)));
69
70		return $this->getResponse();
71		}
72
73		public function playAction()
74		{
75		$entry = $this->getGameService()->play($this->game, $this->user);
76		$viewModel = $this->buildView($this->game);
77		$booster = null;
78		if ($entry) {
79		$booster = $this->getGameService()->getBooster($this->game, $this->user, $entry);
80		}
81
82		$album = $this->getGameService()->getAlbum($this->game, $this->user);
83		$viewModel->setVariables(array('booster' => $booster, 'album' => $album));
		0 ignored issues – show Bug introduced 2016-02-09 23:46 UTC by Report Bug Copy Issue Report The method `setVariables` does only exist in `Zend\View\Model\ViewModel`, but not in `Zend\Http\PhpEnvironment\Response`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: 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. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
84
85		return $viewModel;
86		}
87
88		public function resultAction()
89		{
90		$album = $this->getGameService()->getAlbum($this->game, $this->user);
91		$viewModel = $this->buildView($this->game);
92		$viewModel->setVariables(array('album' => $album));
		0 ignored issues – show Bug introduced 2016-02-09 23:46 UTC by Report Bug Copy Issue Report The method `setVariables` does only exist in `Zend\View\Model\ViewModel`, but not in `Zend\Http\PhpEnvironment\Response`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: 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. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
93
94		return $viewModel;
95		}
96
97		public function getGameService()
98		{
99		if (!$this->gameService) {
100		$this->gameService = $this->getServiceLocator()->get('playgroundgame_tradingcard_service');
		0 ignored issues – show Documentation Bug introduced 2016-02-09 23:46 UTC by Report Bug Copy Issue Report It seems like `$this->getServiceLocator...e_tradingcard_service')` can also be of type `array`. However, the property `$gameService` is declared as type `object<PlaygroundGame\Co...r\Frontend\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...
101		}
102
103		return $this->gameService;
104		}
105		}
106

gregorybesson / PlaygroundGame

Push — develop ( 034c89...77bab4 )

TradingCardController::ajaxuploadAction() B

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like